Function FinancesInvoicesApiFp

Returns {
    getInvoice(
        marketplaceId: string,
        invoiceIdentifier: string,
        nextTokenForLineItems?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoiceResponse>,
    >;
    getInvoiceHeaders(
        marketplaceId: string,
        nextToken?: string,
        fromIssueDate?: string,
        toIssueDate?: string,
        invoicesModifiedAfter?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesResponse>,
    >;
}

• getInvoice: function

  • getInvoice(
        marketplaceId: string,
        invoiceIdentifier: string,
        nextTokenForLineItems?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoiceResponse>,
    >

    Returns invoice details, including header and line items, for the specified invoice.

    Parameters

    • marketplaceId: string

      The marketplace ID of the marketplace of the invoice. The marketplace ID is a globally unique identifier used to specify an Amazon marketplace. For more information, refer to Marketplace IDs.

    • invoiceIdentifier: string

      The unique identifier for an invoice. This field is also returned as part of the `InvoiceHeader` element in the response. For AP-Inventory invoices the identifier is formatted as `InvoiceNumber~PayeeCode`.

    • OptionalnextTokenForLineItems: string

      The response includes `nextTokenForLineItems` when the number of line items exceeds the default page size (600). To get the next page of line items, call the operation with this token, including the same request parameters as the call that generated the token.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoiceResponse>,
    >

    Throws

• getInvoiceHeaders: function

  • getInvoiceHeaders(
        marketplaceId: string,
        nextToken?: string,
        fromIssueDate?: string,
        toIssueDate?: string,
        invoicesModifiedAfter?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesResponse>,
    >

    Returns invoice headers for all invoices matching filters that you specify.

    Parameters

    • marketplaceId: string

      The marketplace ID of the marketplace from which you want to retrieve invoice headers. The marketplace ID is a globally unique identifier used to specify which Amazon marketplace a request is targeting. For more information, refer to Marketplace IDs.

    • OptionalnextToken: string

      The response includes `nextToken` when the number of invoices exceeds the default page size value (100). To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is `null`. Note that this operation can return empty pages.

    • OptionalfromIssueDate: string

      Retrieve invoice headers issued after this date. The range between `fromIssueDate` and `toIssueDate` must not exceed 90 days. Either provide both dates or leave both empty. If you do not provide these dates, `fromIssueDate` defaults to 90 days before the date of the request. In ISO 8601 date-time format.

    • OptionaltoIssueDate: string

      Retrieve invoice headers issued before this date. The range between `fromIssueDate` and `toIssueDate` must not exceed 90 days. Either provide both dates or leave both empty. If you do not provide these dates, `toIssueDate` defaults to the date of the request. In ISO 8601 date-time format.

    • OptionalinvoicesModifiedAfter: string

      Retrieve invoices that were modified after this date-time. In ISO 8601 date-time format.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesResponse>,
    >

    Throws