Provides detailed information about an invoice.

Invoice

interface Invoice {
    date?: string;
    errorCode?: string;
    externalInvoiceId?: string;
    govResponse?: string;
    id?: string;
    invoiceType?: string;
    series?: string;
    status?: string;
    transactionIds?: TransactionIdentifier[];
    transactionType?: string;
}

Properties

date?: string

The date and time the invoice is issued. Values are in ISO 8601 date-time format.

Invoice

errorCode?: string

If the invoice is in an error state, this attribute displays the error code.

Invoice

externalInvoiceId?: string

The invoice identifier that is used by an external party. This is typically the government agency that authorized the invoice.

Invoice

govResponse?: string

The response message from the government authority when there is an error during invoice issuance.

Invoice

id?: string

The invoice identifier.

Invoice

invoiceType?: string

The classification of the invoice type. This varies across marketplaces. Use the getInvoicesAttributes operation to check invoiceType options.

Invoice

series?: string

Use this identifier in conjunction with externalInvoiceId to identify invoices from the same seller.

Invoice

status?: string

The invoice status classification. Use the getInvoicesAttributes operation to check invoice status options.

Invoice

transactionIds?: TransactionIdentifier[]

List with identifiers for the transactions associated to the invoice.

Invoice

transactionType?: string

Classification of the transaction that originated this invoice. Use the getInvoicesAttributes operation to check transactionType options.

Invoice