Returning a list of sales summaries
Learn how to return a list of sales summaries.
Setting sales summary query parameters
Parameter | Optional/Required | Description |
---|---|---|
createdTime | Optional | A filter on the list based on the createdTime field. The value can be a string with an ISO-601 UTC format datetime, or it can be a dictionary with the following options:
|
endingBefore | Optional | A cursor for use in pagination. The |
startingAfter | Optional | A cursor for use in pagination. The |
limit | Optional | A limit on the number of objects returned. The limit can range between 1 and 100, and the default is 10. |
ids | Optional | Only return objects with these identifiers. |
salesClosingTime | Optional | A filter on the list based on the sales summary
|
paid | Optional | Only return sales summaries that have been paid. |
payoutId | Optional | Only return sales summaries with this payout identifier. |
currency | Optional | Only return sales summaries in this currency. |
amount | Optional | A filter on the list based on the sales summaries
|
payerId | Optional | Only return sales summaries with this payer identifier. |
payerName | Optional | Only return sales summaries with this payer name. |
payeeId | Optional | Only return sales summaries with this payee identifier. |
payeeName | Optional | Only return sales summaries with this payee name. |
Example get request and response
Retrieve the details of sales summaries with a GET
request:
A 200 OK
response returns an array of Sales Summary objects:
Key sales summaries attributes
The following information provides details on the key attributes returned in response to a request for sales summaries information. For a complete list, refer to the Sales summaries API reference.
id
A unique identifier for the sales summary.
createdTime
The time at which the sales summary was created in the reporting environment
salesClosingTime
The end date of that sales summary time frame is defined in the reporting environment.
currency
The three-letter ISO currency code represents the currency used in sales summary reporting.
amount
Represents the total sales summary amount reported in the requested currency.
payoutTransactionId
A unique identifier for a payout associated with the specific sales summary. Sales summaries are initially created without a payoutId
. The value is updated when the sales summary is paid.
payoutId
A unique identifier for a payout associated with the specific sales summary. Sales summaries are initially created without a payoutId
. The value is updated when the sales summary is paid..
paid
If the value is True, it indicates that this sales summary has been paid. This value is useful for creating a filter in choosing data for a report.
payerId
The ID of the payer.
payerName
The name of the payer.
payeeId
The ID of the payee.
liveMode
If the value is True, the object exists in live mode. If the value is False, the object exists in a test mode. Only live mode is supported.
Last updated