Get Summary Cash Flow Data

GET /ws/rest/service/v1/cashflow/summary/data/{project_number}

Purpose:

Get Summary Cash Flow Curve data.

Input:

All parameters should be URL encoded.

Path Parameter

project_number (Required): Specify the project/shell number.

Url Parameter

filter (Required): Filter condition to be used when retrieving the data. It is a JSON object with the below information:

"name"(Required): Specify the cash flow name to get the data

"curves"(Optional): Specify the curve name for which the data is to be retrieved. Invalid curve name will be ignored. If no value is specified then all the curves data will be sent in the response.

Sample filter parameter

filter={ "name":"cashflow 1", "curves":[ "Baseline", "Forecast" ] }

Output:

JSON object containing 'status', 'data', 'message'

Status codes are:

1> 200 OK , if success

For Partial failure, relevant message will be displayed.

Sample output request

{

"data":[

{

"name":"cashflow 1",

"alert_message":[

{

"projectname":"Shell-Weekly",

"name":"CF-New",

"curvename":"Actuals",

"errormessage":"Curve timescale is yearly"

},

{

"projectname":"SUNEEL-RETEST-YEARLY",

"name":"CashFlow-Suneel-Retest-Yearly",

"curvename":"Actuals",

"errormessage":"Curve timescale is yearly"

}

],

"curves":[

{

"name":"Baseline",

"alert_message":"",

"currency":"Indian Rupee (INR)",

"Type":"Baseline",

"Total":"1742.56",

"From Date":"02/29/16",

"To Date":"12/30/16",

"Unassigned":"345.90",

"2 2016":"1742.56"

"details":[

{

"Number":"A0001-B0001-C0001-D0001-E0001",

"Name":"Row-00001",

"Profile":"Front Load",

"Total":"1742.56",

"From Date":"02/29/16",

"To Date":"12/30/16",

"Unassigned":"345.90",

"2 2016":"1742.56"

},

{

"Number":"A0003-B0003-C0003-D0003-E0003",

"Name":"Row-00003",

"Profile":"S Curve",

"Total":"800.56",

"From Date":"01/01/17",

"To Date":"12/30/17",

"Unassigned":"300.90",

"2 2016":"800.56"

}

]

},

{

"name":"Forecast",

"Type":"Forecast",

"alert_message":"",

"currency":"Indian Rupee (INR)",

"Total":"800.56",

"From Date":"05/05/19",

"To Date":"12/30/19",

"Unassigned":"280.43",

"2 2016":"3321.56"

"details":[

{

"Number":"A0009-B0009-C0009-D0009-E00011",

"Name":"Row-00011",

"Profile":"S Curve",

"Total":"800.56",

"From Date":"02/02/19",

"To Date":"04/12/19",

"Unassigned":"7443.20",

"2 2016":"689.53"

},

{

"Number":"A0007-B0007-C0007-D0007-E0007",

"Name":"Row-00007",

"Profile":"S Curve",

"Total":"800.56",

"From Date":"05/05/19",

"To Date":"12/30/19",

"Unassigned":"280.43",

"2 2016":"3321.56"

}

]

},

{

"alert_message":"",

"Name":"Original",

"Currency":"Canada Dollar (CAD)",

"Type":"Portfolio Budget",

"From Date":"",

"To Date":"",

"Total":"0.00",

"Unassigned":"0.00",

"1 2017":"100.00",

"2 2017":"",

}

]

}

],

"message":[

"success"

],

"status":"200"

}

Related Topics