Request parameters for getInvoices operation in InvoicesApi.

InvoicesApiGetInvoicesRequest

interface InvoicesApiGetInvoicesRequest {
    dateEnd?: string;
    dateStart?: string;
    externalInvoiceId?: string;
    invoiceType?: string;
    marketplaceId: string;
    nextToken?: string;
    pageSize?: number;
    series?: string;
    sortBy?: "START_DATE_TIME";
    sortOrder?: GetInvoicesSortOrderEnum;
    statuses?: string[];
    transactionIdentifierId?: string;
    transactionIdentifierName?: string;
    transactionType?: string;
}

Properties

dateEnd?: string

The latest invoice creation date for invoices that you want to include in the response. Dates are in ISO 8601 date-time format. The default is the current date-time.

InvoicesApiGetInvoices

dateStart?: string

The earliest invoice creation date for invoices that you want to include in the response. Dates are in ISO 8601 date-time format. The default is 24 hours prior to the time of the request.

InvoicesApiGetInvoices

externalInvoiceId?: string

Return invoices that match this external ID. This is typically the Government Invoice ID.

InvoicesApiGetInvoices

invoiceType?: string

The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options.

InvoicesApiGetInvoices

marketplaceId: string

The response includes only the invoices that match the specified marketplace.

InvoicesApiGetInvoices

nextToken?: string

The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. 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.

InvoicesApiGetInvoices

pageSize?: number

The maximum number of invoices you want to return in a single call. Minimum: 1 Maximum: 200

InvoicesApiGetInvoices

series?: string

Return invoices with the specified series number.

InvoicesApiGetInvoices

sortBy?: "START_DATE_TIME"

The attribute by which you want to sort the invoices in the response.

InvoicesApiGetInvoices

Sort the invoices in the response in ascending or descending order.

InvoicesApiGetInvoices

statuses?: string[]

A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options. Min count: 1

InvoicesApiGetInvoices

transactionIdentifierId?: string

The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierName` field.

InvoicesApiGetInvoices

transactionIdentifierName?: string

The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierId` field.Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options.

InvoicesApiGetInvoices

transactionType?: string

The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options.

InvoicesApiGetInvoices