---
title: "Retrieve a journal run"
method: GET
path: "/v1/journal-runs/{jr-number}"
tags: ["Journal Runs"]
---

# Retrieve a journal run

`GET /v1/journal-runs/{jr-number}`

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

## Path parameters

- `jr-number` string, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- GETJournalRunType
  - `aggregateCurrency` boolean
  - `executedOn` string — Date and time the journal run was executed.
  - `journalEntryDate` string, date — Date of the journal entry.
  - `number` string — Journal run number.
  - `organizationLabels` object[] — The organization(s) that the object belongs to. Note: This field is available only when the Multi-Org feature is enabled.
    - `organizationId` string — The organization ID.
    - `organizationName` string — The organization name.
  - `segmentationRuleName` string — Name of GL segmentation rule used in the journal run.
  - `status` 'Pending' | 'Processing' | 'Completed' | 'Error' | 'CancelInprogress' | 'Cancelled' | 'DeleteInprogress' — Status of the journal run.
  - `success` boolean — Returns `true` if the request was processed successfully.
  - `targetEndDate` string, date — The target end date of the journal run.
  - `targetStartDate` string, date — The target start date of the journal run.
  - `totalJournalEntryCount` integer — Total number of journal entries in the journal run.
  - `transactionTypes` GETJournalRunTransactionType[] — Transaction types included in the journal run.
    - `type` 'Invoice Item' | 'Taxation Item' | 'Invoice Item Adjustment (Invoice)' | 'Invoice Item Adjustment (Tax)' | 'Invoice Adjustment' | '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' | 'Debit Memo Item (Charge)' | 'Debit Memo Item (Tax)' | 'Credit Memo Item (Charge)' | 'Credit Memo Item (Tax)' | 'Credit Memo Application Item' | 'Electronic Payment Application' | 'External Payment Application' | 'Electronic Refund Application' | 'External Refund Application' | 'Electronic Payment Application Item' | 'External Payment Application Item' | 'Electronic Refund Application Item' | 'External Refund Application Item' — Transaction type. Invoice Adjustment is deprecated on Production. Zuora recommends that you use the Invoice Item Adjustment instead. If you enable the Invoice Settlement feature, Debit Memo Item, Credit Memo Item, and Credit Memo Application Item are available, Payment and Refund will be replaced by Payment Application and Refund Application. If you enable both the Invoice Settlement feature and the Invoice Item Settlement feature, Payment and Refund will be replaced by Payment Application Item and Refund Application Item.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)