The Commission API get the list of commissions for an agent for the period specified within the start and the end date if no such dates are specified then details received are for that particular year. The commissions data received depends on the client id of the agent within the ALIP system.
In order to make a get commission call to ALIP system the user must have the role of an agent within the ALIP system. There three basic type of commission they are Paid,Pending and reverse based on the data available within ALIP system the response for get commission will be generated.
| TR ID# | Technical Requirements |
| TR1 | ACORDv2.36 shall be used to communicate. |
| TR2 | ACORD Tx 206 “Get Commissiontc=206” is being used for getting commissions details based on the client id of the user having the role as agent. |
| 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 request will be successfully processed |
| BR ID# | Business Requirements |
| BR1 | The Commissions interface wili get the commissions details for the period specified by te start and end date. |
| BR2 | Interface will get the commissions details for last one year till the current date in case no dates are specified within the url. |
| BR3 | The client id of the user provided within the logging must have role as agent within the ALIP system |
N/A
The Agent should be present within the ALIP system.
The Agent must be valid within ALIP system. Agent must be an individual/company.
The Agent must be included while we create an application so the agent will be eligible for commission.
The date for which the application is created must be within the range of dates where the agent is eligible for getting the commission.
The user for the client id must have role of the type Agent within the ALIP system.
The ALIP system must have the required data of commission within ALIP.
The Agent should be Active within ALIP system.
Please refer to spreadsheet below for the request Mapping
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The get commission 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 |
| #2 | The get commission call was NOT successful due to a technical error. | 5 | Internal Error | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5 |