Get Summary Cash Flow Properties
GET /ws/rest/service/v1/cashflow/summary/{project_number}
Purpose
Get Summary Cash Flow properties
Request Format
All parameters should be URL encoded.
Path Parameter
project_number(Mandatory): Specify the project/Shell number to get project cash flow properties
input query parameter -
filter=
{
"names":["Summary Cash Flow 1" ,"Summary Cash Flow 2"]
}
Filter can be used to filter on name to get the summary cash flow properties. If summary cashflow does not exist with the given name, that name will be ignored.
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": [
{
"curves": [
"Cash Flow 1",
"Cash flow 2"
],
"name": "Sum Cash Flow 1",
"description": "This summary curve is created from REST API",
"summary_type": "User_Defined",
"status": "Active"
}
],
"message": [ "success" ],
"status": 200
}
Related Topics
Response Error Codes (REST API Details in Cash Flow)
Create Rollup Cash Flows for Company
Update Rollup Cash Flows for Company
Delete Cash Flow - Summary Curves
Get Rollup Status - for Template Cash Flows
Update Rollup Status - For Template Cash Flows
Get Cash Flow Refresh Job Status
Create (Add User or Group) Cash Flow Permission
Delete (Remove User or Group) Cash Flow Permission
Update or Modify Cash Flow Permission
Last Published Tuesday, July 1, 2025