Update Rollup Status - For Template Cash Flows
PUT /ws/rest/service/v1/cashflow/template/rollup/status/{template_number}
Purpose
Update Rollup status of template cash flows
Request Format
All parameters should be URL encoded.
Both input & output in JSON format in the body
Request Parameter
template_number: (Optional) Specify the template number to update the rollup status of template cash flows; otherwise, to update the rollup status of standard template cash flows
Response Format
A JSON object is returned in the following format.
{
"data": [],
"message": [],
"status": <REST status code value>
}
A successful response displays a status code 200.
A failed response displays a message with a status code.
Sample Request
To update the rollup status for three template cash flows, send an API request in the following format:
{
"data" : [
{"name": "Cash Flow 1", "rollup_status": "Inactive"},
{"name": "Cash Flow 2", "rollup_status": "Open"},
{"name": "Cash Flow 3", "rollup_status": "Active"}
]
}
Sample Response
A partial success / failure response is returned with a status code 3000 to the above request, wherein:
- Rollup status of Summary Cash Flow 1 is successful
- Rollup status of Cash Flows 2 is not updated and displays status code 663
- Rollup status of Cash Flow 3 is not updated, and displays a status code of 1305
{
"data": [
{
"rollup_status": "Active",
"name": "Cash Flow 1",
"id": "61"
}
],
"message": [
{
"name": "Cash Flow 1",
"message": "success",
"status": 200
},
{
"name": "Cash Flow 2",
"message": "Status field value is not correct.",
"status": 663
},
{
"name": "Cash Flow 3",
"message": "Cash Flow do not exist",
"status": 1305
}
],
"status": 3000
}