The Get Contract Billing InformationAPIretrieves the billing information like the billing id,amount to be paid, balance due amount, billing status as 'Past Due','Paid' or 'Unpaid' as a billing statement for a contract, specified by the Contract Number. Only those bills are displayed whose premium due date is a year less than the latest bill’s premium due date.
The following products are in scope:
Deferred Annuity
Immediate Annuity
Term Life Insurance
Universal Life
Whole Life Insurance
| TR ID# | Technical Requirements |
| TR1 | ACORDv2.36 shall be used to communicate. |
| TR2 | ACORD Tx 207 “Billing Statement Inquiry Transaction tc=207” is being used for getting the billing details for a contract. |
| TR3 | Interface must always return an error code and desc in the event of a processing failure in addition to HTTP response code. |
| TR4 | For a success, the response will provide the billing details for a given contract. |
| BR ID# | Business Requirements |
| BR1 | The Get Contract Billing Information should provide all the billing details associated with the provided contract number. The details include:Billing ID Amount to be Paid Balance due amountBilling status as 'Past Due','Paid' or 'Unpaid' |
| BR2 | The contract needs to be present in ALIP, for the data to be returned. |
The external system would fire the REST URL with the JSON message containing the contract billing/other contract information to be retrieved/updated on the request queue.
ALIP webadapters would pick up, process the message, convert it into XML format, and posts it onto the ALIP request queue.
ALIP process server will pick up the message, convert from ACORD to the canonical format, perform the necessary XSD validations, and other basic validations on the completeness of the contract information, existence of the contract id in ALIP etc.
Post the necessary validations, it would invoke the necessary ALIP APIs/workflows to update or retrieve the necessary contract billing or the contract summary/customer contract mapping information from the database.
The contract billing, summary or customer contract mapping information in case of a “GET” request, or the status information incase of an update contract billing information request, would be generated in XML format, converted to ACORD format, and sent back to the REST layer
Here, it would be further converted back into the final JSON output format and returned back to the external system.
N/A
N/A
N/A
| Request Parameters | Description | Mandatory | Allowed values |
| Contract Number | A number which uniquely identifies a contract number within ALIP. | Y |
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The Get Contract Billing Information call was successful with details being returned in the output | 1 | Success | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1 |
| Error | Error Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The Get Contract Billing Information call was not successful due to a technical error or contract not found. | 5 | Internal Error | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5 |