com.google.ads.googleads.v10.resources.InvoiceOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v10 Show documentation
Stubs for GAAPI version google-ads-stubs-v10
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v10/resources/invoice.proto

package com.google.ads.googleads.v10.resources;

public interface InvoiceOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v10.resources.Invoice)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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) = { ... }
   * @return The resourceName.
   */
  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) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * 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];
   * @return Whether the id field is set.
   */
  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];
   * @return The id.
   */
  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];
   * @return The bytes for id.
   */
  com.google.protobuf.ByteString
      getIdBytes();

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

  /**
   *    * 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];
   * @return Whether the billingSetup field is set.
   */
  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];
   * @return The billingSetup.
   */
  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];
   * @return The bytes for billingSetup.
   */
  com.google.protobuf.ByteString
      getBillingSetupBytes();

  /**
   *    * 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];
   * @return Whether the paymentsAccountId field is set.
   */
  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];
   * @return The paymentsAccountId.
   */
  java.lang.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];
   * @return The bytes for paymentsAccountId.
   */
  com.google.protobuf.ByteString
      getPaymentsAccountIdBytes();

  /**
   *    * 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];
   * @return Whether the paymentsProfileId field is set.
   */
  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];
   * @return The paymentsProfileId.
   */
  java.lang.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];
   * @return The bytes for paymentsProfileId.
   */
  com.google.protobuf.ByteString
      getPaymentsProfileIdBytes();

  /**
   *    * 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];
   * @return Whether the issueDate field is set.
   */
  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];
   * @return The issueDate.
   */
  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];
   * @return The bytes for issueDate.
   */
  com.google.protobuf.ByteString
      getIssueDateBytes();

  /**
   *    * Output only. The due date in yyyy-mm-dd format.
   * 
   *
   * optional string due_date = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the dueDate field is set.
   */
  boolean hasDueDate();
  /**
   *    * Output only. The due date in yyyy-mm-dd format.
   * 
   *
   * optional string due_date = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The dueDate.
   */
  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];
   * @return The bytes for dueDate.
   */
  com.google.protobuf.ByteString
      getDueDateBytes();

  /**
   *    * 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];
   * @return Whether the serviceDateRange field is set.
   */
  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];
   * @return The serviceDateRange.
   */
  com.google.ads.googleads.v10.common.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];
   */
  com.google.ads.googleads.v10.common.DateRangeOrBuilder getServiceDateRangeOrBuilder();

  /**
   *    * 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];
   * @return Whether the currencyCode field is set.
   */
  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];
   * @return The currencyCode.
   */
  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];
   * @return The bytes for currencyCode.
   */
  com.google.protobuf.ByteString
      getCurrencyCodeBytes();

  /**
   *    * Output only. The pretax subtotal amount of invoice level adjustments, in micros.
   * 
   *
   * int64 adjustments_subtotal_amount_micros = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The adjustmentsSubtotalAmountMicros.
   */
  long getAdjustmentsSubtotalAmountMicros();

  /**
   *    * 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];
   * @return The adjustmentsTaxAmountMicros.
   */
  long getAdjustmentsTaxAmountMicros();

  /**
   *    * Output only. The total amount of invoice level adjustments, in micros.
   * 
   *
   * int64 adjustments_total_amount_micros = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The adjustmentsTotalAmountMicros.
   */
  long getAdjustmentsTotalAmountMicros();

  /**
   *    * 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];
   * @return The regulatoryCostsSubtotalAmountMicros.
   */
  long getRegulatoryCostsSubtotalAmountMicros();

  /**
   *    * 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];
   * @return The regulatoryCostsTaxAmountMicros.
   */
  long getRegulatoryCostsTaxAmountMicros();

  /**
   *    * 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];
   * @return The regulatoryCostsTotalAmountMicros.
   */
  long getRegulatoryCostsTotalAmountMicros();

  /**
   *    * 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];
   * @return Whether the subtotalAmountMicros field is set.
   */
  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];
   * @return The subtotalAmountMicros.
   */
  long getSubtotalAmountMicros();

  /**
   *    * 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];
   * @return Whether the taxAmountMicros field is set.
   */
  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];
   * @return The taxAmountMicros.
   */
  long getTaxAmountMicros();

  /**
   *    * 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];
   * @return Whether the totalAmountMicros field is set.
   */
  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];
   * @return The totalAmountMicros.
   */
  long getTotalAmountMicros();

  /**
   *    * 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];
   * @return Whether the correctedInvoice field is set.
   */
  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];
   * @return The correctedInvoice.
   */
  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];
   * @return The bytes for correctedInvoice.
   */
  com.google.protobuf.ByteString
      getCorrectedInvoiceBytes();

  /**
   *    * 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];
   * @return A list containing the replacedInvoices.
   */
  java.util.List
      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];
   * @return The count of replacedInvoices.
   */
  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];
   * @param index The index of the element to return.
   * @return The replacedInvoices at the given index.
   */
  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];
   * @param index The index of the value to return.
   * @return The bytes of the replacedInvoices at the given index.
   */
  com.google.protobuf.ByteString
      getReplacedInvoicesBytes(int index);

  /**
   *    * 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];
   * @return Whether the pdfUrl field is set.
   */
  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];
   * @return The pdfUrl.
   */
  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];
   * @return The bytes for pdfUrl.
   */
  com.google.protobuf.ByteString
      getPdfUrlBytes();

  /**
   *    * 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];
   */
  java.util.List 
      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];
   */
  com.google.ads.googleads.v10.resources.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];
   */
  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];
   */
  java.util.List 
      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];
   */
  com.google.ads.googleads.v10.resources.Invoice.AccountBudgetSummaryOrBuilder getAccountBudgetSummariesOrBuilder(
      int index);
}