Prepare Final Account
It starts new preparation session in server for final account reports
URL
finalaccount/prepare
Method
POST
Request Media type
application/json
Response Media type
application/json
Request Parameters
| Parameter | Data Type | Min | Max | M/O | Sample Value | Comments |
|---|---|---|---|---|---|---|
| key | String | 32 | 32 | M | 6sIHSPlCMQ81L18oeThx4a6o6w743fJc | Key obtained from authentiaction. |
| firmid | Integer | M | 1 | Firm id of selected firm (0 for all firms) | ||
| fromdate | String | M | 2020-04-01 | From Date, Should be in the format of YYYY-MM-DD | ||
| todate | String | M | 2021-03-31 | To Date, Should be in the format of YYYY-MM-DD | ||
| uid | String | M | CE400858268F4A3CBCD7E2706DD0AF72 | UID for the run instance. |
Response Values
| Name | Data Type | Min Length | Max Length | M/O | Sample Value | Comments |
|---|---|---|---|---|---|---|
| uid | String | M | CE400858268F4A3CBCD7E2706DD0AF72 | UID of the request | ||
| statuspercentage | Integer | M | 10 | Status Percentage of operation | ||
| statusmessage | String | M | Starting Data Preparation | Status of operation |
Sample Request
{
"key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
"firmid": "1",
"fromdate": "2020-04-01",
"todate": "2021-03-31",
"uid": "CE400858268F4A3CBCD7E2706DD0AF72"
}Sample Success Response
{
"uid": "CE400858268F4A3CBCD7E2706DD0AF72",
"statuspercentage": "10",
"statusmessage": "Starting Data Preparation",
"e": 200,
"msg": "Success"
}Sample Failure Responses
{
"e": 400,
"msg": "Bad Request."
}
{
"e": 403,
"msg": "Invalid or missing API Key."
}
{
"e": 500,
"msg": "Internal Server Error."
}
{
"e": 503,
"msg": "Service unavailable."
}