getInvoices

get https://sellingpartnerapi-na.amazon.com/tax/invoices/2024-06-19/invoices

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.

Query Params

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.

pageSize

integer

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

Minimum: 1

Maximum: 200

dateEnd

date-time

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.

marketplaceId

string

required

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

transactionType

string

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

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.

dateStart

date-time

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.

series

string

Return invoices with the specified series number.

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.

sortOrder

string

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

invoiceType

string

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

statuses

array of strings

length ≥ 1

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

Min count: 1

statuses

externalInvoiceId

string

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

sortBy

string

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

200

Success.

Response body

object

invoices

array of objects

length ≤ 100

A list of invoices.

invoices

object

date

date-time

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

errorCode

string

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

externalInvoiceId

string

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

govResponse

string

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

string

The invoice identifier.

invoiceType

string

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

series

string

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

status

string

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

transactionIds

array of objects

List with identifiers for the transactions associated to the invoice.

transactionIds

object

name

string

The transaction identifier name. Use the getInvoicesAttributes operation to check transactionIdentifierName options.

string

The transaction identifier.

transactionType

string

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

nextToken

string

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.

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

400

Request has missing or invalid parameters and cannot be parsed.

401

A list of error responses returned when a request is unsuccessful.

403

Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404

The resource specified does not exist.

413

The request size exceeded the maximum accepted size.

415

The request payload is in an unsupported format.

429

The frequency of requests was greater than allowed.

500

An unexpected condition occurred that prevented the server from fulfilling the request.

503

Temporary overloading or maintenance of the server.

xxxxxxxxxx
 
{
  "invoices": [
    {
      "date": "2025-04-01T15:12:58.717Z",
      "errorCode": "string",
      "externalInvoiceId": "string",
      "govResponse": "string",
      "id": "string",
      "invoiceType": "string",
      "series": "string",
      "status": "string",
      "transactionIds": [
        {
          "name": "string",
          "id": "string"
        }
      ],
      "transactionType": "string"
    }
  ],
  "nextToken": "string"
}

200Success.

400Request has missing or invalid parameters and cannot be parsed.

401A list of error responses returned when a request is unsuccessful.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.