Class Invoice
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.ads.googleads.v10.resources.Invoice
-
- All Implemented Interfaces:
InvoiceOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,java.io.Serializable
public final class Invoice extends com.google.protobuf.GeneratedMessageV3 implements InvoiceOrBuilder
An invoice. All invoice information is snapshotted to match the PDF invoice. For invoices older than the launch of InvoiceService, the snapshotted information may not match the PDF invoice.
Protobuf typegoogle.ads.googleads.v10.resources.Invoice- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classInvoice.AccountBudgetSummaryRepresents a summarized account budget billable cost.static interfaceInvoice.AccountBudgetSummaryOrBuilderstatic classInvoice.BuilderAn invoice.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)Invoice.AccountBudgetSummarygetAccountBudgetSummaries(int index)Output only.intgetAccountBudgetSummariesCount()Output only.java.util.List<Invoice.AccountBudgetSummary>getAccountBudgetSummariesList()Output only.Invoice.AccountBudgetSummaryOrBuildergetAccountBudgetSummariesOrBuilder(int index)Output only.java.util.List<? extends Invoice.AccountBudgetSummaryOrBuilder>getAccountBudgetSummariesOrBuilderList()Output only.longgetAdjustmentsSubtotalAmountMicros()Output only.longgetAdjustmentsTaxAmountMicros()Output only.longgetAdjustmentsTotalAmountMicros()Output only.java.lang.StringgetBillingSetup()Output only.com.google.protobuf.ByteStringgetBillingSetupBytes()Output only.java.lang.StringgetCorrectedInvoice()Output only.com.google.protobuf.ByteStringgetCorrectedInvoiceBytes()Output only.java.lang.StringgetCurrencyCode()Output only.com.google.protobuf.ByteStringgetCurrencyCodeBytes()Output only.static InvoicegetDefaultInstance()InvoicegetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()java.lang.StringgetDueDate()Output only.com.google.protobuf.ByteStringgetDueDateBytes()Output only.java.lang.StringgetId()Output only.com.google.protobuf.ByteStringgetIdBytes()Output only.java.lang.StringgetIssueDate()Output only.com.google.protobuf.ByteStringgetIssueDateBytes()Output only.com.google.protobuf.Parser<Invoice>getParserForType()java.lang.StringgetPaymentsAccountId()Output only.com.google.protobuf.ByteStringgetPaymentsAccountIdBytes()Output only.java.lang.StringgetPaymentsProfileId()Output only.com.google.protobuf.ByteStringgetPaymentsProfileIdBytes()Output only.java.lang.StringgetPdfUrl()Output only.com.google.protobuf.ByteStringgetPdfUrlBytes()Output only.longgetRegulatoryCostsSubtotalAmountMicros()Output only.longgetRegulatoryCostsTaxAmountMicros()Output only.longgetRegulatoryCostsTotalAmountMicros()Output only.java.lang.StringgetReplacedInvoices(int index)Output only.com.google.protobuf.ByteStringgetReplacedInvoicesBytes(int index)Output only.intgetReplacedInvoicesCount()Output only.com.google.protobuf.ProtocolStringListgetReplacedInvoicesList()Output only.java.lang.StringgetResourceName()Output only.com.google.protobuf.ByteStringgetResourceNameBytes()Output only.intgetSerializedSize()DateRangegetServiceDateRange()Output only.DateRangeOrBuildergetServiceDateRangeOrBuilder()Output only.longgetSubtotalAmountMicros()Output only.longgetTaxAmountMicros()Output only.longgetTotalAmountMicros()Output only.InvoiceTypeEnum.InvoiceTypegetType()Output only.intgetTypeValue()Output only.com.google.protobuf.UnknownFieldSetgetUnknownFields()booleanhasBillingSetup()Output only.booleanhasCorrectedInvoice()Output only.booleanhasCurrencyCode()Output only.booleanhasDueDate()Output only.inthashCode()booleanhasId()Output only.booleanhasIssueDate()Output only.booleanhasPaymentsAccountId()Output only.booleanhasPaymentsProfileId()Output only.booleanhasPdfUrl()Output only.booleanhasServiceDateRange()Output only.booleanhasSubtotalAmountMicros()Output only.booleanhasTaxAmountMicros()Output only.booleanhasTotalAmountMicros()Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static Invoice.BuildernewBuilder()static Invoice.BuildernewBuilder(Invoice prototype)Invoice.BuildernewBuilderForType()protected Invoice.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected java.lang.ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static InvoiceparseDelimitedFrom(java.io.InputStream input)static InvoiceparseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static InvoiceparseFrom(byte[] data)static InvoiceparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static InvoiceparseFrom(com.google.protobuf.ByteString data)static InvoiceparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static InvoiceparseFrom(com.google.protobuf.CodedInputStream input)static InvoiceparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static InvoiceparseFrom(java.io.InputStream input)static InvoiceparseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static InvoiceparseFrom(java.nio.ByteBuffer data)static InvoiceparseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<Invoice>parser()Invoice.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
RESOURCE_NAME_FIELD_NUMBER
public static final int RESOURCE_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BILLING_SETUP_FIELD_NUMBER
public static final int BILLING_SETUP_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PAYMENTS_ACCOUNT_ID_FIELD_NUMBER
public static final int PAYMENTS_ACCOUNT_ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PAYMENTS_PROFILE_ID_FIELD_NUMBER
public static final int PAYMENTS_PROFILE_ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ISSUE_DATE_FIELD_NUMBER
public static final int ISSUE_DATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DUE_DATE_FIELD_NUMBER
public static final int DUE_DATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SERVICE_DATE_RANGE_FIELD_NUMBER
public static final int SERVICE_DATE_RANGE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CURRENCY_CODE_FIELD_NUMBER
public static final int CURRENCY_CODE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ADJUSTMENTS_SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER
public static final int ADJUSTMENTS_SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ADJUSTMENTS_TAX_AMOUNT_MICROS_FIELD_NUMBER
public static final int ADJUSTMENTS_TAX_AMOUNT_MICROS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ADJUSTMENTS_TOTAL_AMOUNT_MICROS_FIELD_NUMBER
public static final int ADJUSTMENTS_TOTAL_AMOUNT_MICROS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
REGULATORY_COSTS_SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER
public static final int REGULATORY_COSTS_SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
REGULATORY_COSTS_TAX_AMOUNT_MICROS_FIELD_NUMBER
public static final int REGULATORY_COSTS_TAX_AMOUNT_MICROS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
REGULATORY_COSTS_TOTAL_AMOUNT_MICROS_FIELD_NUMBER
public static final int REGULATORY_COSTS_TOTAL_AMOUNT_MICROS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER
public static final int SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TAX_AMOUNT_MICROS_FIELD_NUMBER
public static final int TAX_AMOUNT_MICROS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TOTAL_AMOUNT_MICROS_FIELD_NUMBER
public static final int TOTAL_AMOUNT_MICROS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CORRECTED_INVOICE_FIELD_NUMBER
public static final int CORRECTED_INVOICE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
REPLACED_INVOICES_FIELD_NUMBER
public static final int REPLACED_INVOICES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PDF_URL_FIELD_NUMBER
public static final int PDF_URL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ACCOUNT_BUDGET_SUMMARIES_FIELD_NUMBER
public static final int ACCOUNT_BUDGET_SUMMARIES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getResourceName
public java.lang.String getResourceName()
Output only. The resource name of the invoice. Multiple customers can share a given invoice, so multiple resource names may point to the same invoice. Invoice resource names have the form: `customers/{customer_id}/invoices/{invoice_id}`string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getResourceNamein interfaceInvoiceOrBuilder- Returns:
- The resourceName.
-
getResourceNameBytes
public com.google.protobuf.ByteString getResourceNameBytes()
Output only. The resource name of the invoice. Multiple customers can share a given invoice, so multiple resource names may point to the same invoice. Invoice resource names have the form: `customers/{customer_id}/invoices/{invoice_id}`string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getResourceNameBytesin interfaceInvoiceOrBuilder- Returns:
- The bytes for resourceName.
-
hasId
public boolean hasId()
Output only. The ID of the invoice. It appears on the invoice PDF as "Invoice number".
optional string id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasIdin interfaceInvoiceOrBuilder- Returns:
- Whether the id field is set.
-
getId
public java.lang.String getId()
Output only. The ID of the invoice. It appears on the invoice PDF as "Invoice number".
optional string id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getIdin interfaceInvoiceOrBuilder- Returns:
- The id.
-
getIdBytes
public com.google.protobuf.ByteString getIdBytes()
Output only. The ID of the invoice. It appears on the invoice PDF as "Invoice number".
optional string id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getIdBytesin interfaceInvoiceOrBuilder- Returns:
- The bytes for id.
-
getTypeValue
public int getTypeValue()
Output only. The type of invoice.
.google.ads.googleads.v10.enums.InvoiceTypeEnum.InvoiceType type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTypeValuein interfaceInvoiceOrBuilder- Returns:
- The enum numeric value on the wire for type.
-
getType
public InvoiceTypeEnum.InvoiceType getType()
Output only. The type of invoice.
.google.ads.googleads.v10.enums.InvoiceTypeEnum.InvoiceType type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTypein interfaceInvoiceOrBuilder- Returns:
- The type.
-
hasBillingSetup
public boolean hasBillingSetup()
Output only. The resource name of this invoice's billing setup. `customers/{customer_id}/billingSetups/{billing_setup_id}`optional string billing_setup = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasBillingSetupin interfaceInvoiceOrBuilder- Returns:
- Whether the billingSetup field is set.
-
getBillingSetup
public java.lang.String getBillingSetup()
Output only. The resource name of this invoice's billing setup. `customers/{customer_id}/billingSetups/{billing_setup_id}`optional string billing_setup = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getBillingSetupin interfaceInvoiceOrBuilder- Returns:
- The billingSetup.
-
getBillingSetupBytes
public com.google.protobuf.ByteString getBillingSetupBytes()
Output only. The resource name of this invoice's billing setup. `customers/{customer_id}/billingSetups/{billing_setup_id}`optional string billing_setup = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getBillingSetupBytesin interfaceInvoiceOrBuilder- Returns:
- The bytes for billingSetup.
-
hasPaymentsAccountId
public boolean hasPaymentsAccountId()
Output only. A 16 digit ID used to identify the payments account associated with the billing setup, e.g. "1234-5678-9012-3456". It appears on the invoice PDF as "Billing Account Number".
optional string payments_account_id = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasPaymentsAccountIdin interfaceInvoiceOrBuilder- Returns:
- Whether the paymentsAccountId field is set.
-
getPaymentsAccountId
public java.lang.String getPaymentsAccountId()
Output only. A 16 digit ID used to identify the payments account associated with the billing setup, e.g. "1234-5678-9012-3456". It appears on the invoice PDF as "Billing Account Number".
optional string payments_account_id = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPaymentsAccountIdin interfaceInvoiceOrBuilder- Returns:
- The paymentsAccountId.
-
getPaymentsAccountIdBytes
public com.google.protobuf.ByteString getPaymentsAccountIdBytes()
Output only. A 16 digit ID used to identify the payments account associated with the billing setup, e.g. "1234-5678-9012-3456". It appears on the invoice PDF as "Billing Account Number".
optional string payments_account_id = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPaymentsAccountIdBytesin interfaceInvoiceOrBuilder- Returns:
- The bytes for paymentsAccountId.
-
hasPaymentsProfileId
public boolean hasPaymentsProfileId()
Output only. A 12 digit ID used to identify the payments profile associated with the billing setup, e.g. "1234-5678-9012". It appears on the invoice PDF as "Billing ID".
optional string payments_profile_id = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasPaymentsProfileIdin interfaceInvoiceOrBuilder- Returns:
- Whether the paymentsProfileId field is set.
-
getPaymentsProfileId
public java.lang.String getPaymentsProfileId()
Output only. A 12 digit ID used to identify the payments profile associated with the billing setup, e.g. "1234-5678-9012". It appears on the invoice PDF as "Billing ID".
optional string payments_profile_id = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPaymentsProfileIdin interfaceInvoiceOrBuilder- Returns:
- The paymentsProfileId.
-
getPaymentsProfileIdBytes
public com.google.protobuf.ByteString getPaymentsProfileIdBytes()
Output only. A 12 digit ID used to identify the payments profile associated with the billing setup, e.g. "1234-5678-9012". It appears on the invoice PDF as "Billing ID".
optional string payments_profile_id = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPaymentsProfileIdBytesin interfaceInvoiceOrBuilder- Returns:
- The bytes for paymentsProfileId.
-
hasIssueDate
public boolean hasIssueDate()
Output only. The issue date in yyyy-mm-dd format. It appears on the invoice PDF as either "Issue date" or "Invoice date".
optional string issue_date = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasIssueDatein interfaceInvoiceOrBuilder- Returns:
- Whether the issueDate field is set.
-
getIssueDate
public java.lang.String getIssueDate()
Output only. The issue date in yyyy-mm-dd format. It appears on the invoice PDF as either "Issue date" or "Invoice date".
optional string issue_date = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getIssueDatein interfaceInvoiceOrBuilder- Returns:
- The issueDate.
-
getIssueDateBytes
public com.google.protobuf.ByteString getIssueDateBytes()
Output only. The issue date in yyyy-mm-dd format. It appears on the invoice PDF as either "Issue date" or "Invoice date".
optional string issue_date = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getIssueDateBytesin interfaceInvoiceOrBuilder- Returns:
- The bytes for issueDate.
-
hasDueDate
public boolean hasDueDate()
Output only. The due date in yyyy-mm-dd format.
optional string due_date = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasDueDatein interfaceInvoiceOrBuilder- Returns:
- Whether the dueDate field is set.
-
getDueDate
public java.lang.String getDueDate()
Output only. The due date in yyyy-mm-dd format.
optional string due_date = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDueDatein interfaceInvoiceOrBuilder- Returns:
- The dueDate.
-
getDueDateBytes
public com.google.protobuf.ByteString getDueDateBytes()
Output only. The due date in yyyy-mm-dd format.
optional string due_date = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDueDateBytesin interfaceInvoiceOrBuilder- Returns:
- The bytes for dueDate.
-
hasServiceDateRange
public boolean hasServiceDateRange()
Output only. The service period date range of this invoice. The end date is inclusive.
.google.ads.googleads.v10.common.DateRange service_date_range = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasServiceDateRangein interfaceInvoiceOrBuilder- Returns:
- Whether the serviceDateRange field is set.
-
getServiceDateRange
public DateRange getServiceDateRange()
Output only. The service period date range of this invoice. The end date is inclusive.
.google.ads.googleads.v10.common.DateRange service_date_range = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getServiceDateRangein interfaceInvoiceOrBuilder- Returns:
- The serviceDateRange.
-
getServiceDateRangeOrBuilder
public DateRangeOrBuilder getServiceDateRangeOrBuilder()
Output only. The service period date range of this invoice. The end date is inclusive.
.google.ads.googleads.v10.common.DateRange service_date_range = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getServiceDateRangeOrBuilderin interfaceInvoiceOrBuilder
-
hasCurrencyCode
public boolean hasCurrencyCode()
Output only. The currency code. All costs are returned in this currency. A subset of the currency codes derived from the ISO 4217 standard is supported.
optional string currency_code = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCurrencyCodein interfaceInvoiceOrBuilder- Returns:
- Whether the currencyCode field is set.
-
getCurrencyCode
public java.lang.String getCurrencyCode()
Output only. The currency code. All costs are returned in this currency. A subset of the currency codes derived from the ISO 4217 standard is supported.
optional string currency_code = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCurrencyCodein interfaceInvoiceOrBuilder- Returns:
- The currencyCode.
-
getCurrencyCodeBytes
public com.google.protobuf.ByteString getCurrencyCodeBytes()
Output only. The currency code. All costs are returned in this currency. A subset of the currency codes derived from the ISO 4217 standard is supported.
optional string currency_code = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCurrencyCodeBytesin interfaceInvoiceOrBuilder- Returns:
- The bytes for currencyCode.
-
getAdjustmentsSubtotalAmountMicros
public long getAdjustmentsSubtotalAmountMicros()
Output only. The pretax subtotal amount of invoice level adjustments, in micros.
int64 adjustments_subtotal_amount_micros = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getAdjustmentsSubtotalAmountMicrosin interfaceInvoiceOrBuilder- Returns:
- The adjustmentsSubtotalAmountMicros.
-
getAdjustmentsTaxAmountMicros
public long getAdjustmentsTaxAmountMicros()
Output only. The sum of taxes on the invoice level adjustments, in micros.
int64 adjustments_tax_amount_micros = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getAdjustmentsTaxAmountMicrosin interfaceInvoiceOrBuilder- Returns:
- The adjustmentsTaxAmountMicros.
-
getAdjustmentsTotalAmountMicros
public long getAdjustmentsTotalAmountMicros()
Output only. The total amount of invoice level adjustments, in micros.
int64 adjustments_total_amount_micros = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getAdjustmentsTotalAmountMicrosin interfaceInvoiceOrBuilder- Returns:
- The adjustmentsTotalAmountMicros.
-
getRegulatoryCostsSubtotalAmountMicros
public long getRegulatoryCostsSubtotalAmountMicros()
Output only. The pretax subtotal amount of invoice level regulatory costs, in micros.
int64 regulatory_costs_subtotal_amount_micros = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getRegulatoryCostsSubtotalAmountMicrosin interfaceInvoiceOrBuilder- Returns:
- The regulatoryCostsSubtotalAmountMicros.
-
getRegulatoryCostsTaxAmountMicros
public long getRegulatoryCostsTaxAmountMicros()
Output only. The sum of taxes on the invoice level regulatory costs, in micros.
int64 regulatory_costs_tax_amount_micros = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getRegulatoryCostsTaxAmountMicrosin interfaceInvoiceOrBuilder- Returns:
- The regulatoryCostsTaxAmountMicros.
-
getRegulatoryCostsTotalAmountMicros
public long getRegulatoryCostsTotalAmountMicros()
Output only. The total amount of invoice level regulatory costs, in micros.
int64 regulatory_costs_total_amount_micros = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getRegulatoryCostsTotalAmountMicrosin interfaceInvoiceOrBuilder- Returns:
- The regulatoryCostsTotalAmountMicros.
-
hasSubtotalAmountMicros
public boolean hasSubtotalAmountMicros()
Output only. The pretax subtotal amount, in micros. This equals the sum of the AccountBudgetSummary subtotal amounts, Invoice.adjustments_subtotal_amount_micros, and Invoice.regulatory_costs_subtotal_amount_micros. Starting with v6, the Invoice.regulatory_costs_subtotal_amount_micros is no longer included.
optional int64 subtotal_amount_micros = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasSubtotalAmountMicrosin interfaceInvoiceOrBuilder- Returns:
- Whether the subtotalAmountMicros field is set.
-
getSubtotalAmountMicros
public long getSubtotalAmountMicros()
Output only. The pretax subtotal amount, in micros. This equals the sum of the AccountBudgetSummary subtotal amounts, Invoice.adjustments_subtotal_amount_micros, and Invoice.regulatory_costs_subtotal_amount_micros. Starting with v6, the Invoice.regulatory_costs_subtotal_amount_micros is no longer included.
optional int64 subtotal_amount_micros = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSubtotalAmountMicrosin interfaceInvoiceOrBuilder- Returns:
- The subtotalAmountMicros.
-
hasTaxAmountMicros
public boolean hasTaxAmountMicros()
Output only. The sum of all taxes on the invoice, in micros. This equals the sum of the AccountBudgetSummary tax amounts, plus taxes not associated with a specific account budget.
optional int64 tax_amount_micros = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasTaxAmountMicrosin interfaceInvoiceOrBuilder- Returns:
- Whether the taxAmountMicros field is set.
-
getTaxAmountMicros
public long getTaxAmountMicros()
Output only. The sum of all taxes on the invoice, in micros. This equals the sum of the AccountBudgetSummary tax amounts, plus taxes not associated with a specific account budget.
optional int64 tax_amount_micros = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTaxAmountMicrosin interfaceInvoiceOrBuilder- Returns:
- The taxAmountMicros.
-
hasTotalAmountMicros
public boolean hasTotalAmountMicros()
Output only. The total amount, in micros. This equals the sum of Invoice.subtotal_amount_micros and Invoice.tax_amount_micros. Starting with v6, Invoice.regulatory_costs_subtotal_amount_micros is also added as it is no longer already included in Invoice.tax_amount_micros.
optional int64 total_amount_micros = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasTotalAmountMicrosin interfaceInvoiceOrBuilder- Returns:
- Whether the totalAmountMicros field is set.
-
getTotalAmountMicros
public long getTotalAmountMicros()
Output only. The total amount, in micros. This equals the sum of Invoice.subtotal_amount_micros and Invoice.tax_amount_micros. Starting with v6, Invoice.regulatory_costs_subtotal_amount_micros is also added as it is no longer already included in Invoice.tax_amount_micros.
optional int64 total_amount_micros = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTotalAmountMicrosin interfaceInvoiceOrBuilder- Returns:
- The totalAmountMicros.
-
hasCorrectedInvoice
public boolean hasCorrectedInvoice()
Output only. The resource name of the original invoice corrected, wrote off, or canceled by this invoice, if applicable. If `corrected_invoice` is set, `replaced_invoices` will not be set. Invoice resource names have the form: `customers/{customer_id}/invoices/{invoice_id}`optional string corrected_invoice = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCorrectedInvoicein interfaceInvoiceOrBuilder- Returns:
- Whether the correctedInvoice field is set.
-
getCorrectedInvoice
public java.lang.String getCorrectedInvoice()
Output only. The resource name of the original invoice corrected, wrote off, or canceled by this invoice, if applicable. If `corrected_invoice` is set, `replaced_invoices` will not be set. Invoice resource names have the form: `customers/{customer_id}/invoices/{invoice_id}`optional string corrected_invoice = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCorrectedInvoicein interfaceInvoiceOrBuilder- Returns:
- The correctedInvoice.
-
getCorrectedInvoiceBytes
public com.google.protobuf.ByteString getCorrectedInvoiceBytes()
Output only. The resource name of the original invoice corrected, wrote off, or canceled by this invoice, if applicable. If `corrected_invoice` is set, `replaced_invoices` will not be set. Invoice resource names have the form: `customers/{customer_id}/invoices/{invoice_id}`optional string corrected_invoice = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCorrectedInvoiceBytesin interfaceInvoiceOrBuilder- Returns:
- The bytes for correctedInvoice.
-
getReplacedInvoicesList
public com.google.protobuf.ProtocolStringList getReplacedInvoicesList()
Output only. The resource name of the original invoice(s) being rebilled or replaced by this invoice, if applicable. There might be multiple replaced invoices due to invoice consolidation. The replaced invoices may not belong to the same payments account. If `replaced_invoices` is set, `corrected_invoice` will not be set. Invoice resource names have the form: `customers/{customer_id}/invoices/{invoice_id}`repeated string replaced_invoices = 37 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getReplacedInvoicesListin interfaceInvoiceOrBuilder- Returns:
- A list containing the replacedInvoices.
-
getReplacedInvoicesCount
public int getReplacedInvoicesCount()
Output only. The resource name of the original invoice(s) being rebilled or replaced by this invoice, if applicable. There might be multiple replaced invoices due to invoice consolidation. The replaced invoices may not belong to the same payments account. If `replaced_invoices` is set, `corrected_invoice` will not be set. Invoice resource names have the form: `customers/{customer_id}/invoices/{invoice_id}`repeated string replaced_invoices = 37 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getReplacedInvoicesCountin interfaceInvoiceOrBuilder- Returns:
- The count of replacedInvoices.
-
getReplacedInvoices
public java.lang.String getReplacedInvoices(int index)
Output only. The resource name of the original invoice(s) being rebilled or replaced by this invoice, if applicable. There might be multiple replaced invoices due to invoice consolidation. The replaced invoices may not belong to the same payments account. If `replaced_invoices` is set, `corrected_invoice` will not be set. Invoice resource names have the form: `customers/{customer_id}/invoices/{invoice_id}`repeated string replaced_invoices = 37 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getReplacedInvoicesin interfaceInvoiceOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The replacedInvoices at the given index.
-
getReplacedInvoicesBytes
public com.google.protobuf.ByteString getReplacedInvoicesBytes(int index)
Output only. The resource name of the original invoice(s) being rebilled or replaced by this invoice, if applicable. There might be multiple replaced invoices due to invoice consolidation. The replaced invoices may not belong to the same payments account. If `replaced_invoices` is set, `corrected_invoice` will not be set. Invoice resource names have the form: `customers/{customer_id}/invoices/{invoice_id}`repeated string replaced_invoices = 37 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getReplacedInvoicesBytesin interfaceInvoiceOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the replacedInvoices at the given index.
-
hasPdfUrl
public boolean hasPdfUrl()
Output only. The URL to a PDF copy of the invoice. Users need to pass in their OAuth token to request the PDF with this URL.
optional string pdf_url = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasPdfUrlin interfaceInvoiceOrBuilder- Returns:
- Whether the pdfUrl field is set.
-
getPdfUrl
public java.lang.String getPdfUrl()
Output only. The URL to a PDF copy of the invoice. Users need to pass in their OAuth token to request the PDF with this URL.
optional string pdf_url = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPdfUrlin interfaceInvoiceOrBuilder- Returns:
- The pdfUrl.
-
getPdfUrlBytes
public com.google.protobuf.ByteString getPdfUrlBytes()
Output only. The URL to a PDF copy of the invoice. Users need to pass in their OAuth token to request the PDF with this URL.
optional string pdf_url = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPdfUrlBytesin interfaceInvoiceOrBuilder- Returns:
- The bytes for pdfUrl.
-
getAccountBudgetSummariesList
public java.util.List<Invoice.AccountBudgetSummary> getAccountBudgetSummariesList()
Output only. The list of summarized account budget information associated with this invoice.
repeated .google.ads.googleads.v10.resources.Invoice.AccountBudgetSummary account_budget_summaries = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getAccountBudgetSummariesListin interfaceInvoiceOrBuilder
-
getAccountBudgetSummariesOrBuilderList
public java.util.List<? extends Invoice.AccountBudgetSummaryOrBuilder> getAccountBudgetSummariesOrBuilderList()
Output only. The list of summarized account budget information associated with this invoice.
repeated .google.ads.googleads.v10.resources.Invoice.AccountBudgetSummary account_budget_summaries = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getAccountBudgetSummariesOrBuilderListin interfaceInvoiceOrBuilder
-
getAccountBudgetSummariesCount
public int getAccountBudgetSummariesCount()
Output only. The list of summarized account budget information associated with this invoice.
repeated .google.ads.googleads.v10.resources.Invoice.AccountBudgetSummary account_budget_summaries = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getAccountBudgetSummariesCountin interfaceInvoiceOrBuilder
-
getAccountBudgetSummaries
public Invoice.AccountBudgetSummary getAccountBudgetSummaries(int index)
Output only. The list of summarized account budget information associated with this invoice.
repeated .google.ads.googleads.v10.resources.Invoice.AccountBudgetSummary account_budget_summaries = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getAccountBudgetSummariesin interfaceInvoiceOrBuilder
-
getAccountBudgetSummariesOrBuilder
public Invoice.AccountBudgetSummaryOrBuilder getAccountBudgetSummariesOrBuilder(int index)
Output only. The list of summarized account budget information associated with this invoice.
repeated .google.ads.googleads.v10.resources.Invoice.AccountBudgetSummary account_budget_summaries = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getAccountBudgetSummariesOrBuilderin interfaceInvoiceOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Invoice parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Invoice parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Invoice parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Invoice parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Invoice parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Invoice parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Invoice parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Invoice parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Invoice parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Invoice parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Invoice parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Invoice parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public Invoice.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Invoice.Builder newBuilder()
-
newBuilder
public static Invoice.Builder newBuilder(Invoice prototype)
-
toBuilder
public Invoice.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Invoice.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static Invoice getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Invoice> parser()
-
getParserForType
public com.google.protobuf.Parser<Invoice> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Invoice getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-