getInvoices

北美(North America）

https://sellingpartnerapi-na.amazon.com

GET

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

Invoices.

返回与您指定的过滤器匹配的发票的发票详细信息。

使用计划：

速率（每秒请求）	突发
0.1	20

响应头x-amzn-RateLimit-Limit返回适用于请求操作的使用计划速率限制（如果可用）。前面的表格指示了此操作的默认速率和突发值。对业务需求要求更高的销售合作伙伴，其速率和突发值可能高于此处显示的值。有关更多信息，请参阅销售合作伙伴API中的使用计划和速率限制。

请求参数

Query 参数

transactionIdentifierName

string

可选

交易标识符过滤器的名称。如果您为该字段提供了值，则必须为 transactionIdentifierId 字段提供值。使用 getInvoicesAttributes 操作检查 transactionIdentifierName 选项。

pageSize

integer

可选

您希望在一次调用中返回的最大发票数量。

最小值：1

最大值：200

dateEnd

string <date-time>

可选

您想要包含在响应中的发票的最新发票创建日期。日期采用ISO 8601 日期时间格式。默认值为当前日期时间。

marketplaceId

string

必需

响应仅包含与指定市场匹配的发票。

transactionType

string

可选

为发票创建的交易类型的市场特定分类。使用 getInvoicesAttributes 操作来检查 transactionType 选项。

transactionIdentifierId

string

可选

事务标识符过滤器的 ID。如果提供此字段的值，您必须同时提供 transactionIdentifierName 字段的值。

dateStart

string <date-time>

可选

要包含在响应中的发票的最早发票创建日期。日期采用 ISO 8601 日期时间格式。默认值为请求时间的前24小时。

series

string

可选

退回带有指定系列号的发票。

nextToken

string

可选

当结果数量超过指定的 pageSize 值时，响应将包括 nextToken。要获取下一页结果，请使用此令牌调用该操作，并包含与生成该令牌的调用相同的参数。要获取完整列表，需持续调用此操作直到 nextToken 为 null。请注意，此操作可能会返回空页面。

sortOrder

enum<string>

可选

根据响应中的发票按升序或降序排序。

枚举值:

DESCASC

invoiceType

string

可选

市场特定的发票类型分类。使用 getInvoicesAttributes 操作检查 invoiceType 选项。

statuses

array[string]

可选

可用于筛选发票的状态列表。使用 getInvoicesAttributes 操作来检查发票状态选项。

最小计数：1

>= 1 items

externalInvoiceId

string

可选

返回与此外部ID匹配的发票。这通常是政府发票ID。

sortBy

enum<string>

可选

您希望在响应中对发票进行排序的属性。

枚举值:

START_DATE_TIME

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://sellingpartnerapi-na.amazon.com/tax/invoices/2024-06-19/invoices?marketplaceId'

返回响应

🟢200成功。

application/json

Body

成功。

invoices

array[object (Invoice) {10}]

发票清单。

可选

<= 100 items

date

string <date-time>

可选

发票发出的日期和时间。值采用ISO 8601 日期时间格式。

errorCode

string

可选

如果发票处于错误状态，则此属性显示错误代码。

externalInvoiceId

string

可选

外部机构使用的发票标识符。通常是授权该发票的政府机构。

govResponse

string

可选

政府部门在发票开具过程中出现错误时的响应消息。

string

可选

与本文件中定义的费用相关的唯一编号。如果文件类型为发票，则此编号将是发票号码；如果文件类型为贷项通知书，则此编号将是贷项通知书编号。未提供此参考将导致拒绝。

invoiceType

string

识别发票的类型。

可选

series

string

可选

使用此标识符与 externalInvoiceId 结合，以识别来自同一卖家的发票。

status

string

可选

发票状态分类。使用 getInvoicesAttributes 操作检查发票状态选项。

transactionIds

array[object (TransactionIdentifier) {2}]

可选

与发票相关的交易标识符列表。

transactionType

string

可选

发起此发票的交易分类。使用getInvoicesAttributes操作检查transactionType选项。

nextToken

string

可选

此令牌在结果数量超过指定的 pageSize 值时返回。要获取下一页结果，请调用 getInvoices 操作，并在之前的调用参数中包含此令牌。

示例

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

🟠400请求缺少或无效的参数，无法解析。

🟠401请求失败时返回的错误响应列表。

🟠403表示禁止访问该资源。可能的原因包括访问被拒绝、未经授权、令牌过期或签名无效。

🟠404指定的资源不存在。

🟠413请求大小超过了最大接受大小。

🟠415请求负载格式不受支持。

🟠429请求的频率超过了允许的范围。

🔴500发生了意外情况，导致服务器无法完成请求。

🔴503服务器的临时超载或维护。

getInvoicesExport

getInvoice