Get Rollup Status

GET /ws/rest/service/v1/cashflow/rollup/status/{project_number}

Purpose

Get Cashflow Rollup Status

Request Format

All parameters should be URL encoded.

Request Parameters

project_number(Required): Specify the project/shell number to get the rollup status of project cash flows

url parameter(Optional)

filter= {"names":["Cash Flow 1" ,"Cash Flow 2"] }

Filter can be used to filter on name to get the cash flow rollup status. If cash flow does not exist with the given name, that name will be ignored. Cashflows of other names will be returned.

If project number is not specified in the URL, an error message will be returned

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

The following is an example of a success response that displays the status of a Cash Flow Rollup.

{

"data": [

{

"name": "Cash Flow 1",

"id": "21",

"status": "Active"

}

],

"message": [ "success" ],

"status": 200

}

Purpose

Request Format

Request Parameters

Response Format

Sample Success Response

Related Topics