java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.Invoice
All Implemented Interfaces:
InvoiceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, 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 type google.ads.googleads.v18.resources.Invoice
See Also:
  • Field Details

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:
    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:
    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:
    • BILLING_SETUP_FIELD_NUMBER

      public static final int BILLING_SETUP_FIELD_NUMBER
      See Also:
    • PAYMENTS_ACCOUNT_ID_FIELD_NUMBER

      public static final int PAYMENTS_ACCOUNT_ID_FIELD_NUMBER
      See Also:
    • PAYMENTS_PROFILE_ID_FIELD_NUMBER

      public static final int PAYMENTS_PROFILE_ID_FIELD_NUMBER
      See Also:
    • ISSUE_DATE_FIELD_NUMBER

      public static final int ISSUE_DATE_FIELD_NUMBER
      See Also:
    • DUE_DATE_FIELD_NUMBER

      public static final int DUE_DATE_FIELD_NUMBER
      See Also:
    • SERVICE_DATE_RANGE_FIELD_NUMBER

      public static final int SERVICE_DATE_RANGE_FIELD_NUMBER
      See Also:
    • CURRENCY_CODE_FIELD_NUMBER

      public static final int CURRENCY_CODE_FIELD_NUMBER
      See Also:
    • ADJUSTMENTS_SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER

      public static final int ADJUSTMENTS_SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER
      See Also:
    • ADJUSTMENTS_TAX_AMOUNT_MICROS_FIELD_NUMBER

      public static final int ADJUSTMENTS_TAX_AMOUNT_MICROS_FIELD_NUMBER
      See Also:
    • ADJUSTMENTS_TOTAL_AMOUNT_MICROS_FIELD_NUMBER

      public static final int ADJUSTMENTS_TOTAL_AMOUNT_MICROS_FIELD_NUMBER
      See Also:
    • REGULATORY_COSTS_SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER

      public static final int REGULATORY_COSTS_SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER
      See Also:
    • REGULATORY_COSTS_TAX_AMOUNT_MICROS_FIELD_NUMBER

      public static final int REGULATORY_COSTS_TAX_AMOUNT_MICROS_FIELD_NUMBER
      See Also:
    • REGULATORY_COSTS_TOTAL_AMOUNT_MICROS_FIELD_NUMBER

      public static final int REGULATORY_COSTS_TOTAL_AMOUNT_MICROS_FIELD_NUMBER
      See Also:
    • EXPORT_CHARGE_SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER

      public static final int EXPORT_CHARGE_SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER
      See Also:
    • EXPORT_CHARGE_TAX_AMOUNT_MICROS_FIELD_NUMBER

      public static final int EXPORT_CHARGE_TAX_AMOUNT_MICROS_FIELD_NUMBER
      See Also:
    • EXPORT_CHARGE_TOTAL_AMOUNT_MICROS_FIELD_NUMBER

      public static final int EXPORT_CHARGE_TOTAL_AMOUNT_MICROS_FIELD_NUMBER
      See Also:
    • SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER

      public static final int SUBTOTAL_AMOUNT_MICROS_FIELD_NUMBER
      See Also:
    • TAX_AMOUNT_MICROS_FIELD_NUMBER

      public static final int TAX_AMOUNT_MICROS_FIELD_NUMBER
      See Also:
    • TOTAL_AMOUNT_MICROS_FIELD_NUMBER

      public static final int TOTAL_AMOUNT_MICROS_FIELD_NUMBER
      See Also:
    • CORRECTED_INVOICE_FIELD_NUMBER

      public static final int CORRECTED_INVOICE_FIELD_NUMBER
      See Also:
    • REPLACED_INVOICES_FIELD_NUMBER

      public static final int REPLACED_INVOICES_FIELD_NUMBER
      See Also:
    • PDF_URL_FIELD_NUMBER

      public static final int PDF_URL_FIELD_NUMBER
      See Also:
    • ACCOUNT_BUDGET_SUMMARIES_FIELD_NUMBER

      public static final int ACCOUNT_BUDGET_SUMMARIES_FIELD_NUMBER
      See Also:
    • ACCOUNT_SUMMARIES_FIELD_NUMBER

      public static final int ACCOUNT_SUMMARIES_FIELD_NUMBER
      See Also:
  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3
    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
    • getResourceName

      public 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:
      getResourceName in interface InvoiceOrBuilder
      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:
      getResourceNameBytes in interface InvoiceOrBuilder
      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:
      hasId in interface InvoiceOrBuilder
      Returns:
      Whether the id field is set.
    • getId

      public 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:
      getId in interface InvoiceOrBuilder
      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:
      getIdBytes in interface InvoiceOrBuilder
      Returns:
      The bytes for id.
    • getTypeValue

      public int getTypeValue()
       Output only. The type of invoice.
       
      .google.ads.googleads.v18.enums.InvoiceTypeEnum.InvoiceType type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTypeValue in interface InvoiceOrBuilder
      Returns:
      The enum numeric value on the wire for type.
    • getType

      public InvoiceTypeEnum.InvoiceType getType()
       Output only. The type of invoice.
       
      .google.ads.googleads.v18.enums.InvoiceTypeEnum.InvoiceType type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getType in interface InvoiceOrBuilder
      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:
      hasBillingSetup in interface InvoiceOrBuilder
      Returns:
      Whether the billingSetup field is set.
    • getBillingSetup

      public 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:
      getBillingSetup in interface InvoiceOrBuilder
      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:
      getBillingSetupBytes in interface InvoiceOrBuilder
      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, for example, "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:
      hasPaymentsAccountId in interface InvoiceOrBuilder
      Returns:
      Whether the paymentsAccountId field is set.
    • getPaymentsAccountId

      public String getPaymentsAccountId()
       Output only. A 16 digit ID used to identify the payments account associated
       with the billing setup, for example, "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:
      getPaymentsAccountId in interface InvoiceOrBuilder
      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, for example, "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:
      getPaymentsAccountIdBytes in interface InvoiceOrBuilder
      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, for example, "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:
      hasPaymentsProfileId in interface InvoiceOrBuilder
      Returns:
      Whether the paymentsProfileId field is set.
    • getPaymentsProfileId

      public String getPaymentsProfileId()
       Output only. A 12 digit ID used to identify the payments profile associated
       with the billing setup, for example, "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:
      getPaymentsProfileId in interface InvoiceOrBuilder
      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, for example, "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:
      getPaymentsProfileIdBytes in interface InvoiceOrBuilder
      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:
      hasIssueDate in interface InvoiceOrBuilder
      Returns:
      Whether the issueDate field is set.
    • getIssueDate

      public 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:
      getIssueDate in interface InvoiceOrBuilder
      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:
      getIssueDateBytes in interface InvoiceOrBuilder
      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:
      hasDueDate in interface InvoiceOrBuilder
      Returns:
      Whether the dueDate field is set.
    • getDueDate

      public 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:
      getDueDate in interface InvoiceOrBuilder
      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:
      getDueDateBytes in interface InvoiceOrBuilder
      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.v18.common.DateRange service_date_range = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasServiceDateRange in interface InvoiceOrBuilder
      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.v18.common.DateRange service_date_range = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getServiceDateRange in interface InvoiceOrBuilder
      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.v18.common.DateRange service_date_range = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getServiceDateRangeOrBuilder in interface InvoiceOrBuilder
    • 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:
      hasCurrencyCode in interface InvoiceOrBuilder
      Returns:
      Whether the currencyCode field is set.
    • getCurrencyCode

      public 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:
      getCurrencyCode in interface InvoiceOrBuilder
      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:
      getCurrencyCodeBytes in interface InvoiceOrBuilder
      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:
      getAdjustmentsSubtotalAmountMicros in interface InvoiceOrBuilder
      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:
      getAdjustmentsTaxAmountMicros in interface InvoiceOrBuilder
      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:
      getAdjustmentsTotalAmountMicros in interface InvoiceOrBuilder
      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:
      getRegulatoryCostsSubtotalAmountMicros in interface InvoiceOrBuilder
      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:
      getRegulatoryCostsTaxAmountMicros in interface InvoiceOrBuilder
      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:
      getRegulatoryCostsTotalAmountMicros in interface InvoiceOrBuilder
      Returns:
      The regulatoryCostsTotalAmountMicros.
    • hasExportChargeSubtotalAmountMicros

      public boolean hasExportChargeSubtotalAmountMicros()
       Output only. The pretax subtotal amount of invoice level export charges, in
       micros.
       
      optional int64 export_charge_subtotal_amount_micros = 40 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasExportChargeSubtotalAmountMicros in interface InvoiceOrBuilder
      Returns:
      Whether the exportChargeSubtotalAmountMicros field is set.
    • getExportChargeSubtotalAmountMicros

      public long getExportChargeSubtotalAmountMicros()
       Output only. The pretax subtotal amount of invoice level export charges, in
       micros.
       
      optional int64 export_charge_subtotal_amount_micros = 40 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExportChargeSubtotalAmountMicros in interface InvoiceOrBuilder
      Returns:
      The exportChargeSubtotalAmountMicros.
    • hasExportChargeTaxAmountMicros

      public boolean hasExportChargeTaxAmountMicros()
       Output only. The sum of taxes on the invoice level export charges, in
       micros.
       
      optional int64 export_charge_tax_amount_micros = 41 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasExportChargeTaxAmountMicros in interface InvoiceOrBuilder
      Returns:
      Whether the exportChargeTaxAmountMicros field is set.
    • getExportChargeTaxAmountMicros

      public long getExportChargeTaxAmountMicros()
       Output only. The sum of taxes on the invoice level export charges, in
       micros.
       
      optional int64 export_charge_tax_amount_micros = 41 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExportChargeTaxAmountMicros in interface InvoiceOrBuilder
      Returns:
      The exportChargeTaxAmountMicros.
    • hasExportChargeTotalAmountMicros

      public boolean hasExportChargeTotalAmountMicros()
       Output only. The total amount of invoice level export charges, in micros.
       
      optional int64 export_charge_total_amount_micros = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasExportChargeTotalAmountMicros in interface InvoiceOrBuilder
      Returns:
      Whether the exportChargeTotalAmountMicros field is set.
    • getExportChargeTotalAmountMicros

      public long getExportChargeTotalAmountMicros()
       Output only. The total amount of invoice level export charges, in micros.
       
      optional int64 export_charge_total_amount_micros = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExportChargeTotalAmountMicros in interface InvoiceOrBuilder
      Returns:
      The exportChargeTotalAmountMicros.
    • hasSubtotalAmountMicros

      public boolean hasSubtotalAmountMicros()
       Output only. The pretax subtotal amount, in micros. This is equal to the
       sum of the AccountBudgetSummary subtotal amounts and
       Invoice.adjustments_subtotal_amount_micros.
       
      optional int64 subtotal_amount_micros = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasSubtotalAmountMicros in interface InvoiceOrBuilder
      Returns:
      Whether the subtotalAmountMicros field is set.
    • getSubtotalAmountMicros

      public long getSubtotalAmountMicros()
       Output only. The pretax subtotal amount, in micros. This is equal to the
       sum of the AccountBudgetSummary subtotal amounts and
       Invoice.adjustments_subtotal_amount_micros.
       
      optional int64 subtotal_amount_micros = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSubtotalAmountMicros in interface InvoiceOrBuilder
      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:
      hasTaxAmountMicros in interface InvoiceOrBuilder
      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:
      getTaxAmountMicros in interface InvoiceOrBuilder
      Returns:
      The taxAmountMicros.
    • hasTotalAmountMicros

      public boolean hasTotalAmountMicros()
       Output only. The total amount, in micros. This equals the sum of
       Invoice.subtotal_amount_micros, Invoice.tax_amount_micros,
       Invoice.regulatory_costs_subtotal_amount_micros, and
       Invoice.export_charge_subtotal_amount_micros (which is separated into a
       separate line item starting with V14.1).
       
      optional int64 total_amount_micros = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasTotalAmountMicros in interface InvoiceOrBuilder
      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, Invoice.tax_amount_micros,
       Invoice.regulatory_costs_subtotal_amount_micros, and
       Invoice.export_charge_subtotal_amount_micros (which is separated into a
       separate line item starting with V14.1).
       
      optional int64 total_amount_micros = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTotalAmountMicros in interface InvoiceOrBuilder
      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:
      hasCorrectedInvoice in interface InvoiceOrBuilder
      Returns:
      Whether the correctedInvoice field is set.
    • getCorrectedInvoice

      public 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:
      getCorrectedInvoice in interface InvoiceOrBuilder
      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:
      getCorrectedInvoiceBytes in interface InvoiceOrBuilder
      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:
      getReplacedInvoicesList in interface InvoiceOrBuilder
      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:
      getReplacedInvoicesCount in interface InvoiceOrBuilder
      Returns:
      The count of replacedInvoices.
    • getReplacedInvoices

      public 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:
      getReplacedInvoices in interface InvoiceOrBuilder
      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:
      getReplacedInvoicesBytes in interface InvoiceOrBuilder
      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:
      hasPdfUrl in interface InvoiceOrBuilder
      Returns:
      Whether the pdfUrl field is set.
    • getPdfUrl

      public 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:
      getPdfUrl in interface InvoiceOrBuilder
      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:
      getPdfUrlBytes in interface InvoiceOrBuilder
      Returns:
      The bytes for pdfUrl.
    • getAccountBudgetSummariesList

      public List<Invoice.AccountBudgetSummary> getAccountBudgetSummariesList()
       Output only. The list of summarized account budget information associated
       with this invoice.
       
      repeated .google.ads.googleads.v18.resources.Invoice.AccountBudgetSummary account_budget_summaries = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccountBudgetSummariesList in interface InvoiceOrBuilder
    • getAccountBudgetSummariesOrBuilderList

      public List<? extends Invoice.AccountBudgetSummaryOrBuilder> getAccountBudgetSummariesOrBuilderList()
       Output only. The list of summarized account budget information associated
       with this invoice.
       
      repeated .google.ads.googleads.v18.resources.Invoice.AccountBudgetSummary account_budget_summaries = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccountBudgetSummariesOrBuilderList in interface InvoiceOrBuilder
    • getAccountBudgetSummariesCount

      public int getAccountBudgetSummariesCount()
       Output only. The list of summarized account budget information associated
       with this invoice.
       
      repeated .google.ads.googleads.v18.resources.Invoice.AccountBudgetSummary account_budget_summaries = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccountBudgetSummariesCount in interface InvoiceOrBuilder
    • getAccountBudgetSummaries

      public Invoice.AccountBudgetSummary getAccountBudgetSummaries(int index)
       Output only. The list of summarized account budget information associated
       with this invoice.
       
      repeated .google.ads.googleads.v18.resources.Invoice.AccountBudgetSummary account_budget_summaries = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccountBudgetSummaries in interface InvoiceOrBuilder
    • getAccountBudgetSummariesOrBuilder

      public Invoice.AccountBudgetSummaryOrBuilder getAccountBudgetSummariesOrBuilder(int index)
       Output only. The list of summarized account budget information associated
       with this invoice.
       
      repeated .google.ads.googleads.v18.resources.Invoice.AccountBudgetSummary account_budget_summaries = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccountBudgetSummariesOrBuilder in interface InvoiceOrBuilder
    • getAccountSummariesList

      public List<Invoice.AccountSummary> getAccountSummariesList()
       Output only. The list of summarized account information associated with
       this invoice.
       
      repeated .google.ads.googleads.v18.resources.Invoice.AccountSummary account_summaries = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccountSummariesList in interface InvoiceOrBuilder
    • getAccountSummariesOrBuilderList

      public List<? extends Invoice.AccountSummaryOrBuilder> getAccountSummariesOrBuilderList()
       Output only. The list of summarized account information associated with
       this invoice.
       
      repeated .google.ads.googleads.v18.resources.Invoice.AccountSummary account_summaries = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccountSummariesOrBuilderList in interface InvoiceOrBuilder
    • getAccountSummariesCount

      public int getAccountSummariesCount()
       Output only. The list of summarized account information associated with
       this invoice.
       
      repeated .google.ads.googleads.v18.resources.Invoice.AccountSummary account_summaries = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccountSummariesCount in interface InvoiceOrBuilder
    • getAccountSummaries

      public Invoice.AccountSummary getAccountSummaries(int index)
       Output only. The list of summarized account information associated with
       this invoice.
       
      repeated .google.ads.googleads.v18.resources.Invoice.AccountSummary account_summaries = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccountSummaries in interface InvoiceOrBuilder
    • getAccountSummariesOrBuilder

      public Invoice.AccountSummaryOrBuilder getAccountSummariesOrBuilder(int index)
       Output only. The list of summarized account information associated with
       this invoice.
       
      repeated .google.ads.googleads.v18.resources.Invoice.AccountSummary account_summaries = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccountSummariesOrBuilder in interface InvoiceOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static Invoice parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Invoice parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Invoice parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static Invoice parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static Invoice parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Invoice parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Invoice parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public Invoice.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static Invoice.Builder newBuilder()
    • newBuilder

      public static Invoice.Builder newBuilder(Invoice prototype)
    • toBuilder

      public Invoice.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected Invoice.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.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:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstanceForType

      public Invoice getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder