Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...

    Interface InvoiceHeader

    Represents the header-level information for an invoice, including parties involved (payer/payee), financial amounts, status, dates, and related business identifiers.

    interface InvoiceHeader {
        billingPeriod?: BillingPeriod;
        creationDate: string;
        dueDate?: string;
        invoiceAmount: Currency;
        invoiceAmountBreakdowns?: Breakdown[];
        invoiceIdentifier: string;
        invoiceNumber: string;
        invoiceSettlementBreakdowns?: Breakdown[];
        invoiceStatus: InvoiceHeaderInvoiceStatusEnum;
        invoiceType: InvoiceHeaderInvoiceTypeEnum;
        issueDate: string;
        lastUpdatedDate: string;
        payee: PartnerMetadata;
        payer: PartnerMetadata;
        paymentTerms?: string;
        relatedIdentifiers?: RelatedIdentifier[];
    }
    Index
    billingPeriod? creationDate dueDate? invoiceAmount invoiceAmountBreakdowns? invoiceIdentifier invoiceNumber invoiceSettlementBreakdowns? invoiceStatus invoiceType issueDate lastUpdatedDate payee payer paymentTerms? relatedIdentifiers?
    billingPeriod?: BillingPeriod
    creationDate: string

    When the invoice was created. In ISO 8601 format.

    dueDate?: string

    The due date of the invoice. In ISO 8601 format.

    invoiceAmount: Currency
    invoiceAmountBreakdowns?: Breakdown[]

    The breakdown of the invoice amount into sub-components. Possible breakdownType values: * Total: Total invoice amount. * InvoiceAmountWithoutTax: Invoice amount excluding tax. * TaxAmount: Tax amount on the invoice. * MiscCharges: Miscellaneous charges on the invoice. * Other: Other breakdown type.

    invoiceIdentifier: string

    The unique identifier for an invoice. For AP-Inventory invoices, this is formatted as InvoiceNumber~PayeeCode. This field can be used as an input to the getInvoice operation to fetch invoice details.

    invoiceNumber: string

    The invoice number provided when the invoice was created.

    invoiceSettlementBreakdowns?: Breakdown[]

    The breakdown of the invoice settlement amount into sub-components. Possible breakdownType values: * AmountPaid: Amount that has been paid. * QueuedForPayment: Amount queued for payment. * QuickPayDiscount: Quick pay discount amount. * QuantityVarianceAmount: Quantity variance amount. * PriceVariance: Price variance amount. * Other: Other settlement breakdown type.

    invoiceStatus: InvoiceHeaderInvoiceStatusEnum

    The current state of the invoice.

    invoiceType: InvoiceHeaderInvoiceTypeEnum

    The type of invoice.

    issueDate: string

    When the invoice was issued. In ISO 8601 format.

    lastUpdatedDate: string

    When the invoice was last updated. In ISO 8601 format.

    payee: PartnerMetadata
    payer: PartnerMetadata
    paymentTerms?: string

    Payment terms associated with the invoice.

    relatedIdentifiers?: RelatedIdentifier[]

    A list of related business identifiers associated with the invoice.

    Settings
    Member Visibility

    On This Page
    Properties