Package com.google.ads.googleads.v10.resources

Interface InvoiceOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Invoice, Invoice.Builder
    public interface InvoiceOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getResourceName

        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) = { ... }
        Returns:
        The resourceName.

      • getResourceNameBytes

        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) = { ... }
        Returns:
        The bytes for resourceName.

      • hasId

        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];
        Returns:
        Whether the id field is set.

      • getId

        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];
        Returns:
        The id.

      • getIdBytes

        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];
        Returns:
        The bytes for id.

      • getTypeValue

        int getTypeValue()
         Output only. The type of invoice.
        .google.ads.googleads.v10.enums.InvoiceTypeEnum.InvoiceType type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for type.

      • getType

        InvoiceTypeEnum.InvoiceType getType()
         Output only. The type of invoice.
        .google.ads.googleads.v10.enums.InvoiceTypeEnum.InvoiceType type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The type.

      • hasBillingSetup

        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];
        Returns:
        Whether the billingSetup field is set.

      • getBillingSetup

        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];
        Returns:
        The billingSetup.

      • getBillingSetupBytes

        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];
        Returns:
        The bytes for billingSetup.

      • hasPaymentsAccountId

        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];
        Returns:
        Whether the paymentsAccountId field is set.

      • getPaymentsAccountId

        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];
        Returns:
        The paymentsAccountId.

      • getPaymentsAccountIdBytes

        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];
        Returns:
        The bytes for paymentsAccountId.

      • hasPaymentsProfileId

        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];
        Returns:
        Whether the paymentsProfileId field is set.

      • getPaymentsProfileId

        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];
        Returns:
        The paymentsProfileId.

      • getPaymentsProfileIdBytes

        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];
        Returns:
        The bytes for paymentsProfileId.

      • hasIssueDate

        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];
        Returns:
        Whether the issueDate field is set.

      • getIssueDate

        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];
        Returns:
        The issueDate.

      • getIssueDateBytes

        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];
        Returns:
        The bytes for issueDate.

      • hasDueDate

        boolean hasDueDate()
         Output only. The due date in yyyy-mm-dd format.
        optional string due_date = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the dueDate field is set.

      • getDueDate

        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];
        Returns:
        The dueDate.

      • getDueDateBytes

        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];
        Returns:
        The bytes for dueDate.

      • hasServiceDateRange

        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];
        Returns:
        Whether the serviceDateRange field is set.

      • getServiceDateRange

        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];
        Returns:
        The serviceDateRange.

      • getServiceDateRangeOrBuilder

        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];

      • hasCurrencyCode

        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];
        Returns:
        Whether the currencyCode field is set.

      • getCurrencyCode

        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];
        Returns:
        The currencyCode.

      • getCurrencyCodeBytes

        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];
        Returns:
        The bytes for currencyCode.

      • getAdjustmentsSubtotalAmountMicros

        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];
        Returns:
        The adjustmentsSubtotalAmountMicros.

      • getAdjustmentsTaxAmountMicros

        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];
        Returns:
        The adjustmentsTaxAmountMicros.

      • getAdjustmentsTotalAmountMicros

        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];
        Returns:
        The adjustmentsTotalAmountMicros.

      • getRegulatoryCostsSubtotalAmountMicros

        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];
        Returns:
        The regulatoryCostsSubtotalAmountMicros.

      • getRegulatoryCostsTaxAmountMicros

        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];
        Returns:
        The regulatoryCostsTaxAmountMicros.

      • getRegulatoryCostsTotalAmountMicros

        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];
        Returns:
        The regulatoryCostsTotalAmountMicros.

      • hasSubtotalAmountMicros

        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];
        Returns:
        Whether the subtotalAmountMicros field is set.

      • getSubtotalAmountMicros

        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];
        Returns:
        The subtotalAmountMicros.

      • hasTaxAmountMicros

        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];
        Returns:
        Whether the taxAmountMicros field is set.

      • getTaxAmountMicros

        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];
        Returns:
        The taxAmountMicros.

      • hasTotalAmountMicros

        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];
        Returns:
        Whether the totalAmountMicros field is set.

      • getTotalAmountMicros

        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];
        Returns:
        The totalAmountMicros.

      • hasCorrectedInvoice

        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];
        Returns:
        Whether the correctedInvoice field is set.

      • getCorrectedInvoice

        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];
        Returns:
        The correctedInvoice.

      • getCorrectedInvoiceBytes

        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];
        Returns:
        The bytes for correctedInvoice.

      • getReplacedInvoicesList

        java.util.List<java.lang.String> 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];
        Returns:
        A list containing the replacedInvoices.

      • getReplacedInvoicesCount

        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];
        Returns:
        The count of replacedInvoices.

      • getReplacedInvoices

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The replacedInvoices at the given index.

      • getReplacedInvoicesBytes

        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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the replacedInvoices at the given index.

      • hasPdfUrl

        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];
        Returns:
        Whether the pdfUrl field is set.

      • getPdfUrl

        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];
        Returns:
        The pdfUrl.

      • getPdfUrlBytes

        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];
        Returns:
        The bytes for pdfUrl.

      • getAccountBudgetSummariesList

        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];

      • getAccountBudgetSummaries

        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];

      • getAccountBudgetSummariesCount

        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];

      • getAccountBudgetSummariesOrBuilderList

        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];

      • getAccountBudgetSummariesOrBuilder

        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];