Create Accounting Details from Registrations

This section provides information on how this operation allows the user to generate accounting details from registration.

Authorization

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

Request

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

http://[hostName]:[portNumber]/[api-context-root]/registrations/accountingdetails

Payload

Following is the request Payload to Create Accounting Details from Registrations:

{
  "updatedDateFrom": "",
  "creationTimeTo": "",
  "createAccountingDetailDynamicLogicFunction": "",
  "creationDateTo": "",
  "codeType": "",
  "creationTimeFrom": "",
  "updatedTimeFrom": "",
  "updatedDateTo": "",
  "creationDateFrom": "",
  "description": "",
  "grouping": "",
  "updatedTimeTo": ""
}

For more information on long-running operations, see HTTP API/IP Concepts chapter in the Developer Guide.

The parameters for the activity are:

Table 1. Create Accounting Details Request Parameters
Parameter Description Required

Description

The description of the long running operation.

Mandatory

Creation Date From

Evaluates to true for registration if the creation date (audit column) of the registration transaction is between (inclusive) the criteria.

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

Created Time From

Optional

Creation Date To

Mandatory

Created Time To

Optional

Updated Date From

Evaluates to true for registration if the update date (audit column) of the registration transaction is between (inclusive) the criteria.

If the time element is not specified, it works as follows:

  • if the time element for Update Date From is left unspecified, it translates to 00:00.

  • if the time element for Update Date To is left unspecified, it translates to 23:59.

Optional

Updated Time From

Optional

Updated Date To

Optional

Updated Time To

Optional

Grouping

Registration with the specified grouping are selected.

Mandatory

CodeType

Registration with the specified code type are selected.

Optional

Create Accounting Detail Dynamic Logic Function

This dynamic logic function must be of signature Create Registration Accounting Detail or Create Registration Accounting Detail with Dual. If it is of another signature, the response message FIN-IP-REGI-003 is returned.

Mandatory

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.

Alternatively, notification events can also be used to track the progress of the process. A pre-configured endpoint receives a notification message.

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.

Response Messages

This process can result in the following response messages in response:

Table 2. Response Messages
Code Severity Message

FIN-IP-REGI-003

Fatal

Dynamic logic with code {0} is unknown or not of signatures 'Create Accounting Detail' or 'Create Accounting Detail with Dual' for registration.

FIN-IP-REGI-004

Fatal

Date (time) from should be on or before the date (time) to.

FIN-IP-REGI-005

Fatal

It is mandatory to specify at least one of the following:

  1. Creation date from.

  2. Creation date to.

  3. Update date from.

  4. Update date to.

FIN-IP-REGI-006

Fatal

It is mandatory to specify at least one of the following:

  1. Code type.

  2. Grouping.