---
title: "List summary statements"
method: GET
path: "/object-query/summarystatements"
tags: ["Object Queries"]
---

# List summary statements

`GET /object-query/summarystatements`

Lists summary statements.

## Query parameters

- `pageSize` integer
- `cursor` string
- `sort[]` string[]
- `expand[]` string[]
- `filter[]` string[]
- `fields[]` string[]
- `includeNullFields` boolean

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- ExpandedSummaryStatement
  - `accountId` string — The unique identifier for the statement account.
  - `autoEmailEnabled` boolean — Indicates whether to send an email after a statement is generated. Acceptable values are `true` or `false`. If unspecified, the default value is `false`.
  - `description` string — A text description of the statement run.
  - `batchName` string, nullable — Name of the batch.
  - `billCycleDay` string, nullable — The bill cycle day for filtering accounts, with values ranging from '01' to '31'.
  - `dateRangeType` 'Custom' | 'PreviousThreeCalendarMonth' | 'PreviousOneCalendarMonth' — The date range for the statement. If `PreviousThreeCalendarMonth` or `PreviousOneCalendarMonth` is selected, the start and end dates are automatically calculated. For example, if `PreviousThreeCalendarMonth` is chosen today (2024-08-20), the dates would be 2024-05-01 to 2024-07-31.
  - `runType` 'AdHoc' — The scheduled type of the run which can either be AdHoc or Scheduled. Currently, only `AdHoc` is supported.
  - `createdById` string — The ID of the user who created the statement.
  - `createdDate` string, dateTime — The date and time when the statement was created.
  - `deleted` string — Indicates whether the statement has been deleted.
  - `endDate` string, date — The end date of the statement in the format YYYY-MM-DD.
  - `fileId` string — The ID associated with the file generated for the statement.
  - `id` string — The unique identifier of the statement.
  - `startDate` string, date — The start date of the statement in the format YYYY-MM-DD.
  - `emailStatus` string — The email status of the statement.
  - `statementDate` string, date — The date of the statement in the format YYYY-MM-DD.
  - `statementNumber` string — The unique number assigned to the statement.
  - `statementRunNumber` string — The number of the related statement run.
  - `statementRunId` string — The ID of the related statement run.
  - `status` 'Pending' | 'Processing' | 'Completed' | 'Error' | 'Terminated' — The current status of the statement.
  - `targetAccountCategory` 'SingleAccount' | 'AllAccounts' | 'AccountsWithOpenInvoices' | 'AccountsWithOpenBalances' | 'AccountsWithoutInvoices' | 'AccountsWithoutInvoicesAndOpenBalances' — The method used to filter accounts.
  - `updatedById` string — The ID of the user who last updated the statement.
  - `updatedDate` string, dateTime — The date and time when the statement was last updated.
  - `errorCategory` string — The category of error when the operation fails.
  - `errorMessage` string — The specific error message when the operation fails.
  - `success` boolean — Indicates whether the call succeeded.

## Other responses

- `500` — Internal server error
- `4XX` — Invalid input

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)