Knowledge Center

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

Get Journal Run

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

Request

  • Production: GET https://api.zuora.com/rest/v1/journal-runs/{jr-number}
  • API Sandbox: GET https://apisandbox-api.zuora.com/rest/v1/journal-runs/{jr-number}

Request Header

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

Request Parameters

jr-number

required

path

Journal run number. Must be a valid journal run number in the format JR-00000001

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.

number

​Journal run number.

status

Status of the journal run. The possible values are:

  • Pending
  • Processing
  • Completed
  • Error
  • CancelInprogress
  • Cancelled
  • DeleteInprogress

executedOn

Date and time the journal run was executed.

targetStartDate

​The target start date of the journal run.

targetEndDate

​The target end date of the journal run.

journalEntryDate

Date of the journal entry.

segmentationRuleName

Name of GL segmentation rule used in the journal run.

totalJournalEntryCount

Total number of journal entries in the journal run.

transactionTypes

Transaction types included in the journal run.

type

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

Examples

HTTP/JSON Request:

GET https://api.zuora.com/rest/v1/journal-runs/JR-00000002

JSON Response:

{ 
 "number": "JR-00000002",
 "status": "Completed",
 "executedOn": "2014-11-15 22:05:12",
 "segmentationRuleName": "s1", 
 "totalJournalEntryCount": 2,
 "targetStartDate": "2016-03-01", 
 "targetEndDate": "2016-03-31", 
 "journalEntryDate": "2016-02-02",
 "transactionTypes": [
        { "type": "Invoice Item" }
 ], 
 "success": true 
}
Last modified

Tags

This page has no custom tags.

Classifications

(not set)