Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Journal Runs > Create Journal Run

Create Journal Run

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

Request

  • Production: POST https://api.zuora.com/rest/v1/journal-runs
  • API Sandbox: POST https://apisandbox-api.zuora.com/rest/v1/journal-runs

Request Header

The Accept request header is optional. Only JSON is returned.

Request Body

transactionTypes

required

Transaction types included in the journal run.

You can include one or more transaction types.

type

required

Transaction type. The transaction types are:

  • Invoice Item
  • Taxation Item
  • Invoice Item Adjustment (Invoice)
  • Invoice Item Adjustment (Tax)
  • Invoice Adjustment (Invoice Adjustment is deprecated on Production. Zuora recommends that you use the Invoice Item Adjustment instead.)
  • Electronic Payment
  • External Payment
  • Electronic Refund
  • External Refund
  • Electronic Credit Balance Payment
  • External Credit Balance Payment
  • Electronic Credit Balance Refund
  • External Credit Balance Refund
  • Credit Balance Adjustment (Applied from Credit Balance)
  • Credit Balance Adjustment (Transferred to Credit Balance)
  • Revenue Event Item

To include all transaction types, pass in "All".

journalEntryDate​

required

Date of the journal entry.

accountingPeriodName

conditional

Name of the accounting period.

This field determines the target start and end dates of the journal run.

Required if you don't include targetStartDate and targetEndDate.

targetStartDate

conditional

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

targetEndDate

optional

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

Response

success

Returns true if the request is successful. Otherwise, returns false.

processId

The internal process ID used to assist Zuora support. Returned only if success is false.

reasons

Information describing the reason for the result. Returned only if success is false.

code

An eight-digit numeric error code.

message

A description of the error.

journalRunNumber

​Journal run number.

Examples

HTTP/JSON Request:

POST https://api.zuora.com/rest/v1/journal-runs
{
  "journalEntryDate": "2014-11-04",
  "accountingPeriodName": "Nov-2014",
  "transactionTypes":[
    {"type":"Invoice Item"},
    {"type":"Revenue Event Item"}
   ]
}

JSON Response:

{
  "journalRunNumber": "JR-00000008",
  "success": true
}
Last modified

Tags

This page has no custom tags.

Classifications

(not set)