GET /ws/rest/service/v1/cashflow/{project_number}
Purpose:
Get Cashflow properties
Input:
All parameters should be URL encoded.
Path Parameter
project_number: optional, if not provided then company cash flow will be fetched.
input query parameter -
filter=
{
"names":["Cash Flow 1" ,"Cash Flow 2"]
}
Supported options in filter:
"names": "CBS CF"
"curve_name": << Name of The Curve>>
"rollup_status"<<Active><Inactive>>
If rollup_status value provided is other than above mentioned values, invalid options message will be thrown.
"detail_level"<<Summary CBS>< CBS><Project / Shell><Commitment>>
If detail_level value provided is other than above mentioned values, invalid options message will be thrown.
"include_curves":<< Yes/ No>> <!-- default is Yes if not provided→>
If include_curves value provided is other than above mentioned values, invalid options message will be thrown.
Note: if no filter options provided service will return all cashflow curves from the project.
Output:
JSON object containing 'status', 'data', 'message'
Status codes are:
1> 200 OK , if success
For Partial failure, relevant message will be displayed.
Project or 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,
"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
}
CBS
{
"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": "Protfolio 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
}
Summary CBS
{
"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
}
Commitment Type
{
"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": "{ Purchase Orders:Creation Date:Creation Date:Back Loaded }{ PO Amendments:Creation Date:Creation Date:Linear }"},
"bp_dates_profile": [
{
"bp_name": "Purchase Orders",
"todate": "uuu_creation_date ",
"profile": "Front Loaded",
"fromdate": "ugenP6PlannedStartDOP"
}
],
"commit_change_processes": "{PO Amendments:Approved}{PO Amendments:Canceled}{PO Amendments:Rejected}"
"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
}
{
"data": [
{
"id": 670,
"name": "P-0006",
"description": null,
"rollup_status": "Active",
"detail_level": "Commitment",
"bp_name": "Purchase Orders",
"reference_elements": "record_no:record_no",
"base_commit_record": "PO-0005",
"period_type": "Financial Periods",
"period_name": "FP_02",
"period_by": "Custom",
"decimal_places": 2,
"schedule": {
"enable_refresh": true,
"frequency": "Quarterly",
"quarterday": 4,
"startdate": "06/24/2019",
"noenddate": false,
"enddate": "06/24/2020"
},
"curves": [
{
"id": 930,
"name": "Forecast",
"type": "Forecast",
"cashflow_granularity": "by_lineitem",
"distribution": {
"type": "manual"
},
"commit_change_processes": [],
"forecast_options": {}
},
{
"id": 931,
"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": "Back Loaded",
"fromdate": "ugenP6PlannedStartDOP"
},
{
"bp_name": "PO Amendments",
"todate": "ugenP6PlannedFinishDOP",
"profile": "Linear",
"fromdate": "due_date"
}
]
},
"commit_change_processes": [
{
"bp_name": "PO Amendments",
"status": "Approved"
},
{
"bp_name": "PO Amendments",
"status": "Pending"
}
]
},
{
"id": 957,
"name": "Actuals",
"type": "Spends",
"cashflow_granularity": "by_lineitem",
"cost": {
"spends_bp": [
{
"bp_name": "Invoices",
"status": "Approved"
},
{
"bp_name": "Invoices",
"status": "Pending"
}
]
}
},
{
"id": 958,
"name": "Approved Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "Belize Dollar (BZD)",
"distribut_amount_from": "approved"
}
},
{
"id": 959,
"name": "Shared Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "Indian Rupee (INR)",
"distribut_amount_from": "shared"
}
},
{
"id": 960,
"name": "Original Budget",
"type": "Portfolio Budget",
"cost": {
"currency_code": "Malta Lira (MTL)",
"distribut_amount_from": "original"
}
},
{
"id": 961,
"name": "Derived",
"type": "Derived",
"cost": {
"base_currency": "United States Dollar (USD)",
"source_curve_name": "Baseline",
"derived_curve_currency": "Belize Dollar (BZD)",
"exchange_rate": "Float",
"float_rate_as": "weighted_period"
}
}
],
"summary": [
{
"name": "Cash Flow Summary Curve",
"summary_type": "System_Defined"
}
]
}
],
"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"
}
Company or Program Level
{
"data": [
{
"name": "Company cashflow- roll up curves",
"description": null,
"status": "Active",
"detail_level": "Company", ?????????????? do we need to include for company/program level as they are not detail level curves
"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
}