Retrieve the financial events that make up a financial event group
Learn how to determine the amount and status of a payment.
Learn how to retrieve the financial events in a financial event group.
Prerequisites
To successfully complete this tutorial, you must have:
- Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
- 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 with the PostedAfter and PostedBefore query parameters to retrieve up to 100 financial event groups. 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
Review the response from listFinancialEventGroups to find the FinancialEventGroupId of the payment you're interested in.
Step 3. Retrieve a list of financial events for the group
Call the listFinancialEventsByGroupId operation, and specify the eventGroupId path parameter with the FinancialEventGroupId obtained in Step 2.
The response includes up to 100 financial events associated with the specified financial event group.
If the response includes a nextToken, use it to request additional pages of financial events.
Updated 2 days ago
