Generate Accounting Detail Message
The generate accounting detail message process reads accounting details and creates a corresponding accounting message in JSON format.
The user can start this long-running operation through the following POST
request:
http://[hostName]:[portNumber]/[api-context-root]/generateaccountingmessage
The parameters for the activity are:
Name | Description |
---|---|
Description |
The description of the long-running operation. |
Creation Date From |
Evaluate to
|
Creation Time From |
|
Creation Date To |
|
Creation Time To |
|
Origin |
Possible values Registration - R or Financial -F. Allows to select accounting details linked to either registration or financial. When not specified, both are considered. |
Brand Code |
Evaluate to |
Grouping |
Evaluates to true if the financial transaction set grouping matches the specified criterion. When not mentioned, no restrictions apply. |
Incremental |
When set to |
GL Extraction Batch ID |
When specified, the batch selects the accounting details sent previously under the batch ID, thereby acting as a "resend" function. Note that once the accounting messages are "resend" a new batch ID and date time get updated against the accounting details. For subsequent runs, the new ID should be considered. |
Data File Set Code |
Data file set code. |
Processing
The system selects accounting details (not void) as specified by the above criteria. The selected accounting details are then grouped (amounts are added) using the Bulking group GL file, amount currency, reversal indicator, and invoiced indicator into a single JSON element.
Stamping of Results
The result of the accounting message creation is recorded in the Accounting Details. The activity id and datetime message created are captured.
Accounting Detail Message
{ "id": "jobId": "messageDate": "accountingDetails":[{ "description": "subject": "bulkingGroupGLFile": "reversal": this is only included if the Disable Reversal Grouping is set to false. "invoiced": "distributionAccount": "ledgerId": "accountingDate": "transactionDate: "category": "source": "currencyCode": "amountDebit": "amountCredit": "accountingPeriod": "glSegment1": to .. "glSegment30": "attribute1": to .. "attribute30": }] }
- Accounting Message Element
-
This element has attributes that relate to the accounting message itself. Attributes in this JSON are all populated by a fixed logic in the Generate Accounting Message activity.
Element | Source of Value | Note |
---|---|---|
id |
Simple Sequence |
Unique ID of message generated by Oracle Health Insurance. |
jobId |
Activity ID that created this accounting message |
Unique ID of the Accounting Message Creation activity. |
messageDate |
System Date and Time |
Date / Time the message was created. |
The system writes all the accounting messages to a JSON file (data file). The system might create multiple JSON files to avoid the creation of large data files with many accounting messages. These multiple files are placed in one data file set. The system leverages notification (activity notification) to deliver the links to download the data files.
Authorization
A user authorization configuration requires access to this operation.
The relevant access restriction is generateaccountingmessage batch IP
.
Response
The integration responds with HTTP 201 (created) and a location header for the long-running operation. The long-running operation resource provides further details on the operator’s process and can be followed to get the process status.
The system also sends notifications (activity notifications) to a preconfigured endpoint with links to data files. The chapter Long Running Operations through REST in the Developer Guide describes the standard notification structure of the notification message.
For the process and properties notification endpoint, see Outbound RESTful Service Invocations in the Security Guide section.
Error Message
This process can result in the following error messages with the elementId attribute set to the policy code (when applicable):
Code | Sev | Message |
---|---|---|
FIN-IP-ACDE-001 |
Fatal |
At least one of the following must be specified:
|
FIN-IP-ACDE-002 |
Fatal |
Date (time) from should be on or before the date (time). |
FIN-IP-ACDE-003 |
Fatal |
No other selection criteria must be specified when GL Extraction Batch ID is specified. |
FIN-IP-ACDE-005 |
Fatal |
Brand code is unknown. |
ACT-FL-DAFI-001 |
Informative |
Messages are written to the Data File Set {comma separated list of data file set ids} |