Reconciliation API v1 reference

Amazon Business API for Payment Reconciliation

Overview

With the Amazon Business API for Payment Reconciliation, you can build applications that help Amazon Business customers get purchase-related information for reconciling business transactions.

Version information

Version : 2021-01-08

License information

License : Amazon Software License
License URL : https://aws.amazon.com/asl/

URI scheme

Host : api.business.amazon.com
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

External Docs

Description : Learn more about Amazon Business
URL : https://business.amazon.com

Operations

getTransactions
getInvoiceDetailsByOrderLineItems

Paths

GET /reconciliation/2021-01-08/transactions

Operation: getTransactions

Description

Returns a paginated list of business transactions with feed dates that fall within the date range that you specify.

Usage Plan:

Plan typeRate (requests per second)Burst
Default.510

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation.

Parameters

TypeNameDescriptionSchema
QueryfeedStartDate
required
The lower limit for the search range.string (date-time)
QueryfeedEndDate
required
The upper limit for the search range.string (date-time)
QuerynextPageToken
optional
A page token returned in the response to your previous request. nextPageToken is returned when the number of results exceed the page size. To get the next page of results, include nextPageToken as the only parameter. When no nextPageToken value is returned there are no more pages to return.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
TransactionsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList
504A gateway timeout occurred.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList

Produces

  • application/json

POST /reconciliation/2021-01-08/invoices

Operation: getInvoiceDetailsByOrderLineItems

Description

Returns the invoice details for the order line items provided in the request.

Parameters

TypeNameDescriptionSchema
BodyinvoiceDetailsByOrderLineItemsRequest
required
The request schema for the getInvoiceDetailsByOrderLineItems operation.InvoiceDetailsByOrderLineItemsRequest

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : The allowed rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
InvoiceDetailsByOrderLineItemsResponse
400The server could not process an API request due to missing or invalid parameters. Errors may include mistyping the API endpoint, a header name or value, or a query parameter.
Headers :
x-amzn-RateLimit-Limit (string) : The allowed rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : The allowed rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RateLimit-Limit (string) : The allowed rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : The allowed rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList
429The request rate exceeded the allowed limit.
Headers :
x-amzn-RateLimit-Limit (string) : The allowed rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList
500The server encountered an unexpected condition that prevented it from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : The allowed rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList
504A gateway timeout occurred.
Headers :
x-amzn-RateLimit-Limit (string) : The allowed rate limit (requests per second) for this operation.
x-amzn-requestId (string) : Unique request reference identifier.
ErrorList

Produces

  • application/json

Definitions

Money

The monetary value.

NameDescriptionSchema
currencyCode
required
The three-digit currency code, in ISO 4217 format.string
amount
required
The currency amount.string

TransactionsResponse

The response schema for the getTransactions operation.

NameDescriptionSchema
transactions
required
A list of transactions with feed dates that fall within the specified date range.< Transaction > array
nextPageToken
required
A page token that is returned when the results of the call exceed the page size. To get another page of results, call the operation again, passing in this value with the nextPageToken parameter.string

Customer

A customer with a role in a transaction.

NameDescriptionSchema
id
required
A unique customer identifier.string
name
optional
The customer name.string
email
optional
The customer email address.string

Transaction

A business transaction.

NameDescriptionSchema
marketplaceId
optional
The identifier of the marketplace where the item was bought.string
transactionDate
optional
The date when the transaction occurred.string (date-time)
feedDate
optional
The date after which you can successfully query the transaction with the getTransactions operation.string (date-time)
transactionType
optional
The type of transaction.enum (TransactionType)
transactionId
optional
The identifier for this transaction.string
shipTaxRate
optional
The shipping tax rate for a transaction.string
giftWrapTaxRate
optional
The gift wrap tax rate for a transaction.string
legalEntityName
optional
The name of the Business Legal Entity on behalf of which the order was placed.string
purchasingCustomerGroupName
optional
The name of the department under the Legal Entity on behalf of which the order was placedstring
amount
optional
The amount charged for a specific transaction. If the amount is not settled yet, this is the amount for which Amazon received an authorization.Money
paymentInstrumentType
optional
The type of payment instrument, such as a credit card, pay by invoice, a bank account, a reward account, etc.string
paymentInstrumentLast4Digits
optional
The last 4 digits of the payment instrument number.string
buyer
optional
The customer account on behalf of which the order was placed.Customer
payer
optional
The customer account that owns the payment instrument with which the order was paid.Customer
associatedTransactionDetails
optional
A list of transaction details that are associated with this transaction. For example, if a payment is made with three different transactions (each using a different payment instrument), this list will contain associatedTransactionId values for the two other transactions associated with this transaction.< AssociatedTransactionDetail > array
transactionLineItems
optional
A list of transaction line items.< TransactionLineItem > array

TransactionLineItem

A transaction line item.

NameDescriptionSchema
refundReason
optional
The reason why a refund was issued.string
totalAmount
optional
The total amount charged for the item. This is the principalAmount plus or minus any additional charges or credits.Money
principalAmount
optional
The amount charged for the item, before applying any additional charges or credits.Money
shippingCharge
optional
The shipping charge for the item.Money
regulatoryFee
optional
The regulatory fee charged on the item.Money
giftWrappingCharge
optional
The gift wrapping charge for the item.Money
discount
optional
The discount applied to the item.Money
tax
optional
The tax charged on the item.Money
unitPrice
optional
The price per unit of the item.Money
taxRate
optional
The tax rate associated with item.string
orderId
optional
The Amazon order identifier associated with the item.string
unspsc
optional
United Nations Standard Products and Services Code for the item.string
orderLineItemId
optional
The order line item identifier for the item. This identifier is created by Amazonstring
purchaseOrderNumber
optional
The purchase order number associated with the item of a PPI order. This number is created by the buyer.string
purchaseOrderLineItemId
optional
The purchase order line item identifier associated with the item. This identifier is created by the buyer.string
asin
optional
The Amazon Standard Identification Number (ASIN) for the item.string
productTitle
optional
The title of the item.string
itemQuantity
optional
The item quantity relevant to this transaction.integer
shipmentId
optional
The identifier of the shipment associated with the item. This identifier is created by Amazon.string
shipmentDate
optional
The shipment date associated with the item.string (date-time)
merchantLegalName
optional
The legal name of the seller.string
budgetId
optional
The budget identifier associated with the item.string
businessOrderInfo
optional
Additional order information configured by administrators that requisitioners must enter at checkout.< string, string > map

AssociatedTransactionDetail

A transaction detail that is associated with this transaction.

NameDescriptionSchema
associatedTransactionId
required
The identifier for an associated transaction.string

InvoiceDetailsByOrderLineItemsRequest

The request schema for the getInvoiceDetailsByOrderLineItems operation.

NameDescriptionSchema
orderLineItems
required
List of order line items for the requested invoice details. The maximum number of order line items listed in each call is 25.< OrderLineItem > array

InvoiceDetailsByOrderLineItemsResponse

The response schema for the getInvoiceDetailsByOrderLineItems operation

NameDescriptionSchema
invoiceDetailsByOrderLineItems
required
Lists the invoices that includes order line item and invoice details.< InvoiceDetailsOfOrderLineItem > array

InvoiceDetailsOfOrderLineItem

Invoice details with the corresponding order line item.

NameDescriptionSchema
orderLineItem
optional
The Order line item to which the invoice details are associated to.OrderLineItem
invoiceDetails
optional
List of invoice detail for all invoices related to the order line item.< InvoiceDetail > array

InvoiceDetail

The detailed information of an invoice.

NameDescriptionSchema
invoiceNumber
required
The invoice number associated with the invoiceDetail.string
invoiceDate
required
The date and time an invoice was issued.string (date-time)

OrderLineItem

The identifiers for the order line item.

NameDescriptionSchema
orderId
required
Amazon-generated order identifier associated with the orderLineItem.string
orderLineItemId
required
Amazon-generated item identifier associated with the orderLineItem..string
shipmentId
required
Amazon-generated shipment ID associated with the orderLineItem.string

ErrorList

A list of error responses for an unsuccessful request.

NameSchema
errors
required
< Error > array

Error

Error response returned when the request is unsuccessful.

NameDescriptionSchema
code
required
An error code that identifies the type of error that occurred.string
message
required
A message that describes the error condition.string
details
optional
Additional details that can help the caller understand or fix the issue.string

TransactionType

The type of transaction.

Type : enum

ValueDescription
CHARGEPositive transaction amount.
REFUNDNegative transaction amount.
OVERREFUNDAdditional refund.