Update Enterprise Journal Posting Status for Financial Consolidation and Close

Updates the Enterprise Journal Posting status. After journal content has been read and the import to ERP begins, this API must be invoked to update the status to PostInProgress, and after completion of posting, the status should be updated with either Posted or Failed. Error items are read-only if the Posting status is Failed.

This API works only for Financial Consolidation and Close.

REST Resource

POST       /HyperionPlanning/rest/ej/{api_version}/ejjournals/{instanceId}/poststatus

Required Roles

Service Administrator

Example of Request URL

POST       /HyperionPlanning/rest/ej/v1/ejjournals/100000000008821/Posted

Supported Media Types: application/json

Table 21-13 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with: v1	Path	Yes	None
instanceId	The ID of the journal for which you want to update Posting status.	Path	Yes	None
year	Year value of journal period	String	No	None
period	Period of journal	String	No	None
journalId	Journal ID value	String	No	None
status	Journal Post Status Note: Only "PostInProgress", "Failed" and "Posted" are supported for status value.	String	Yes	None
message	Posting message to be set to the journal	String	No	None
journalBatch	Journal Batch represents the identifier from target ERP system for the current batch of posting.	String	No	None
errorItems	List of errors if any	Array	No	None
errorCode	Identifier for the individual error	String	No	None
errorMessage	Detailed message of the error	String	No	None
entryId	Journal entry identifier, for which error has occurred	String	No	None

Example of Post In Progress:

{
"year": "2019",
"period": "Jan",
"journalId": "10000000012",
"status": "PostInProgress"
}

Example of an Error:

{
"year": "2019",
"period": "Jan",
"journalId": "100000001",
"status": "Failed",
"errorItems": [
{
     "errorCode": "EF04",
     "errorMessage": "The account combination is invalid.",
     "entryId": "Journal Ent 1"
},
{
     "errorCode": "EU07",
     "errorMessage": "Accounting period is not open for the ledger.",
     "entryId": "Journal Ent 2"
}
]
}

Example When Posted:

{
"year": "2021",
"period": "Jan",
"journalId": "10000000003",
"status": "Posted",
"journalBatch": "111720201001-LNR11432"
}

Response

{
"detail": "Journal 2021 Jan 10000000001 is not in 'Post In Progress' or 'Ready to Post' status.", 
"status": 400,
"message": "oracle.apps.epm.sdm.model.common.SDMModelException: Journal 2021 Jan 10000000001 is not in 'Post In Progress' or 'Ready to Post' status.",
"localizedMessage": "oracle.apps.epm.sdm.model.common.SDMModelException: Journal 2021 Jan 10000000001 is not in 'Post In Progress' or 'Ready to Post' status.",
"suppressed": []
}

Note:

The maximum character limit of the following fields are:

• journalBatch – 255 characters
• errorMessage – 255 characters
• errorCode – 20 characters
• entryId – 500 characters