Create Cash Flow

POST /ws/rest/service/v1/cashflow/{project_number}

Purpose:

Create cash flow from a template or by specifying the property values.

If the template name is provided, cash flow properties are created from a template in combination with input parameters specified in the request.

If template_projectid is not provided, the company template will be fetched.

Integration user used will have full access to the cash flow created. To change the permissions, Update or Modify Cashflow Permission service need to be run.

In addition to integration user, project administrator/company administrator will have full access to the cash flow created from service.

Period name is not accepted from the input JSON. If provided, will be ignored.

Irrelevant attributes specified in the request for create/update are ignored.

Input:

All parameters should be URL encoded.

Path Parameter

project_number: Required

When creating cash flow from template specify the below values in the data JSON

template_name:Required

template_project: optional. Project number of the template.

Post data JSON will be details of cash flow

For the input attributes provided, the data will be used from the input request -

Example

If name, template, and schedule details are specified in the input request, then the cash flow will be created with template details but the schedule will be as per the input request.

Defaults will be used if data is not provided in the input request.

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

A message will be present if the status is not 200 otherwise it will be "success".

The ser can provide Effective_date in Actuals Curve at CBS/Summary CBS level if Set Effective Date is selected as Yes.

Format is mentioned in Actuals Curve Request, below:

See Also

Cash Flow

Definitions or Values Used

Authorization

Response Error Codes (REST API Details in Cash Flow)

Create Summary Curve

Create Rollup Cash Flows for Program or Company

Update Rollup Cash Flows for Program or Company

Delete Cash Flow

Delete Cash Flow - Summary Curves

Get Cash Flow Data

Get Summary Cash Flow Data

Get Rollup Status

Get Rollup Status - for Template Cash Flows

Update Rollup Status

Update Rollup Status - For Template Cash Flows

Refresh Cash Flow

Get Cash Flow Refresh Job Status

Get Cash Flow Properties

Get Summary Cash Flow Properties

Get Cash Flow Permissions

Update or Modify Cash Flow Permission

Create (Add User or Group) Cash Flow Permission

Delete (Remove User or Group) Cash Flow Permission

Update Cash Flow

Update Cash Flow Data

Create Distribution Profiles

Get Distribution Profiles

Update Distribution Profiles

Delete Distribution Profiles

Refresh Cash Flow Curves

Get Cash Flow Permissions

In This Section

Create Cash Flow From Template Only

Create Cash Flow Manual - Project or Shell

Create Cash Flow Manual - CBS

Create Cash Flow Manual - Summary CBS

Create Cash Flow Manual - Commitment



Last Published Friday, December 13, 2024