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. This API fetches transactions from all legal entities under the account.

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 type	Rate (requests per second)	Burst
Default	.5	10

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

Parameters

Type	Name	Description	Schema
Query	feedStartDate required	The lower limit for the search range.	string (date-time)
Query	feedEndDate required	The upper limit for the search range.	string (date-time)
Query	nextPageToken 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 Code	Description	Schema
200	Success. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string) : Unique request reference identifier.	TransactionsResponse
400	Request 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
401	The 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
403	Indicates 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
404	The 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
429	The 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
500	An 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
504	A 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 data for the order line items provided in the request. In NA and EU, this operation returns the invoice ID. In JP, this operation returns additional invoice details.

Parameters

Type	Name	Description	Schema
Body	invoiceDetailsByOrderLineItemsRequest required	The request schema for the getInvoiceDetailsByOrderLineItems operation.	InvoiceDetailsByOrderLineItemsRequest

Responses

HTTP Code	Description	Schema
200	Success. 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
400	The 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
401	The 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
403	Indicates 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
404	The 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
429	The 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
500	The 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
504	A 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.

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
id required	A unique customer identifier.	string
name optional	The customer name.	string
email optional	The customer email address.	string

Transaction

A business transaction.

Name	Description	Schema
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 placed	string
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.

Name	Description	Schema
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 Amazon	string
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.

Name	Description	Schema
associatedTransactionId required	The identifier for an associated transaction.	string

InvoiceDetailsByOrderLineItemsRequest

The request schema for the getInvoiceDetailsByOrderLineItems operation.

Name	Description	Schema
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.

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

InvoiceDetailsOfOrderLineItem

Invoice details with the corresponding order line item.

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

InvoiceDetail

The detailed information of an invoice.

Name	Description	Schema
invoiceNumber required	The ID number of the Invoice or Credit Memo.	string
invoiceDate required	The date the Invoice or Credit Memo was issued.	string (date-time)
consolidatedInvoiceDetails optional	This contains the consolidated invoice details if the order is enabled for purchase/periodic consolidation.	ConsolidatedInvoiceDetails
invoiceType optional	Indicate that the data returned is Invoice or Credit Memo. Possible values: STANDARD (for Invoice) and CREDIT_MEMO (for Credit Memo). Available for JP region only.	InvoiceType
associatedInvoiceNumber optional	The invoice number associated with the Credit Memo. This field shows value if the invoiceType is CREDIT_MEMO. For STANDARD invoice, this field shows "null". Available for JP region only.	string
associatedInvoiceDate optional	The invoice date associated with the Credit Memo. This field shows value if the invoiceType is CREDIT_MEMO. For STANDARD invoice, this field shows "null". Available for JP region only.	string (date-time)
invoiceIssuer optional	The details associated with the issuer of the invoice. Available for JP region only.	InvoiceIssuerDetail
billToAddress optional	The address information to which the Invoice or Credit Memo was issued. Available for JP region only.	PhysicalAddress
sellerInformation optional	The details associated with the original seller of the products. Available for JP region only.	MerchantDetail
orderDate optional	The date and time the order was placed. The date follows the ISO 8601 format, yyyy-MM-ddThh:mm:ssZ. Available for JP region only.	string (date-time)
currencyCode optional	The three-digit currency code, in ISO 4217 format. Available for JP region only.	string
invoiceTotal optional	Sum of all charges specified in the invoice, including products, applicable taxes, and any additional fees. Available for JP region only.	string
tax optional	The tax amount and rate the buyer pays for the product and services. Available for JP region only.	< TaxDetail > array
transactionDataItems optional	The invoice line item details including ASIN, price, unit, discount, and fee. Available for JP region only.	< TransactionDataItem > array
fees optional	The invoice level fee the buyer pays for the product and services. Available for JP region only.	< InvoiceLevelFeeDetail > array

ConsolidatedInvoiceDetails

This contains the consolidated invoice details if the order is enabled for purchase/periodic consolidation.

Name	Description	Schema
invoiceNumber required	The consolidation invoice ID for the order if document is ready. If not, then it will return "Pending". If invoice consolidation is not applicable, it returns null.	string

TransactionDataItem

Contains the required information associated with a specific product or service.

Name	Description	Schema
taxRate required	The tax percentage applied on products and services.	string
unit required	The number of units ordered.	integer
asin required	The Amazon Standard Identification Number (ASIN) for the item.	string
title required	The title of the item.	string
unitTaxInclusivePrice required	The unit price of the product including taxes.	Money
unitTaxExclusivePrice required	The unit price of the product excluding taxes.	Money
unitTaxAmount required	A taxable amount for each unit of a product.	Money
totalAmount required	Includes the price of all units of the product, discounts, and the total tax amounts.	Money
discount required	The discount amount or rate applied on products and services.	Money
apportionment required	Contains amount distribution data associated with each line item.	< LineItemApportionmentDetail > array
fees required	The fees associated with line item in the invoice.	< LineItemLevelFeeDetail > array

InvoiceType

The type of invoice, STANDARD or CREDIT_MEMO.

Type : enum

Value	Description
STANDARD	A standard invoice is a simple document that is used for billing products or services provided.
CREDIT_MEMO	A credit memo invoice is a simple document that is used for refunds on products or services provided.

InvoiceIssuerDetail

Provides details associated with the issuer of the invoice.

Name	Description	Schema
name required	The name of the issuer.	string
registrationNumber required	The tax registration number associated with the issuer of the invoice. For Japan, this is the Japan Consumption Tax number (JCT#).	string

MerchantDetail

Provides details associated with the merchant selling the products.

Name	Description	Schema
name required	The name of the seller.	string
registrationNumber required	The tax registration number (JCT#).	string

TaxDetail

Details the information to show the total tax rate.

Name	Description	Schema
rate required	The tax rate.	string
inclusiveTotal required	The tax-inclusive total against the associated tax rate.	Money
exclusiveTotal required	The tax-exclusive total against the associated tax rate.	Money
amount required	The tax total amount against the associated tax rate.	Money

LineItemLevelFeeDetail

The fee details associated with an order line item.

Name	Description	Schema
feeType required	The type of fee that was calculated and added to the total cost. The type of fees include shipping, gift wrapping, and cash on delivery.	FeeType
tax required	The tax amount added to the total cost.	TaxDetail
discount required	The discount amount or rate deducted from the total cost.	Money
apportionment required	Provides details about the tax rate and amount associated with the type of fee at the line item level.	< LineItemLevelFeeApportionmentDetail > array

InvoiceLevelFeeDetail

The fee details associated with an invoice.

Name	Description	Schema
feeType required	The type of fee that was calculated and added to the total cost. The type of fees include shipping, gift wrapping, and cash on delivery.	FeeType
tax required	The tax amount added to the total cost.	TaxDetail
discount required	The discount amount or rate deducted from the total cost.	Money
apportionment required	The distribution of tax data across multiple tax rate associated with the fee.	< InvoiceLevelFeeApportionmentDetail > array

FeeType

Additional fees that Amazon Business charge based on the customer's selection.

Type : enum

Value	Description
SHIPPING	The cost of shipping an item or order.
GIFTWRAPPING	The cost of gift wrapping an item or order.
OTHER	The cost of other fee for an item or order.

LineItemLevelFeeApportionmentDetail

Details the tax rate and amount associated with the type of fee at line item level.

Name	Description	Schema
associatedOrderLineItemId required	The order line item identifier for the item. This identifier is created by Amazon Business.	string
units required	The quantity of the product with similar fee.	integer
unitTaxExclusiveFee required	A tax exclusive fee associated with the fee for consideration.	Money
unitTaxAmount required	The tax amount associated with the fee.	Money

InvoiceLevelFeeApportionmentDetail

Details the tax rate and amount associated with the type of fee at invoice level.

Name	Description	Schema
taxExclusiveFee required	A tax exclusive fee associated with the fee for consideration.	Money
taxAmount required	The tax amount associated with the fee.	Money

LineItemApportionmentDetail

Details the tax rate and amount associated with the line item.

Name	Description	Schema
orderLineItemId required	The order line item identifier for the item. This identifier is created by Amazon Business.	string
lineNumber required	Sequence number in apportionment data.	integer
units required	The quantity of the product with similar unit price.	integer
unitPrice required	The price of a unit of the product.	Money
taxAmount required	The total tax amount for the product.	Money

OrderLineItem

The identifiers for the order line item.

Name	Description	Schema
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

PhysicalAddress

A detailed physical address.

Name	Description	Schema
fullName required	The full name of the customer associated with the address. minLength : 1	string
phoneNumber required	The phone number of the customer associated with the address. minLength : 1	string
companyName optional	The company name of the customer associated with the address.	string
addressLine1 required	The primary address of the customer with the street name, building number, city, state, and postal code. minLength : 1	string
addressLine2 optional	The secondary address of the customer with the street name, building number, city, state, and postal code.	string
city required	The city associated with the customer's address. minLength : 1	string
stateOrRegion required	The state associated with the customer's address. minLength : 1	string
postalCode required	The postal code associated with the customer's address. minLength : 1	string
countryCode required	The country code associated with the customer's address in ISO 3166 alpha-2 (2-char) format. Pattern : `"^[A-Z]{2}$"`	string

ErrorList

A list of error responses for an unsuccessful request.

Name	Schema
errors required	< Error > array

Error

Error response returned when the request is unsuccessful.

Name	Description	Schema
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

Value	Description
CHARGE	Positive transaction amount.
REFUND	Negative transaction amount.
OVERREFUND	Additional refund.