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

zuora.com

Summary: Retrieve a journal run
Operation ID: GET_JournalRun
Auth: unknown
Description

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

Parameters (3)

Zuora-Entity-Ids (string, header, optional)

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/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.

Zuora-Track-Id (string, header, optional)

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 (`'`).

Constraints: {'maxLength': 64}

jr-number (string, path, required)

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

No probe data for this endpoint yet.