getInvoice

Tested

GET

/tax/invoices/2024-06-19/invoices/{invoiceId}

invoices

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

Maintainer:Sarath S

Returns invoice data for the specified invoice. This operation returns only a subset of the invoices data; refer to the response definition to get all the possible attributes.
To get the full invoice, use the createInvoicesExport operation to start an export request.

Usage Plan:

Rate (requests per second)	Burst
2	15

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

Path Params

invoiceId

string

required

The invoice identifier.

Example:

ad5b9dcd-6981-4dc4-a3d7-dd2568298a94

Query Params

marketplaceId

string

required

The marketplace from which you want the invoice.

Example:

A2Q3Y263D00KWC

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/ad5b9dcd-6981-4dc4-a3d7-dd2568298a94?marketplaceId=A2Q3Y263D00KWC'

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.

invoice

object (Invoice)

optional

Provides detailed information about an invoice.

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.

Example

{
    "invoice": {
        "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"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

getInvoices

getListingsRestrictions