Use journal runs to automatically create summary journal entities that are suitable for importing into your general ledger system.
For more information about journal runs, see Journal Runs.
This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided.
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.
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.
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 (').
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.
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.
The minor API version.
For a list of available minor versions, see API upgrades.
Name of the accounting period.
This field determines the target start and end dates of the journal run.
Required if you do not include targetStartDate and targetEndDate.
The organization that this run is created for.
For each item in the array, either the organizationId or the organizationName field is required.
This field is only required when you have already turned on Multi-Org feature.
The target end date of the journal run.
If you include accountingPeriodName, the targetEndDate must be empty or the same as the end date of the accounting period specified in accountingPeriodName.
The target start date of the journal run.
Required if you include targetEndDate.
If you include accountingPeriodName, the targetStartDate must be empty or the same as the start date of the accounting period specified in accountingPeriodName.
- https://rest.test.zuora.comhttps://rest.test.zuora.com/v1/journal-runs
- US API Sandbox Cloud 1https://rest.sandbox.na.zuora.com/v1/journal-runs
- US API Sandbox Cloud 2https://rest.apisandbox.zuora.com/v1/journal-runs
- US Production Cloud 1https://rest.na.zuora.com/v1/journal-runs
- US Production Cloud 2https://rest.zuora.com/v1/journal-runs
- https://rest.test.eu.zuora.comhttps://rest.test.eu.zuora.com/v1/journal-runs
- EU API Sandboxhttps://rest.sandbox.eu.zuora.com/v1/journal-runs
- EU Productionhttps://rest.eu.zuora.com/v1/journal-runs
- https://rest.test.ap.zuora.comhttps://rest.test.ap.zuora.com/v1/journal-runs
- APAC Productionhttps://rest.ap.zuora.com/v1/journal-runs
{ "accountingPeriodName": "Nov-2014", "journalEntryDate": "2014-11-04", "transactionTypes": [ { … }, { … } ] }
OK
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/jsonapplication/xmltext/htmltext/csvtext/plain
The request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The Zuora internal identifier of the API call. You cannot control the value of this header.
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.
The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.
For more information, see Concurrent request limits.
The total number of the permitted concurrent requests.
For more information, see Concurrent request limits.
The remaining number of the permitted concurrent requests.
For more information, see Concurrent request limits.
{ "journalRunNumber": "JR-00000008", "success": true }