Get Portfolio Budget Curves

GET /ws/rest/service/v2/cashflow/data?project_number=P0001&filter={"name":"cbs"}

Available From: 26.10

Purpose

Retrieve a named Cash Flow and the Portfolio Budget curves it contains. Use the response as the baseline for an update request.

Prerequisites

Ensure you have Get permissions for CashFlow Services.

Request Format

Request parameters are specified as a JSON map.

Field	Required?	Description
project_number	Yes	Project or shell number for the Cash Flow
filter.name	Yes	Cash Flow name. Supply it in the JSON filter parameter.

Sample Request

GET /ws/rest/service/v2/cashflow/data/9440?filter={"name":"cbs"}

Response Format

A successful response returns data, message, status, and rest_audit_id. Each Portfolio Budget curve can include the curve name, date range, currency, calculated total, unassigned amount, monthly period values, and details records that identify the affected project, CBS, summary CBS, or commitment.

Sample Success Response

{

"data": [{

"Name": "cbs",

"curves": [{

"Type": "Portfolio Budget",

"Name": "Shared Budget",

"From Date": "01/01/2026",

"To Date": "12/01/2026",

"Currency": "United States Dollar (USD)",

"Total": "12000.00",

"Unassigned": "0.00",

"1 2026": "1000.00",

"2 2026": "1000.00",

"details": [{ "Number": "9440", "Name": "portfolioapi" }]

}]

}],

"message": ["success"],

"status": 200,

"rest_audit_id": 7

}

Supported Validation Messages and Status Codes

The following validation messages and status codes display in the response when incorrect values are provided in the request.

Use-case Scenario	Status Code	Message or Result
Invalid curve identifier		Invalid Budget Curve
Curve not found		[Budget Curve] not found
Invalid distribution		Invalid curve distribution data