---
title: "Create a summary statement run"
method: POST
path: "/v1/summary-statement-runs"
tags: ["Summary Statements"]
---

# Create a summary statement run

`POST /v1/summary-statement-runs`

Allows you to initiate the generation of a summary statement run.
You can specify parameters such as the run type (AdHoc or scheduled) and the target account categories (single or multiple accounts).

## Headers

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

## Request body

- SummaryStatementRunRequestType
  - `runType` 'AdHoc', required — The scheduled type of the run which can either be AdHoc or Scheduled. Currently, only `AdHoc` is supported.
  - `targetAccountCategory` 'SingleAccount' | 'AllAccounts' | 'AccountsWithOpenInvoices' | 'AccountsWithOpenBalances' | 'AccountsWithoutInvoices' | 'AccountsWithoutInvoicesAndOpenBalances', required — Specifies the type of account filter. If the filter type is set to `AllAccounts`, `AccountsWithOpenInvoices`, `AccountsWithOpenBalances`, `AccountsWithoutInvoices`, or `AccountsWithoutInvoicesAndOpenBalances`, you can further refine the filter using `batchName` and `billCycleDay`. However, these criteria are not applicable when the filter type is `SingleAccount`.
  - `accountKey` string, nullable — The related account ID or account number when the filter type is `SingleAccount`.
  - `batchName` string — The batch name used for filtering accounts, for example, Batch1.
  - `billCycleDay` string, nullable — The bill cycle day for filtering accounts, with values ranging from '01' to '31'.
  - `dateRangeType` 'Custom' | 'PreviousThreeCalendarMonth' | 'PreviousOneCalendarMonth', required — 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.
  - `startDate` string, date — Required when `Custom` is selected for the date range. The start date can be set to a maximum of 5 years in the past and must follow the format YYYY-MM-DD.
  - `endDate` string, date — When creating a statement run, this field cannot be manually entered. If `Custom` is selected, the end date automatically defaults to today’s date in the tenant’s timezone.
  - `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.

## Response `200`

OK

- SummaryStatementRunResponse
  - `id` string — The unique identifier for the statement run.
  - `statementRunNumber` string — The number of the statement run.
  - `runType` 'AdHoc' — The scheduled type of the run which can either be AdHoc or Scheduled. Currently, only `AdHoc` is supported.
  - `targetAccountCategory` 'SingleAccount' | 'AllAccounts' | 'AccountsWithOpenInvoices' | 'AccountsWithOpenBalances' | 'AccountsWithoutInvoices' | 'AccountsWithoutInvoicesAndOpenBalances' — Specifies the type of account filter. If the filter type is set to `AllAccounts`, `AccountsWithOpenInvoices`, `AccountsWithOpenBalances`, `AccountsWithoutInvoices`, or `AccountsWithoutInvoicesAndOpenBalances`, you can further refine the filter using `batchName` and `billCycleDay`. However, these criteria are not applicable when the filter type is `SingleAccount`.
  - `accountKey` string, nullable — When the filter type is `SingleAccount`, this field contains the related account ID.
  - `batchName` string — The name of the batch used for filtering accounts.
  - `billCycleDay` string, nullable — The bill cycle day for filtering accounts, with values ranging from '01' to '31'.
  - `dateRangeType` 'PreviousThreeCalendarMonth' | 'PreviousOneCalendarMonth' | 'PreviousOneCalendarMonth' — The date range for the statement.
  - `startDate` string, date — The start date.
  - `endDate` string, date — The end date, which defaults to today’s date when `Custom` is selected. This field cannot be manually entered.
  - `autoEmailEnabled` boolean — Indicates whether to send an email after a statement is generated.
  - `description` string — A text description of the statement run.
  - `status` 'Pending' | 'Processing' | 'Completed' | 'Error' | 'Terminated' — The status of the run.
  - `createdById` string — The ID of the user who created the statement run.
  - `createdDate` string, dateTime — The date and time the statement run was created.
  - `success` boolean — Indicates whether the operation was successful.
  - `updatedById` string — The ID of the user who last updated the statement run.
  - `updatedDate` string, dateTime — The date the statement run was last updated.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[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)