Get Cash Flow Properties
GET /ws/rest/service/v1/cashflow/{project_number}
Purpose
Get cash flow properties.
Request Format
Send an API Get request in the following format with all parameters URL-encoded.
GET /ws/rest/service/v1/cashflow/{project_number}
{
filter
{
"names":<cashflow 1, cashflow 2>
"curve_name":<value>
"rollup_status":<value>
"detail_level":<value>
"include_curves":<value>
}
}
For CBS/Summary CBS, if the Set Effective Date is Yes then you can see the Effective Date distribution details in the Actuals Curve.
Request Parameters
The following parameters can be included in the request:
Request Parameters | Required? | Data Type | Description |
|---|---|---|---|
project_number | No | String | If the project_number is not provided, the company cash flow is fetched. |
filter | No | String | If a filter is not specified, then all cash flow curves from the project are returned. The following filter options are supported:
|
Response Format
The REST service returns a JSON map in the following format:
{
"data": [],
"message": [],
"status": <REST status code value>
}
A successful request returns a status code 200.
A failed request displays a status code and a message in the response.
Sample Response: Cash Flow Properties for Project/Shell
This is an example of a response for cash flow properties returned for a project/shell.
{
"data": [
{
"name": "Project_CF",
"description": "test webservice get Cashflow Properties",
"rollup_status": "Active",
"detail_level": "Project / Shell",
"period_type": "Standard Planning Period",
"period_name": "Standard Planning Period",
"period_by": "Month",
"period_format": "M YYYY",
"decimal_places": 8,
"decimal_option": "0"
"snapshot": {
"snapshot_day_of": 1,
"cutoff_spends": {
"cutoff_week_num": "First",
"cutoff_week_day": "Sunday",
"inc_spends_opt": "next_month"
}
},
"curves": [
{
"name": "Baseline",
"type": "Baseline",
"distribution": {
"type": "auto_profile",
"distribution_profile": "Front Loaded"
},
"cost": {
"type": "auto_distribution"
},
"schedule": {
"type": "schedule_sheet",
"sheet_name": "sheet3",
"sch_start_source": "Estimated Finish Date",
"sch_end_source": "Estimated Start Date"
}
},
{
"name": "Forecast",
"type": "Forecast",
"distribution": {
"type": "manual"
},
"cost": {
"type": "manual"
},
"schedule": {
"type": "schedule_sheet",
"sheet_name": "Sheet1",
"sch_start_source": "AP_Date6",
"sch_end_source": "AP_Date only 1"
},
"forecast_options": {
"begin_end_of_curve": true,
"fc_curve_name": "Actuals",
"current_actual_cut_off_date": true,
"edit_until_replace_by_actual": true
}
},
{
"name": "Actuals",
"type": "Spends",
"cost": {
"cost_sheet_column": "Purchase Orders (Pending)",
"type": "cost_sheet"
}
},
{
"name": "Original Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "United States Dollar (USD)",
"distribut_amount_from": "original"
}
},
{
"name": "Approved Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "RADO",
"distribut_amount_from": "approved"
}
},
{
"name": "Shared Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "Afghani (AFN)",
"distribut_amount_from": "shared"
}
},
{
"name": "custom_D",
"type": "Derived",
"cost": {
"base_currency": "United States Dollar (USD)",
"source_curve_name": "Baseline",
"derived_curve_currency": "Afghani (AFN)",
"exchange_rate": "Float",
"float_rate_as": "end_period"
}
}
],
"filters": {
"filter_option": "all"
},
"schedule":{
"enable_refresh" : true,
"frequency" : "Quarterly",
"quarterday" : 4,
"startdate": "2019/03/30",
"noenddate": false,
"enddate" : "2020/03/30"
},
"summary_curves":[
{
"name":"curve_1",
"summary_type" : "System Defined",
"status" : "Active"
},
{
"name":"curve_2",
"summary_type" : "System Defined",
"status" : "Active"
}
]
}
],
"message": [
"success"
],
"status": 200
}
Sample Response: Cash Flow Properties for CBS
This is an example of a response received for the cash flow properties of a CBS cash flow.
{
"data": [
{
"name": "CBS_CF",
"description": "CBS Cashflow",
"rollup_status": "Active",
"detail_level": "CBS",
"period_type": "Standard Planning Period",
"period_name": "Standard Planning Period",
"period_by": "Year",
"period_format": "YYYY",
"decimal_places": 3,
"snapshot": {
"snapshot_week_num": 1,
"snapshot_week_day": "1"
},
"curves": [
{
"name": "Actuals",
"type": "Spends",
"cost": {
"cost_sheet_column": "Purchase Orders (Pending)",
"type": "cost_sheet"
}
},
{
"name": "Baseline",
"type": "Baseline",
"distribution": {
"type": "auto_profile",
"cbs": [
{
"cbs_code": "s1-a 1-b 1-a123~~s3-a 2-b 1-a123",
"bitemid": 13,
"item": "A123",
"default_profile": "Front Loaded"
},
{
"cbs_code": "s1-a 1-b 1-a123~~s2-a 2-b 1-a123",
"bitemid": 12,
"item": "A123",
"default_profile": null
}
]
},
"cost": {
"type": "auto_distribution"
},
"schedule": {
"type": "schedule_sheet",
"sheet_name": "Sheet1",
"sch_start_source": "Finish date",
"sch_end_source": "Late Start date"
}
},
{
"name": "Forecast",
"type": "Forecast",
"distribution": {
"type": "schedule_sheet",
"sch_sheet_name": "sheet2"
},
"cost": {
"type": "manual"
},
"schedule": {
"type": "manual"
},
"forecast_options": {
"begin_end_of_curve": true,
"fc_curve_name": "Actuals",
"current_actual_cut_off_date": true,
"fc_dist": "weighted_avg_over_next",
"periods": 1
}
},
{
"name": "Portfolio Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "Costa Rica Colon (CRC)",
"distribut_amount_from": "original"
}
},
{
"name": "custom_D",
"type": "Derived",
"cost": {
"base_currency": "United States Dollar (USD)",
"source_curve_name": "Actuals",
"derived_curve_currency": "Bhutan Ngultrum (BTN)",
"exchange_rate": "Float",
"float_rate_as": "weighted_period"
}
},
{
"name": "Approved Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "Bhutan Ngultrum (BTN)",
"distribut_amount_from": "approved"
}
},
{
"name": "Original Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "RADO",
"distribut_amount_from": "original"
}
},
{
"name": "Shared Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "RADO",
"distribut_amount_from": "shared"
}
},
{
"name": "Derive",
"type": "Derived",
"cost": {
"base_currency": "United States Dollar (USD)",
"source_curve_name": "Forecast",
"derived_curve_currency": "Dirham (AED)",
"exchange_rate": "Float",
"float_rate_as": "beginning_period"
}
},
{
"name": "Forecast 2",
"type": "Forecast",
"distribution": {
"type": "manual"
},
"cost": {
"type": "manual"
},
"schedule": {
"type": "p6_sheet",
"p6_datasource": "Original Baseline",
"sch_dates_type": "At Completion"
},
"forecast_options": {}
}
],
"filters": {
"filter_option": "all"
},
"schedule":{
"enable_refresh" : true,
"frequency" : "Quarterly",
"quarterday" : 4,
"startdate": "2019/03/30",
"noenddate": false,
"enddate" : "2020/03/30"
},
"summary_curves":[
{
"name":"curve_1",
"summary_type" : "System Defined",
"status" : "Active"
},
{
"name":"curve_2",
"summary_type" : "System Defined",
"status" : "Active"
}
]
}
],
"message": [
"success"
],
"status": 200
}
Sample Response: Cash Flow Properties for Summary CBS
This is an example of a response received for the cash flow properties of a Summary CBS cash flow.
{
"data": [
{
"name": "SummaryCBS_CF",
"description": "SummaryCBS_CF for Cashflow Properties",
"rollup_status": "Active",
"detail_level": "Summary CBS",
"period_type": "Standard Planning Period",
"period_name": "Standard Planning Period",
"period_by": "Month",
"period_format": "M YYYY",
"decimal_places": 3,
"snapshot": {
"snapshot_week_num": 1,
"snapshot_week_day": "2",
"cutoff_spends": {
"cutoff_week_num": 2,
"cutoff_week_day": "6",
"inc_spends_opt": "next_month"
}
},
"curves": [
{
"name": "Actuals",
"type": "Spends",
"cost": {
"cost_sheet_column": "Purchase Orders (Pending)",
"type": "cost_sheet"
}
},
{
"name": "Baseline",
"type": "Baseline",
"distribution": {
"type": "auto_profile"
},
"cost": {
"type": "cost_sheet",
"cost_sheet_column": "Purchase Orders (Pending)"
},
"schedule": {
"type": "schedule_sheet",
"sheet_name": "Sheet1",
"sch_start_source": "Start date",
"sch_end_source": "Finish date"
}
},
{
"name": "Forecast",
"type": "Forecast",
"distribution": {
"type": "manual"
},
"cost": {
"type": "manual"
},
"schedule": {
"type": "manual"
},
"forecast_options": {}
},
{
"name": "Approved Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "test",
"distribut_amount_from": "approved"
}
},
{
"name": "Original Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "Yen (JPY)",
"distribut_amount_from": "original"
}
},
{
"name": "Shared Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "Algeria Dinar (DZD)",
"distribut_amount_from": "shared"
}
},
{
"name": "Derive",
"type": "Derived",
"cost": {
"base_currency": "United States Dollar (USD)",
"source_curve_name": "Baseline",
"derived_curve_currency": "Bhutan Ngultrum (BTN)",
"exchange_rate": "Float",
"float_rate_as": "beginning_period"
}
}
],
"filters": {
"filter_option": "all"
},
"schedule":{
"enable_refresh" : true,
"frequency" : "Quarterly",
"quarterday" : 4,
"startdate": "2019/03/30",
"noenddate": false,
"enddate" : "2020/03/30"
},
"summary_curves":[
{
"name":"curve_1",
"summary_type" : "System Defined",
"status" : "Active"
},
{
"name":"curve_2",
"summary_type" : "System Defined",
"status" : "Active"
}
]
}
],
"message": [
"success"
],
"status": 200
}
Sample Response: Cash Flow Properties for Commitment Type
This is an example of a response received for the cash flow properties of a Commitment Type cash flow.
{
"data": [
{
"name": "Commitment_CF",
"description": "commit",
"rollup_status": "Active",
"detail_level": "Commitment",
"bp_name": "Purchase Orders",
"reference_elements": "record_no:Record No.",
"base_commit_record": "PO-0001",
"period_type": "Standard Planning Period",
"period_name": "Standard Planning Period",
"period_by": "Month",
"period_format": "M YYYY",
"decimal_places": 2,
"curves": [
{
"name": "Actuals",
"type": "Spends",
"cashflow_granularity": "by_lineitem",
"cost": {
"spends_bp": [{"bp_name" :"A_Commit_01", "status":"Approved"}]
}
},
{
"name": "Baseline",
"type": "Baseline",
"cashflow_granularity": "individual_record",
"distribution": {
"type": "auto_profile",
"commit_profile": "business_process",
"bp_dates_profile": [
{
"bp_name": "Purchase Orders",
"todate": "uuu_creation_date ",
"profile": "Front Loaded",
"fromdate": "ugenP6PlannedStartDOP"
}
],
"commit_change_processes": [
{
"bp_name": "PO Amendments",
"status": "Approved"
},
{
"bp_name": "PO Amendments",
"status": "Canceled"
},
{
"bp_name": "PO Amendments",
"status": "Pending"
},
{
"bp_name": "PO Amendments",
"status": "Rejected"
}
]
},
{
"name": "Forecast",
"type": "Forecast",
"cashflow_granularity": "by_lineitem",
"distribution": { "type": "manual" },
"commit_change_processes": "",
"forecast_options": {}
},
{
"name": "Approved Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "Costa Rica Colon (CRC)",
"distribut_amount_from": "approved"
}
},
{
"name": "Shared Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "Dirham (AED)",
"distribut_amount_from": "shared"
}
},
{
"name": "Original Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "Afghani (AFN)",
"distribut_amount_from": "original"
}
},
{
"name": "Derive",
"type": "Derived",
"cost": {
"base_currency": "United States Dollar (USD)",
"source_curve_name": "Baseline",
"derived_curve_currency": "Costa Rica Colon (CRC)",
"exchange_rate": "Float",
"float_rate_as": "weighted_period"
}
}
],
"schedule":{
"enable_refresh" : true,
"frequency" : "Quarterly",
"quarterday" : 4,
"startdate": "2019/03/30 00:00",
"noenddate": false,
"enddate": "2020/03/31 00:00"
},
"summary_curves":[
{
"name":"curve_1",
"summary_type" : "System Defined",
"status" : "Active"
},
{
"name":"curve_2",
"summary_type" : "System Defined",
"status" : "Active"
}
]
}
],
"message": [
"success"
],
"status": 200
}
All Possible Schedule Values
"schedule":{
"enable_refresh" : false
}
"schedule":{
"enable_refresh" : true,
"frequency" : "Daily",
"startdate": "2019/03/30 00:00",
"noenddate": true,
"enddate": null
}
"schedule":{
"enable_refresh" : true,
"frequency" : "Weekly",
"weekday" : "Thursday",
"startdate": "2019/03/30 00:00",
"noenddate": false,
"enddate": "2020/03/31 00:00"
}
"schedule":{
"enable_refresh" : true,
"frequency" : "Monthly",
"bymonthday": true,
"monthday": 11,
"startdate": "2019/03/30 00:00",
"noenddate": false,
"enddate": "2020/03/31 00:00"
}
"schedule":{
"enable_refresh" : true,
"frequency" : "Monthly",
"bymonthday": false,
"monthweeknum" : 2
"monthweekday": "Thursday",
"startdate": "2019/03/30 00:00",
"noenddate": false,
"enddate": "2020/03/31 00:00"
}
"schedule":{
"enable_refresh" : true,
"frequency" : "Quarterly",
"quarterday" : 4,
"startdate": "2019/03/30 00:00",
"noenddate": false,
"enddate": "2020/03/31 00:00"
}
Sample Response: Company Level
{
"data": [
{
"name": "Company cashflow- roll up curves",
"description": null,
"status": "Active",
"period_type": "Standard Planning Period",
"period_name": "Standard Planning Period",
"period_by": "Month",
"period_format": "M YYYY",
"decimal_places": 2,
"filters": {
"filter_option": "all"
},
"data_source": [
{
"name": "Baseline",
"curve_type": "Baseline"
},
{
"name": "Forecast",
"curve_type": "Forecast"
},
{
"name": "Actuals",
"curve_type": "Spends"
}
]
}
],
"message": [
"success"
],
"status": 200
}
Sample Response: CBS Curve with Schedule from Activity Sheet
This is an example of a Cash flow curve using a schedule from an activity sheet with a Periods of Cost Distribution (as_sch_cost_dist_opt) option.
{
"data": [
{
"id": 2089,
"name": "CBS Curve",
"description": null,
"rollup_status": "Active",
"detail_level": "CBS",
"period_type": "Standard Planning Period",
"period_name": "Standard Planning Period",
"period_by": "Month",
"period_format": "M YYYY",
"decimal_option": 0,
"decimal_places": 2,
"schedule": {
"enable_refresh": false
},
"curves": [
{
"id": 9574,
"name": "Baseline",
"type": "Baseline",
"variance": null,
"distribution": {
"type": "auto_profile",
"cbs": [
{
"cbs_code": "100~~101",
"bitemid": 3,
"item": "Subcode 101",
"default_profile": "Copy of test 5"
}
]
},
"cost": {
"type": "auto_distribution"
},
"schedule": {
"type": "activity_sheet",
"sheet_name": "System Activity Sheet",
"sch_start_source": "Actual Start",
"sch_end_source": "Actual Finish",
"project_type": "Current",
"as_sch_cost_dist_opt": 1
}
}
],
"filters": {
"filter_option": "all"
},
"summary": [
{
"name": "Cash Flow Summary Curve",
"summary_type": "System_Defined"
}
]
}
],
"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
Get Summary Cash Flow Properties
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