Oracle Primavera Cloud REST API

Batch Update Project Cashflows

put

/api/restapi/projectCashflows/batch

Send a request to this endpoint to update one or more project cashflows. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : List<ApiEntityProjectCashFlowInput>

Type: array

Title: List<ApiEntityProjectCashFlowInput>

Show Source

Array of: object ApiEntityProjectCashFlowInput
Title: ApiEntityProjectCashFlowInput
This entity represents a ProjectCashFlow object, a unique ProjectCashFlow object can be identified by the following combinations of the fields.
- projectPhaseFinancialId
- month,year,projectId
- month,year,projectCode,workspaceCode
- spreadDate,projectId
- spreadDate,projectCode,workspaceCode

{
    "title":"List<ApiEntityProjectCashFlowInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProjectCashFlowInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProjectCashFlowInput

Type: object

Title: ApiEntityProjectCashFlowInput

This entity represents a ProjectCashFlow object, a unique ProjectCashFlow object can be identified by the following combinations of the fields.

projectPhaseFinancialId
month,year,projectId
month,year,projectCode,workspaceCode
spreadDate,projectId
spreadDate,projectCode,workspaceCode

Show Source

actualCapitalCostProject: number (double)

The time phased actual capital spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.
actualExpenseCostProject: number (double)

The time phased actual expense spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.
benefitsProject: number (double)

Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the project currency.
forecastCapitalCostProject: number (double)

The time phased estimation of a project's remaining capital costs.
After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the project currency.
forecastCostProject: number (double)

The time phased estimation of a project's remaining costs.
After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the project currency.
forecastExpenseCostProject: number (double)

The time phased estimation of a project's remaining expense costs.
After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the project currency.
month: integer (int32)

The time period during which budget planning for the project takes place in months.
plannedBudgetCapitalProject: number (double)

The planned time phased capital cost in project currency of a project as defined by the project manager.
Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.
plannedBudgetExpenseProject: number (double)

The planned time phased expense cost in project currency of a project as defined by the project manager.
Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.
plannedBudgetProject: number (double)

The planned time phased cost in project currency of a project as defined by the project manager.
Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.
projectCode: string

Minimum Length: 1

Maximum Length: 60

The unique identifier for a project set by the user who created the project.
projectId: integer (int64)

The unique identifier for the project.
projectPhaseFinancialId: integer (int64)

The unique internal identifier for the project's time-phased cost spread. This value should not be provided in create operation request data, however, it is required for update requests.
spendCostProject: number (double)

The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.
spreadDate: string (date-time)

The starting date for a time phase of the project life cycle.
workspaceCode: string

Minimum Length: 0

Maximum Length: 60

The user-specified identifier of a workspace.
year: integer (int32)

The time period during which budget planning for the project takes place in years.

{
    "title":"ApiEntityProjectCashFlowInput",
    "type":"object",
    "properties":{
        "year":{
            "type":"integer",
            "description":"The time period during which budget planning for the project takes place in years.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "month":{
            "type":"integer",
            "description":"The time period during which budget planning for the project takes place in months.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "benefitsProject":{
            "type":"number",
            "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spreadDate":{
            "type":"string",
            "description":"The starting date for a time phase of the project life cycle.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectPhaseFinancialId":{
            "type":"integer",
            "description":"The unique internal identifier for the project's time-phased cost spread. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "forecastCostProject":{
            "type":"number",
            "description":"The time phased estimation of a project's remaining costs. <br />After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. <br />Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetProject":{
            "type":"number",
            "description":"The planned time phased cost in project currency of a project as defined by the project manager. <br />Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCostProject":{
            "type":"number",
            "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostProject":{
            "type":"number",
            "description":"The time phased actual capital spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostProject":{
            "type":"number",
            "description":"The time phased estimation of a project's remaining capital costs. <br />After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. <br />Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalProject":{
            "type":"number",
            "description":"The planned time phased capital cost in project currency of a project as defined by the project manager. <br />Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostProject":{
            "type":"number",
            "description":"The time phased estimation of a project's remaining expense costs. <br />After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. <br />Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseProject":{
            "type":"number",
            "description":"The planned time phased expense cost in project currency of a project as defined by the project manager. <br />Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostProject":{
            "type":"number",
            "description":"The time phased actual expense spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProjectCashFlow object, a unique ProjectCashFlow object can be identified by the following combinations of the fields.<ul><li>projectPhaseFinancialId</li><li>month,year,projectId</li><li>month,year,projectCode,workspaceCode</li><li>spreadDate,projectId</li><li>spreadDate,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Response

200 Response

A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}

400 Response

Invalid input for the Project Cashflow service.