getInvoices
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 parameters
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.
The maximum number of invoices you want to return in a single call.
Minimum: 1
Maximum: 200
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.
The response includes only the invoices that match the specified marketplace.
The marketplace-specific classification of the transaction type for which the invoice was created. Use the getInvoicesAttributes operation to check transactionType options.
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.
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.
Return invoices with the specified series number.
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.
Sort the invoices in the response in ascending or descending order.
The marketplace-specific classification of the invoice type. Use the getInvoicesAttributes operation to check invoiceType options.
A list of statuses that you can use to filter invoices. Use the getInvoicesAttributes operation to check invoice status options.
Min count: 1
Return invoices that match this external ID. This is typically the Government Invoice ID.
The attribute by which you want to sort the invoices in the response.
Response
Success.