Retrieve Enterprise Journal Content by Year and Period for Financial Consolidation and Close

Returns Enterprise journal content for the provided Year, Period, and Journal ID. This API can be used if a user wants to query an Enterprise Journal without knowing the journal identifier.

This API works only for Financial Consolidation and Close.

REST Resource

GET       /HyperionPlanning/rest/ej/{api_version}/ejjournalcontent?Year={year}&Period={period}&JournalId={journalId}

Required Roles

Service Administrator

Example of Request URL

GET       /HyperionPlanning/rest/ej/v1/ejjournalcontent?Year=2018&Period=Jan&JournalId=100000001

Supported Media Types: application/json

Table 21-12 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with	Path	Yes	None
Year	Year for which to list journal, for example, Year=2018	Query	Yes	None
Period	Period for the journal, for example: Period=Jan	Query	Yes	None
JournalId	Identifier for the journal for which you want to retrieve journal content	Query	Yes	None

Example of Response Body

The following shows an example of the response body.

{
  "year": 2018
  "period": "Jan",
  "journalId": "100000001",
  "instanceId": "100000000008821",
  "items": [
{
      "Status Code": "NEW",
      "Ledger ID": "LNR 12000",
      "Journal Source": "EPM_EJ",
      "Journal Category": "Adjustment",
      "Currency Code": "EUR",
      "Segment 1": "100091",
      "Entered Debit Amount": "19800.00",
      "Entered Credit Amount": "0.00"
},
{
      "Status Code": "NEW",
      "Ledger ID": "LNR 12000",
      "Journal Source": "EPM_EJ",
      "Journal Category": "Adjustment",
      "Currency Code": "EUR",
      "Segment 1": "100092",
      "Entered Debit Amount": "0.00",
      "Entered Credit Amount": "19800.00"
},
{
      "Status Code": "NEW",
      "Ledger ID": "LNR 12000",
      "Journal Source": "EPM_EJ",
      "Journal Category": "Adjustment",
      "Currency Code": "EUR",
      "Segment 1": "100093",
      "Entered Debit Amount": "34900.00",
      "Entered Credit Amount": "0.00"
},
{
      "Status Code": "NEW",
      "Ledger ID": "LNR 12000",
      "Journal Source": "EPM_EJ",
      "Journal Category": "Adjustment",
      "Currency Code": "EUR",
      "Segment 1": "1000943",
      "Entered Debit Amount": "0.00",
      "Entered Credit Amount": "34900.00"
  }
],
  "links": [
{
      "rel": "self",
      "https://<BASE-URL>/HyperionPlanning/rest/ej/v1/ejjournals/100000000008821",
      "action": "GET"
},
{
      "rel": "update_posting_status",
      ""https://<BASE-URL>/HyperionPlanning/rest/ej/v1/ejjournals/100000000008821
/poststatus",
      "action": "POST"
}
],
"error": null,
"type": "EPM"
}