Skip to navigation
Billing DocumentsSummary Statements

Create a summary statement run

View as Markdown

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

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Idempotency-KeystringOptional<=255 characters
Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
Accept-EncodingstringOptional

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-EncodingstringOptional

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Entity-IdsstringOptional

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user’s accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Zuora-Track-IdstringOptional<=64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-VersionstringOptional

The minor API version.

For a list of available minor versions, see API upgrades.

Request

This endpoint expects an object.
runTypeenumRequired

The scheduled type of the run which can either be AdHoc or Scheduled. Currently, only AdHoc is supported.

Allowed values:
targetAccountCategoryenumRequired

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.

dateRangeTypeenumRequired

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.

Allowed values:
accountKeystring or nullOptional

The related account ID or account number when the filter type is SingleAccount.

batchNamestringOptional
The batch name used for filtering accounts, for example, Batch1.
billCycleDaystring or nullOptional
The bill cycle day for filtering accounts, with values ranging from '01' to '31'.
startDatedateOptional

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.

endDatedateOptional

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.

autoEmailEnabledbooleanOptional

Indicates whether to send an email after a statement is generated. Acceptable values are true or false. If unspecified, the default value is false.

descriptionstringOptional
A text description of the statement run.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call. You cannot control the value of this header.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Response

OK
idstringOptional
The unique identifier for the statement run.
statementRunNumberstringOptional
The number of the statement run.
runTypeenumOptional

The scheduled type of the run which can either be AdHoc or Scheduled. Currently, only AdHoc is supported.

Allowed values:
targetAccountCategoryenumOptional

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.

accountKeystring or nullOptional

When the filter type is SingleAccount, this field contains the related account ID.

batchNamestringOptional
The name of the batch used for filtering accounts.
billCycleDaystring or nullOptional
The bill cycle day for filtering accounts, with values ranging from '01' to '31'.
dateRangeTypeenumOptional
The date range for the statement.
Allowed values:
startDatedateOptional
The start date.
endDatedateOptional

The end date, which defaults to today’s date when Custom is selected. This field cannot be manually entered.

autoEmailEnabledbooleanOptional
Indicates whether to send an email after a statement is generated.
descriptionstringOptional
A text description of the statement run.
statusenumOptional
The status of the run.
Allowed values:
createdByIdstringOptional
The ID of the user who created the statement run.
createdDatestringOptionalformat: "dateTime"
The date and time the statement run was created.
successbooleanOptional
Indicates whether the operation was successful.
updatedByIdstringOptional
The ID of the user who last updated the statement run.
updatedDatestringOptionalformat: "dateTime"
The date the statement run was last updated.

Errors

4XX
Client Request Error
500
Internal Server Error