Get Cash Flow Refresh Job Status
GET /ws/rest/service/v1/cashflow/jobs/{job_id}
Purpose:
To retrieve cash flow refresh job status
Input:
All parameters should be URL encoded.
Path Parameter
job_id: Required
Output:
JSON object containing 'status', 'data', 'message'
Status codes are:
1> 200 OK , if success
For Partial failure, relevant message will be displayed.
Refresh Cashflow Job status Sample Response
1) on success.
{
"data":"",
"job_status":"Finished",
"status_code":200,
"message":"OK"
}
2) when job is in progress.
{
"data":"",
"job_status":"In progress",
"status_code":200,
"message":"OK"
}
3) when job has failed.
{
"data":"Failure detail",
"job_status":"Finished with errors",
"status_code":1006,
"message":"Job processing failed with errors."
}
Related Topics
Response Error Codes (REST API Details in Cash Flow)
Create Rollup Cash Flows for Program or Company
Update Rollup Cash Flows for Program or Company
Delete Cash Flow - Summary Curves
Get Rollup Status - for Template Cash Flows
Update Rollup Status - For Template Cash Flows
Get Summary Cash Flow Properties
Update or Modify Cash Flow Permission
Create (Add User or Group) Cash Flow Permission
Delete (Remove User or Group) Cash Flow Permission
Last Published Friday, December 13, 2024