Reconciliation API overview
What is Reconciliation API?
Reconciliation API provides line item-level reporting to help with reconciliation. This API helps you retrieve Amazon Business purchase information at the transaction level based on the payment method associated with each purchase. Through a one-time integration, you can easily keep track of organizational spend by different payment methods, such as Pay by Invoice (PBI) or credit card, and eliminate manual auditing and record keeping.
Benefits of Reconciliation API
Reconciliation API provides the following benefits:
Save time on reconciliation
Reconciliation API offers an automated solution to streamline Amazon Business purchase reconciliation by delivering detailed transaction data across multiple time periods. It eliminates the need for manually gathering information from the Amazon Business website or inputting data into third-party expense and accounting software.
Improve visibility
With a one-time integration and a few simple activation steps within third-party systems, Reconciliation API enables transaction data to flow directly into your accounting and expense management systems. With this data, you can choose to receive additional line-item details beyond the standard Level 3 data options.
Increase accuracy with line-item details
Reconciliation API provides access to dozens of data fields for both purchases and refunds, including key transaction details such as payment method and the last four digits of the credit card used. This flexibility allows integrators and customers to tailor the data to their specific reconciliation workflows. Additionally, the API returns invoice IDs and invoice dates, making it easier to match transactions with corresponding invoices.
How Reconciliation API works
You can retrieve business transaction and invoice details by sending a request to Reconciliation API.
Operations
Reconciliation API provides the following operations:
Operation | Method | Path | Description |
---|---|---|---|
getTransactions | GET | /reconciliation/2021-01-08/transactions | Returns a paginated list of business transactions with feed dates that fall within the date range that you specify. |
getInvoiceDetailsByOrderLineItems | POST | /reconciliation/2021-01-08/invoices | 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. |
A successful request to the getTransactions
operation returns an array of business transaction details, including the transaction type, ID, and transaction line items. The getInvoiceDetailsByOrderLineItems
operation returns the invoice number and ID associated with the transaction.
Onboarding to Reconciliation API
Complete these steps to access Reconciliation API:
- Complete the API onboarding process to register as a developer, create an app client, and retrieve API access and refresh tokens. For more information, see Onboarding overview.
- Gain access to the Business Purchase Reconciliation role. For more information, see Amazon Business API roles.
Once you’ve completed these steps, follow these guides to start calling the API:
Updated about 1 month ago