This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided.
string <= 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.
If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a
The value is in the
string <= 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 (
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 do not need to set this header.
Name of the accounting period.
This field determines the target start and end dates of the journal run.
Required if you do not include
Date of the journal entry.
The target end date of the journal run.
If you include
The target start date of the journal run.
Required if you include targetEndDate.
If you include
Array of objects (transactionTypes)
Transaction types included in the journal run.
You can include one or more transaction types.
- "accountingPeriodName": "Nov-2014",
- "journalEntryDate": "2014-11-04",
- "transactionTypes": [
- "type": "Invoice Item"
- "type": "Revenue Event Item"
- "journalRunNumber": "JR-00000008",
- "success": true