Struct Invoice

pub struct Invoice {

    pub resource_name: String,
    pub id: String,
    pub type: i32,
    pub billing_setup: String,
    pub payments_account_id: String,
    pub payments_profile_id: String,
    pub issue_date: String,
    pub due_date: String,
    pub service_date_range: Option<DateRange>,
    pub currency_code: String,
    pub adjustments_subtotal_amount_micros: i64,
    pub adjustments_tax_amount_micros: i64,
    pub adjustments_total_amount_micros: i64,
    pub regulatory_costs_subtotal_amount_micros: i64,
    pub regulatory_costs_tax_amount_micros: i64,
    pub regulatory_costs_total_amount_micros: i64,
    pub export_charge_subtotal_amount_micros: i64,
    pub export_charge_tax_amount_micros: i64,
    pub export_charge_total_amount_micros: i64,
    pub subtotal_amount_micros: i64,
    pub tax_amount_micros: i64,
    pub total_amount_micros: i64,
    pub corrected_invoice: String,
    pub replaced_invoices: Vec<String>,
    pub pdf_url: String,
    pub account_budget_summaries: Vec<AccountBudgetSummary>,
    pub account_summaries: Vec<AccountSummary>,
}

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}

id: String

Output only. The ID of the invoice. It appears on the invoice PDF as “Invoice number”.

type: i32

Output only. The type of invoice.

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.

service_date_range: Option<DateRange>

Output only. The service period date range of this invoice. The end date is inclusive.

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.

adjustments_subtotal_amount_micros: i64

Output only. The pretax subtotal amount of invoice level adjustments, in micros.

adjustments_tax_amount_micros: i64

Output only. The sum of taxes on the invoice level adjustments, in micros.

adjustments_total_amount_micros: i64

Output only. The total amount of invoice level adjustments, in micros.

regulatory_costs_subtotal_amount_micros: i64

Output only. The pretax subtotal amount of invoice level regulatory costs, in micros.

regulatory_costs_tax_amount_micros: i64

Output only. The sum of taxes on the invoice level regulatory costs, in micros.

regulatory_costs_total_amount_micros: i64

Output only. The total amount of invoice level regulatory costs, in micros.

export_charge_subtotal_amount_micros: i64

Output only. The pretax subtotal amount of invoice level export charges, in micros.

export_charge_tax_amount_micros: i64

Output only. The sum of taxes on the invoice level export charges, in micros.

export_charge_total_amount_micros: i64

Output only. The total amount of invoice level export charges, in micros.

subtotal_amount_micros: i64

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: i64

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: i64

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}

replaced_invoices: Vec<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}

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.

account_budget_summaries: Vec<AccountBudgetSummary>

Output only. The list of summarized account budget information associated with this invoice.

account_summaries: Vec<AccountSummary>

Output only. The list of summarized account information associated with this invoice.

Implementations

impl Invoice

pub fn type(&self) -> InvoiceType

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: InvoiceType)

Sets type to the provided enum value.

Trait Implementations

impl Clone for Invoice

fn clone(&self) -> Invoice

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Invoice

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Invoice

fn default() -> Self

Returns the “default value” for a type.

impl Message for Invoice

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Invoice

fn eq(&self, other: &Invoice) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Invoice