getInvoices

Pending

GET

/tax/invoices/2024-06-19/invoices

Last modified:2024-12-03 05:35:55

Maintainer:Sarath S

Returns invoice details for the invoices that match the filters that you specify.

Usage Plan:

Rate (requests per second)	Burst
0.1	20

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Request

Query Params

transactionIdentifierName

string

optional

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.

Example:

BUSINESS_TRANSACTION_ID

pageSize

integer

optional

The maximum number of invoices you want to return in a single call.

Minimum: 1

Maximum: 200

Example:

dateEnd

string <date-time>

optional

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.

Example:

2024-07-20T23:59:59

marketplaceId

string

required

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

Example:

A2Q3Y263D00KWC

transactionType

string

optional

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

Example:

CUSTOMER_SALES

transactionIdentifierId

string

optional

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.

Example:

94cd4e1a-5cc5-486d-b592-045a95a168e1

dateStart

string <date-time>

optional

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.

Example:

2024-07-01T00:00:00

series

string

optional

Return invoices with the specified series number.

nextToken

string

optional

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.

sortOrder

enum<string>

optional

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

Allowed values:

DESCASC

Example:

DESC

invoiceType

string

optional

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

Example:

SYMBOLIC_RETURN

statuses

array[string]

optional

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

Min count: 1

>= 1 items

Example:

[""]

externalInvoiceId

string

optional

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

sortBy

enum<string>

optional

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

Allowed value:

START_DATE_TIME

Example:

START_DATE_TIME

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://sandbox.sellingpartnerapi-na.amazon.com/tax/invoices/2024-06-19/invoices?transactionIdentifierName=BUSINESS_TRANSACTION_ID&pageSize=1&dateEnd=2024-07-20T23:59:59&marketplaceId=A2Q3Y263D00KWC&transactionType=CUSTOMER_SALES&transactionIdentifierId=94cd4e1a-5cc5-486d-b592-045a95a168e1&dateStart=2024-07-01T00:00:00&series&nextToken=&sortOrder=DESC&invoiceType=SYMBOLIC_RETURN&statuses=&externalInvoiceId&sortBy=START_DATE_TIME'

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

Success.

invoices

array[object (Invoice) {10}]

optional

A list of invoices.

<= 100 items

date

string <date-time>

optional

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

errorCode

string

optional

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

externalInvoiceId

string

optional

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

govResponse

string

optional

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

string

optional

The invoice identifier.

invoiceType

string

optional

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

series

string

optional

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

status

string

optional

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

transactionIds

array[object (TransactionIdentifier) {2}]

optional

List with identifiers for the transactions associated to the invoice.

transactionType

string

optional

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

nextToken

string

optional

This token is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getInvoices operation and include this token with the previous call parameters.

Example

{
    "invoices": [
        {
            "date": "2019-08-24T14:15:22Z",
            "errorCode": "string",
            "externalInvoiceId": "string",
            "govResponse": "string",
            "id": "string",
            "invoiceType": "string",
            "series": "string",
            "status": "string",
            "transactionIds": [
                {
                    "name": "string",
                    "id": "string"
                }
            ],
            "transactionType": "string"
        }
    ],
    "nextToken": "string"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Modified at 2024-12-03 05:35:55

getInvoicesExport

getInvoice