Get Cash Flow Refresh Job Status

GET /ws/rest/service/v1/cashflow/jobs/{job_id}

Purpose

To retrieve cash flow refresh job status

Request Format

All parameters should be URL encoded.

Request Parameter

job_id: Required

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 Success Response

{

"data":"",

"job_status":"Finished",

"status_code":200,

"message":"OK"

}

when a job is in progress:

{

"data":"",

"job_status":"In progress",

"status_code":200,

"message":"OK"

}

Sample Failed Response

{

"data":"Failure detail",

"job_status":"Finished with errors",

"status_code":1006,

"message":"Job processing failed with errors."

}

Related Topics

Cash Flow

Authorization

Definitions or Values Used

Response Error Codes (REST API Details in Cash Flow)

Create Cash Flow

Create Summary Curve

Create Rollup Cash Flows for Company

Update Rollup Cash Flows for Company

Delete Cash Flow

Delete Cash Flow Curve

Delete Cash Flow - Summary Curves

Get Cash Flow Data

Get Summary Cash Flow Data

Get Rollup Status

Get Rollup Status - for Template Cash Flows

Update Rollup Status

Update Rollup Status - For Template Cash Flows

Refresh Cash Flow

Get Cash Flow Properties

Get Summary Cash Flow Properties

Get Cash Flow Permissions

Get Distribution Profiles

Create (Add User or Group) Cash Flow Permission

Delete (Remove User or Group) Cash Flow Permission

Update Cash Flow Properties

Update or Modify Cash Flow Permission

Update Cash Flow Data

Update Cash Flow Schedule

Create Distribution Profiles

Update Distribution Profiles

Delete Distribution Profiles

Refresh Cash Flow Curves

Get Cash Flow Permissions



Last Published Tuesday, July 1, 2025