Finances API v2024-06-19 Use Case Guide

The Selling Partner API for Finances (Finances API) provides financial information that is relevant to a seller's business. You can obtain financial events for a specified order or date range without having to wait until a statement period closes. Refer to the Finances API Reference for details about the operations and associated data types in the Finances API.

Key features

• Retrieve transactions by time and marketplace. Filter transactions by a range of dates, a marketplace, or both.

Tutorial: Get the latest transactions

Learn how to review transactions on a Seller's account.

Prerequisites

To complete this tutorial, you must have:

• Authorization from the selling partner for whom you are making calls. Refer to the Authorizing Selling Partner API applications for more information.
• Approval for the Finance and Accounting role in your developer profile.
• The Finance and Accounting role selected on the App registration page for your application.

Step 1. Retrieve a list of transactions

Call the listTransactions operation to retrieve up to 500 transactions at a time. If there are more transactions available, you can retrieve them with the provided nextToken.

🚧

Caution

The response will include transactions with statuses RELEASED, DEFERRED, and DEFERRED_RELEASED. If you want only those transactions that are processed for payments in the next settlement group, you must filter for transactions where the transactionStatus is RELEASED.

Tutorial: Determine which transactions make up a payment

Learn how to determine which transactions make up a payment.

Prerequisites

To complete this tutorial, you must have:

• Authorization from the selling partner for whom you are making calls. Refer to the Authorizing Selling Partner API applications for more information.
• Approval for the Finance and Accounting role in your developer profile.
• The Finance and Accounting role selected in the App registration page for your application.

Step 1. Retrieve a list of financial event groups

Call the listFinancialEventGroups operation of the Finances API v0 to retrieve up to 100 financial event groups at a time. If there are more groups available, you can retrieve them with the provided nextToken.

Step 2. Find the financial event group ID of the payment

Examine the response to listFinancialEventGroups to find the FinancialEventGroupId of the payment you're interested in.

Step 3. Retrieve a list of released transactions

Call the listTransactions operation. If there are more transactions available, you can retrieve them with the provided nextToken.

Select the result transactions where the transactionStatus value is RELEASED.

Step 4. Review the transactions that have matching identifiers

The response to listTransactions contains the transactions array. For each transaction in this array, examine the elements of the relatedIdentifiers array. For each relatedIdentifier, if the relatedIdentifierName is EVENT_GROUP_ID, check if the relatedIdentifierValue matches the FinancialEventGroupId obtained in Step 2. Find the financial event group ID of the payment. If it does, then this transaction is part of the payment.