Create a journal run

This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided.

header Parameters
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.


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.


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.


The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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 (:), 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 do not need to set this header.

Request Body schema: application/json

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.

string <date>

Date of the journal entry.

string <date>

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.

string <date>

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.

Array of objects (transactionTypes)

Transaction types included in the journal run.

You can include one or more transaction types.

Request samples
  • "accountingPeriodName": "Nov-2014",
  • "journalEntryDate": "2014-11-04",
  • "transactionTypes": [
Response samples
  • "journalRunNumber": "JR-00000008",
  • "success": true