Generate Statements API

This functionality adds new billing statements (invoices) in the system, based on API requests received from other FintechOS solutions - such as Policy Admin or from other systems. On the FTOS_PYMT_Statement entity, for the newly generated invoice, the API response populates the following attributes:

Statement Id.
Statement Reference.
Statement Premium Amount.
Total Taxes.
Statement Amount.
Statement Due Date.
Payment Type Id.

Generate Statements API Example

The system registers a new invoice, containing installments from three different policies.

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
let policiesData = {
    policies: [{
            "policyNo": "80000863",
            "installmentNo": 7
        },
        {
            "policyNo": "80000862",
            "installmentNo": 11
        },
        {
            "policyNo": "80000861",
            "installmentNo": 2
        }
    ],
    statementDueDate: "2021-10-30"
}

ebs.callActionByNameAsync('FTOS_PYMT_StatementsGenerationAPI', policiesData).then(function(e) {
    console.log(e)
});

Request Data Parameters

The following is the list of data parameters included in the request:

Parameter	Description
policies	An array with the policy request details: `policyNo` and `installmentNo`.
statementDueDate	The invoice invariant date, when the payment is due (string).

Response

The following is an example of a response:

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
{
    UIResult: {
        …},
    Message: null,
    IsSuccess: true,
    ClientScript: null,
    Serialized: '{"UIResult":{"NavigateToEntityPage":false,"Navigat…ientScript":null,"Serialized":null,"ErrorCode":0}',
    …
}
ClientScript: null
ErrorCode: 0
IsSuccess: true
Message: null
Serialized: {
    UIResult: {
        NavigateToEntityPage: false,
        NavigateToEntityPageOnEdit: false,
        NavigateToEntityFormName: null,
        NavigateToEntityName: null,
        NavigateToEntityId: null,
        NavigateToEntityInsertDefaults: null,
        NavigateToUrl: null,
        DownloadFile: null,
        ReloadPage: false,
        Message: null,
        IsSuccess: false,
        Data: {
            "isSuccess": true,
            "result": [{
                    "statementId": "280f5f20-676c-4f74-b1c4-121d9bd42ec4",
                    "statementNo": "REF0003383",
                    "statementPremiumAmount": 10.73,
                    "totalTaxes": 1.07,
                    "statementAmount": 10.73,
                    "paymentTypeId": "180921d6-345a-4d83-a37b-278569008e7c",
                    "dueDate": {
                        "invariantDate": "2021-11-11"
                    }
                },
                {
                    "statementId": "0894a6f8-69b0-467c-9991-6b6f22f19d33",
                    "statementNo": "REF0003384",
                    "statementPremiumAmount": 10.73,
                    "totalTaxes": 1.07,
                    "statementAmount": 10.73,
                    "paymentTypeId": "180921d6-345a-4d83-a37b-278569008e7c",
                    "dueDate": {
                        "invariantDate": "2021-11-11"
                    }
                }
            ],
            "errorMessage": null,
            "errorCode": null
        },
        NavigateToPageNo: null
    },
    Message: null,
    IsSuccess: true,
    ClientScript: null,
    Serialized: null,
    ErrorCode: 0
}
UIResult:
    Data: {
        isSuccess: null,
        errorMessage: null,
        errorCode: null,
        result: {
            …}
    }
DownloadFile: null
IsSuccess: false
Message: null
NavigateToEntityFormName: null
NavigateToEntityId: null
NavigateToEntityInsertDefaults: null
NavigateToEntityName: null
NavigateToEntityPage: false
NavigateToEntityPageOnEdit: false
NavigateToPageNo: null
NavigateToUrl: null
ReloadPage: false[[Prototype]]: Object[[Prototype]]: Object

Response description:

Key	Description
errorCode	Error code.
isSuccess	Marks weather the request is successful or not.
errorMessage	Error message.
result	Either `null` or an `array` of objects, containing the following: Statement Id Statement Reference Statement Premium Amount Total Taxes Statement Amount Statement Due Date Payment Type Id

Error Messages

The following are the error messages that can be encountered during the API invoice generation process:

Code	Text	Description
ERR.BL.50101	Invalid request!	No data provided or the `policyData` doesn’t have the policies property.
ERR.BL.50102	Invalid request! PolicyNo or InstallmentNo can not be empty!	This error appears when the provided data fields are empty.
ERR.BL.50103	Invalid request! Policy {0} inserted multiple times!	This error appears when the same `PolicyNo` is included multiple times inside the `policies` array.
ERR.BL.50104	Invalid request! One or more policies do not have valid installments!	A valid policy installment is one that has the installment amount greater than 0, the installment due date not null and the installment business status OnTime.
ERR.BL.50105	The policies from the request can not be included in the same statement!	There is a mismatch between one (or some) of the requested policies and the policy grouping rule. For generating a multiple policies invoice, policies need to have the same contractor, payment type, currency, WO product configurations, and due date.
ERR.BL.50106	Invalid request! Policy {0} is in {1} status!	This error appears when the invoice generation API request is made for a policy that does not have a valid status.
ERR.BL.50107	The due date of the statement can not be from the past!	This error appears when the provided data field is filled with a past statement due date.
ERR.BL.50108	Invalid request! Policy {0} does not exist!	The requested policy is not registered in the system.
ERR.BL.50109	The statement can not be generated for policies that have broker collection as payment type!	The invoice cannot be generated for policies that have broker collection as payment type.

Server Automation Script

FTOS_PYMT_StatementsGenerationAPI - Script called with a data object.

This script executes the following:

Validates the request data object.
Searches, verifies and returns the policies that are eligible for invoice generation.
If all the necessary conditions are met, it uses the details gathered to generate the new invoice.

The script contains the following functions: