# Returning a list of sales summaries
You can retrieve a list of sales summaries using specific query parameters to tailor the response to your specific needs. By sending a `GET /sales-summaries` request, you gain access to detailed insights into your sales summaries. This allows for a thorough analysis of financial metrics and transaction details. By understanding and using the available parameters, such as time filters, currency, and pagination options, you can efficiently navigate through your sales data and optimize your business processes.
## Setting sales summary query parameters
You can set the appropriate query parameters to manage and analyze sales summaries. These parameters allow you to filter, paginate, and limit your results according to specific fields, such as `createdTime`, `updatedTime`, and `salesClosingTime`. Additionally, parameters like `amount`, `currency`, `payerId`, and `payeeName` provide further customization, enabling you to streamline your data queries efficiently according to your business requirements. Understanding these parameters will help you maximize the utility of the sales summaries feature in your application.
| 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:
- gt–return values where the
createdTime field is after this timestamp - gte–return values where the
createdTime field is after or equal to this timestamp - lt–return values where the
createdTime field is before this timestamp - lte–return values where the
createdTime field is before or equal to this timestamp
|
| updatedTime | Optional | A filter on the list based on the updatedTime field. The value can be a string with an ISO-601 UTC format datetime, or it can be a dictionary with the following options:
- gt–return values where the
updatedTime field is after this timestamp - gte–return values where the
updatedTime field is after or equal to this timestamp - lt–return values where the
updatedTime field is before this timestamp - lte–return values where the
updatedTime field is before or equal to this timestamp
|
| endingBefore | Optional | A cursor for use in pagination. The `endingBefore` parameter is an object identifier that defines your place in the list. For instance, if you make a list request and receive 100 objects starting with `xyz`, your subsequent calls can include `endingBefore=xyz` to fetch the previous page of the list. |
| startingAfter | Optional | A cursor for use in pagination. The `startingAfter` parameter is an object identifier that defines your place in the list. For instance, if you make a list request and receive 100 objects ending with `xyz`, your subsequent calls can include `startingAfter=xyz` to fetch the next page of the list. |
| 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 salesClosingTime field. The value can be a string with an ISO-601 UTC format datetime, or it can be a dictionary with the following options:
- gt–return values where the
salesClosingTime field is after this timestamp - gte–return values where the
salesClosingTime field is after or equal to this timestamp - lt–return values where the
salesClosingTime field is before this timestamp - lte–return values where the
salesClosingTime field is before or equal to this timestamp
|
| 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 summariesamount field. The value can be a string or it can be a dictionary with the following options:
- gt–return values where the
amount field is greater than this amount - gte–return values where the
amount field is greater than or equal to this amount - lt–return values where the
amount field is less than this amount - lte–return values where the
amount field is less than or equal to this amount
|
| 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. |
## **Get sales summaries request and response**
To obtain a list of sales summaries, you use a `GET /sales-summaries` request. This request retrieves comprehensive data about your sales transactions, allowing you to analyze critical sales metrics. The API response will include detailed information such as timestamps, currency, amounts, payer and payee details, and the payment status. Understanding how to structure these requests is crucial for leveraging the sales data effectively for your business operations.
Retrieve the details of sales summaries with a `GET` request:
{% tabs %}
{% tab title="cURL" %}
```http
curl https://api.digitalriver.com/sales-summaries
```
{% endtab %}
{% endtabs %}
A `200 OK` response returns an array of [Sales Summary](https://docs.digitalriver.com/digital-river-api-reference/2021-12-13/sales-summaries) objects:
{% tabs %}
{% tab title="JSON" %}
```javascript
{
"hasMore": true,
"data": [
{
"id": "8100000400_1410_2019",
"createdTime": "2019-04-25T20:36:00Z",
"updatedTime": "2019-04-26T20:36:00Z",
"salesClosingTime": "2019-04-25T00:00:00Z",
"currency": "USD",
"amount": 1180.26,
"payoutId": "2000028600_1410_2019",
"paid": true,
"payerId": "1410",
"payerName": "DR globalTech, Inc.",
"payeeId": "0013900100",
"payeeName": "ACME, Inc.",
"liveMode": true
}
]
}
```
{% endtab %}
{% endtabs %}
## Key sales summaries attributes
The following details the key attributes returned in response to a request for [sales summaries](/digital-river-api/administration/dashboard/finance/sales-summaries.md) information. For a complete list, refer to the [Sales summaries API](https://docs.digitalriver.com/digital-river-api-reference/2021-12-13/sales-summaries).
### id
A unique identifier for the sales summary.
### createdTime
The time when the sales summary was created in the reporting environment
### updatedTime
The time when the sales summary was updated 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 when 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.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.digitalriver.com/digital-river-api/financial-reporting/sales-summaries/returning-a-list-of-sales-summaries.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.