Create Rollup Cash Flows for Company

POST /ws/rest/service/v1/cashflow/rollup/

Purpose:

Create Rollup Cash Flows.

Input:

All parameters should be URL encoded.

Path Parameter

Both input & output in JSON format in the body

In the input request:

"name" (Required)

"status" (Optional): If not specified then by default 'Active' will be taken.

"data_source" (Optional): List of data sources, which has to be part of the rollup curve. If no value is specified then the rollup curve will be created without any data sources.

"period_type" (Required): If no value is given then by default "Standard Planning Period" will be taken

"period_by": Is Required if period_type is "Standard Planning Period" and by default 'Year' will be taken.

"period_format": Is Required if period_type is "Standard Planning Period" and by default 'YYYY' will be taken.

"period_name": Is Required if period_type is "Financial Periods"

"decimal_places" (Optional)

Output:

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

The data will contain the name and the id of the rollup curve which was created successfully. The message will contain the status of the curve creation for all the input data.

Status codes are:

1> 200 , for success

2> 3000, for Partial success.

Create Rollup Cash Flows Input JSON

{

"data": [

{

"template": "Rollup Template"

"name": "Rollup Curve 1",

"status": "Active",

"period_type": "Standard Planning Period",

"period_name": "Standard Planning Period",

"period_by": "Year",

"period_format": "YYYY",

"decimal_places": 5,

"data_source": [

{

"name": "Baseline",

"curve_type": "Baseline"

},

{

"name": "Vendor Approved Budget",

"curve_type": "Baseline"

}

]

},

{

"name": "Rollup Curve 3",

"status": "Active",

"period_type": "Financial Periods",

"period_name": "FP",

"decimal_places": 5,

"data_source": []

}

]

}

Create Rollup Cash Flows Output JSON

{

"data":[

{

"id": "208"

"name": "Rollup Curve 1",

"status": "Active",

"period_type": "Standard Planning Period",

"period_name": "Standard Planning Period",

"period_by": "Year",

"period_format": "YYYY",

"decimal_places": 5,

"data_source": [

{

"name": "Baseline",

"curve_type": "Baseline"

},

{

"name": "Vendor Approved Budget",

"curve_type": "Baseline"

}

]

}

],

"message":[

{

"name":"Rollup Curve 1",

"status":"200",

"message":"success"

},

{

"name":"Rollup Curve 3",

"status": 1303,

"message": "CashFlow data provided is not valid for field : period_name"

}

],

"status":3000

}

Related Topics