Sign in
Summary Journal Entries

Retrieve a summary journal entry

This REST API reference describes how to get information about a summary journal entry by its journal entry number.

get/v1/journal-entries/{je-number}

Path parameters

je-numberstring required

Headers

Accept-Encodingstring

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.

Content-Encodingstring

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.

Zuora-Track-Idstring

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

Zuora-Entity-Idsstring

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 should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

accountingPeriodNamestring

Name of the accounting period that the journal entry belongs to.

aggregateCurrencyboolean

Returns true if the journal entry is aggregating currencies. That is, if the journal entry was created when the Aggregate transactions with different currencies during a Journal Run setting was configured to Yes. Otherwise, returns false.

currencystring

Currency used.

homeCurrencystring

Home currency used.

journalEntryDatestring date

Date of the journal entry.

notesstring nullable

Additional information about this record. Character limit: 2,000

numberstring

Journal entry number in the format JE-00000001.

organizationLabelstring

The organization that this object belongs to.

Note: This field is available only when the Multi-Org feature is enabled.

status'Created' | 'Cancelled'

Status of journal entry.

successboolean

Returns true if the request was processed successfully.

timePeriodEndstring date

End date of time period included in the journal entry.

timePeriodStartstring date

Start date of time period included in the journal entry.

transactionTypestring

Transaction type of the transactions included in the summary journal entry.

transferDateTimestring nullable

Date and time that transferredToAccounting was changed to Yes. This field is returned only when transferredToAccounting is Yes. Otherwise, this field is null.

transferredBystring nullable

User ID of the person who changed transferredToAccounting to Yes. This field is returned only when transferredToAccounting is Yes. Otherwise, this field is null.

transferredToAccounting'No' | 'Processing' | 'Yes' | 'Error' | 'Ignore' nullable

Status shows whether the journal entry has been transferred to an accounting system.

Changes

No recorded changes to this endpoint across all 4 revisions of this API.