Generate Accounting Detail Message

The generate accounting detail message process reads accounting details and creates a corresponding accounting message in JSON format.

Authorization

A user authorization configuration requires access to this operation. The relevant access restriction is generateaccountingmessage batch IP.

Request

The user can start this long-running operation through the following POST request:

http://[hostName]:[portNumber]/[api-context-root]/generateaccountingmessage

Payload

Following is the request Payload for Generate Accounting Detail Message:

{
  "creationTimeTo": "string",
  "creationDateTo": "2015-07-20",
  "glExtractionBatchId": "string",
  "creationTimeFrom": "string",
  "groupAccountCode": "string",
  "origin": "R",
  "creationDateFrom": "2015-07-20",
  "description": "string",
  "datafileSetCode": "string",
  "incremental": true,
  "grouping": "string"
}

The parameters for the activity are:

Table 1. Generate Accounting Detail Message Request Parameters
Name	Description	Required
Description	The description of the long running operation.	Mandatory
Created Date From Created Date To Creation Time From Creation Time To	Evaluate to `true` if the creation date of the Accounting Detail falls within the parameters. If the time element is not specified, it works as follows: If the time element for Creation Date From is left unspecified, it translates to 00:00. If the time element for Creation Date To is left unspecified, it translates to 23:59.	Mandatory
Origin	Possible values Registation-R or Financial-F. Allows to select accounting details linked to either registration or financial. When not specified both are considered.	Mandatory
Group Account	Evaluate to `true` if the accounting detail is for the specified group account.	Optional
Incremental	When set to `true`, it excludes the accounting details which are handled, that is, have GL Extraction Batch Id and GL Extraction Date Time set. Default is set to `true` (Yes).	Optional
Grouping	Evaluates to `true` if the financial transaction set grouping matches the specified criterion. When not mentioned, no restrictions apply.	Optional
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 gets updated against the accounting details. For subsequent runs the new id should be considered.	Optional
Data File Set Code	Data file set code.	Optional

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):

Table 2. Error Messages
Code	Sev	Message
FIN-IP-ACDE-001	Fatal	At least one of the following must be specified: Transaction Creation Date (From/To). GL Extraction Batch ID. Grouping.
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-004	Fatal	Group account code is unknown.
ACT-FL-DAFI-001	Informative	Messages are written to the Data File Set { data file set id}.