Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Summary Journal Entries > Get Summary Journal Entry

Get Summary Journal Entry

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

Request

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

Request Header

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

Request Parameters

je-number

required

path

Journal entry number in the format JE-00000001.

Response

Response Body

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 entry number in the format JE-00000001.

status

Status of journal entry. An enum with the values Created or Cancelled.

journalEntryDate

Date of the journal entry.

currency

Currency used.

homeCurrency

​Home currency used.

aggregateCurrency

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.

transactionType

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

accountingPeriodName

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

timePeriodStart

​Start date of time period included in the journal entry.

timePeriodEnd

​End date of time period included in the journal entry.

transferredToAccounting

Status shows whether the journal entry has been transferred to an accounting system. The possible values are No, Processing, Yes, Error, Ignore.

transferDateTime

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

transferredBy

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

notes

Additional information about this record.

Character limit: 2,000

segments

List of segments that apply to the summary journal entry.

segmentName

​Name of segment.

segmentValue

​Value of segment in this summary journal entry.

journalEntryItems

Key name that represents the list of journal entry items.

accountingCodeType

Accounting code type. The accounting code types are:

  • AccountsReceivable
  • Cash
  • OtherAssets
  • CustomerCashOnAccount 
  • DeferredRevenue
  • SalesTaxPayable
  • OtherLiabilities
  • SalesRevenue 
  • SalesDiscounts
  • OtherRevenue
  • OtherEquity
  • BadDebt  
  • OtherExpenses

accountingCodeName

Name of the accounting code.

glAccountName

The account name in the general ledger (GL) that corresponds to the accounting code.

glAccountNumber

The account number in the general ledger (GL) that corresponds to the accounting code.

type

Type of journal entry item. An enum with the value Credit or Debit.

amount

Journal entry item amount in transaction currency.

homeCurrencyAmount

Journal entry item amount in home currency.

cf_txtn__c

One or more optional custom fields, where n is the maximum number of custom fields allowed.

cf_pkn__c

One or more optional custom fields, where n is the maximum number of custom fields allowed. 

cf_txtn__c

One or more optional custom fields, where n is the maximum number of custom fields allowed.

cf_pkn__c

One or more optional custom fields, where n is the maximum number of custom fields allowed. 

Example

Request

GET https://api.zuora.com/rest/v1/journal-entries/JE-00000001

Response

{
    "number": "JE-00000001",
    "status": "Created",
    "journalEntryDate": "2016-01-31",
    "currency": "USD",
    "homeCurrency": "USD",
    "aggregateCurrency": true,
    "transactionType": "Revenue Event Item",
    "accountingPeriodName": "Jan'16",
    "timePeriodStart": "2016-01-01",
    "timePeriodEnd": "2016-01-31",
    "transferredToAccounting": null,
    "transferredBy": null,
    "transferDateTime": null,
    "notes": null,
    "segments": [
        {
            "segmentName": "Customer Code",
            "segmentValue": "A00000001"
        },
        {
            "segmentName": "Charge Type",
            "segmentValue": "OneTime"
        }
    ],
    "journalEntryItems": [
        {
            "accountingCodeType": "DeferredRevenue",
            "accountingCodeName": "Deferred Revenue",
            "glAccountName": null,
            "glAccountNumber": null,
            "type": "Debit",
            "homeCurrencyAmount": 424.08,
            "amount": 424.08
        },
        {
            "accountingCodeType": "SalesRevenue",
            "accountingCodeName": "Professional Services Revenue",
            "glAccountName": null,
            "glAccountNumber": null,
            "type": "Credit",
            "homeCurrencyAmount": 424.08,
            "amount": 424.08
        }
    ],
    "success": true
}

 

Last modified
01:37, 11 Jul 2016

Tags

This page has no custom tags.

Classifications

(not set)