Invoice

AI-generated Key Takeaways

• Invoice information is a snapshot matching the PDF invoice, though older invoices might not match exactly.

• Invoices are identified by a resource name including customer and invoice ID, and multiple customers can share an invoice.

• Key financial details like subtotals, taxes, and total amounts are available in micros, along with adjustment, regulatory cost, and export charge breakdowns.

• The invoice includes important identifying numbers such as Invoice ID, Payments Account ID, and Payments Profile ID.

• Dates like issue date, due date, and service date range, along with the currency code and a URL for the PDF copy, are also provided.

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.

Fields
resource_name	string 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}
type	InvoiceType Output only. The type of invoice.
service_date_range	DateRange Output only. The service period date range of this invoice. The end date is inclusive.
adjustments_subtotal_amount_micros	int64 Output only. The pretax subtotal amount of invoice level adjustments, in micros.
adjustments_tax_amount_micros	int64 Output only. The sum of taxes on the invoice level adjustments, in micros.
adjustments_total_amount_micros	int64 Output only. The total amount of invoice level adjustments, in micros.
regulatory_costs_subtotal_amount_micros	int64 Output only. The pretax subtotal amount of invoice level regulatory costs, in micros.
regulatory_costs_tax_amount_micros	int64 Output only. The sum of taxes on the invoice level regulatory costs, in micros.
regulatory_costs_total_amount_micros	int64 Output only. The total amount of invoice level regulatory costs, in micros.
replaced_invoices[]	string 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}
account_budget_summaries[]	AccountBudgetSummary Output only. The list of summarized account budget information associated with this invoice.
account_summaries[]	AccountSummary Output only. The list of summarized account information associated with this invoice.
id	string Output only. The ID of the invoice. It appears on the invoice PDF as "Invoice number".
billing_setup	string Output only. The resource name of this invoice's billing setup. customers/{customer_id}/billingSetups/{billing_setup_id}
payments_account_id	string 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".
payments_profile_id	string 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".
issue_date	string Output only. The issue date in yyyy-mm-dd format. It appears on the invoice PDF as either "Issue date" or "Invoice date".
due_date	string Output only. The due date in yyyy-mm-dd format.
currency_code	string 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.
export_charge_subtotal_amount_micros	int64 Output only. The pretax subtotal amount of invoice level export charges, in micros.
export_charge_tax_amount_micros	int64 Output only. The sum of taxes on the invoice level export charges, in micros.
export_charge_total_amount_micros	int64 Output only. The total amount of invoice level export charges, in micros.
subtotal_amount_micros	int64 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.
tax_amount_micros	int64 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.
total_amount_micros	int64 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).
corrected_invoice	string 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}
pdf_url	string 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.