Jump to

• Request
• Response

Update Project Funds

put

/api/restapi/funds/project/batch

Send a request to this endpoint to update one or more project funds.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityFundInput>

Type: array

Title: List<ApiEntityFundInput>

Show Source

• Array of: object ApiEntityFundInput
  Title: ApiEntityFundInput

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

Nested Schema : ApiEntityFundInput

Type: object

Title: ApiEntityFundInput

Show Source

• appropriationType: string
  Allowed Values: [ "NONE", "MANUAL", "FROM_ALLOCATION" ]

  The type of appropriation.
• capitalPortfolioId: integer (int64)
  The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.
• codeValuesFund: array codeValuesFund
  The list of code values for a fund. This entity can only be used to assign codeValues or create codeValues on the fly.
• configuredFields: array configuredFields
  The list of configured fields for a fund.
• consumptionType: string
  Allowed Values: [ "NONE", "MANUAL", "FROM_ALLOCATION", "FROM_ACTUAL" ]

  The type of consumption.
• distributionType: string
  Allowed Values: [ "YEARLY", "QUARTERLY", "MONTHLY", "LUMP_SUM" ]

  Specifies how money is distributed for the fund.
• endDate(required): string (date-time)
  The date when money in the fund will no longer be available.
• fromAllocation: boolean
  Specifies whether the fund has allocations.
• fundCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identification code of the fund.
• fundCost: fundCost
  Defines the fund cost of a fund.
• fundId: integer (int64)
  The system generated identifier of a fund.
• fundName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the fund.
• fundStatus: string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  Either Active or Inactive. Inactive funds cannot be allocated or appropriated. They can only be consumed for projects or programs.
• hasAllocations: boolean
  Specifies whether the fund has allocations.
• parentFundCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identification code of the fund.
• parentFundId: integer (int64)
  The unique identification code of the parent fund.
• parentWorkspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• parentWorkspaceId: integer (int64)
  The user-specified identifier of a workspace.
• portfolioCode: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the portfolio.
• programCode: string
  Maximum Length: 60

  The user-specified unique identifier of a program.
• programId: integer (int64)
  The system-generated unique identifier of a program.
• 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.The project object can also be identified by its unique criteria.
• spreadRows: array spreadRows
  Defines the spread rows for a fund.
• startDate(required): string (date-time)
  The date when money in the fund will start being available.
• type: string
  Allowed Values: [ "WORKSPACE_FUND", "PROJECT_FUND", "PORTFOLIO_FUND", "PROGRAM_FUND" ]

  The kind of object with which the fund is associated. This can either be Project, Program or Workspace.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityFundInput",
    "required":[
        "endDate",
        "fundCode",
        "fundName",
        "startDate"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The kind of object with which the fund is associated. This can either be Project, Program or Workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "WORKSPACE_FUND",
                "PROJECT_FUND",
                "PORTFOLIO_FUND",
                "PROGRAM_FUND"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "hasAllocations":{
            "type":"boolean",
            "description":"Specifies whether the fund has allocations.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "consumptionType":{
            "type":"string",
            "description":"The type of consumption.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NONE",
                "MANUAL",
                "FROM_ALLOCATION",
                "FROM_ACTUAL"
            ]
        },
        "fromAllocation":{
            "type":"boolean",
            "description":"Specifies whether the fund has allocations.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "fundCost":{
            "description":"Defines the fund cost of a fund.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFundCostInput"
                }
            ]
        },
        "spreadRows":{
            "type":"array",
            "description":"Defines the spread rows for a fund.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundSpreadRowInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "parentFundId":{
            "type":"integer",
            "description":"The unique identification code of the parent fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValuesFund":{
            "type":"array",
            "description":"The list of code values for a fund. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueFundInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "portfolioCode":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentFundCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identification code of the fund.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "endDate":{
            "type":"string",
            "description":"The date when money in the fund will no longer be available.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the fund.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identification code of the fund.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The system generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundStatus":{
            "type":"string",
            "description":"Either Active or Inactive. Inactive funds cannot be allocated or appropriated. They can only be consumed for projects or programs.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "distributionType":{
            "type":"string",
            "description":"Specifies how money is distributed for the fund.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "YEARLY",
                "QUARTERLY",
                "MONTHLY",
                "LUMP_SUM"
            ]
        },
        "appropriationType":{
            "type":"string",
            "description":"The type of appropriation.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NONE",
                "MANUAL",
                "FROM_ALLOCATION"
            ]
        },
        "capitalPortfolioId":{
            "type":"integer",
            "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentWorkspaceId":{
            "type":"integer",
            "description":"The user-specified identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a fund.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "programCode":{
            "maxLength":60,
            "type":"string",
            "description":"The user-specified unique identifier of a program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "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"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The date when money in the fund will start being available.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentWorkspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : codeValuesFund

Type: array

The list of code values for a fund. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueFundInput
  Title: ApiEntityCodeValueFundInput

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

  • codeValueFundId
  • codeValueId
  • codeTypeId,codeValueCode
  • codeTypeCode,codeValueCode
  • codeTypeCode,parentId,codeValueCode
  • codeValueCode,codeTypeId,parentId
  • codeTypeCode,codeValueCode,projectCode
  • codeTypeCode,codeValueCode,projectId
  • codeTypeCode,codeValueCode,parentId,projectCode
  • codeTypeCode,codeValueCode,parentId,projectId

{
    "type":"array",
    "description":"The list of code values for a fund. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueFundInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a fund.

Show Source

• Array of: object ApiEntityFundConfiguredFieldValueInput
  Title: ApiEntityFundConfiguredFieldValueInput

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

  • fundConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"The list of configured fields for a fund.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityFundConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : fundCost

Defines the fund cost of a fund.

Match All

Defines the fund cost of a fund.

Show Source

• object ApiEntityFundCostInput
  Title: ApiEntityFundCostInput

{
    "description":"Defines the fund cost of a fund.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityFundCostInput"
        }
    ]
}

Nested Schema : spreadRows

Type: array

Defines the spread rows for a fund.

Show Source

• Array of: object ApiEntityFundSpreadRowInput
  Title: ApiEntityFundSpreadRowInput

{
    "type":"array",
    "description":"Defines the spread rows for a fund.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityFundSpreadRowInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCodeValueFundInput

Type: object

Title: ApiEntityCodeValueFundInput

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

• codeValueFundId
• codeValueId
• codeTypeId,codeValueCode
• codeTypeCode,codeValueCode
• codeTypeCode,parentId,codeValueCode
• codeValueCode,codeTypeId,parentId
• codeTypeCode,codeValueCode,projectCode
• codeTypeCode,codeValueCode,projectId
• codeTypeCode,codeValueCode,parentId,projectCode
• codeTypeCode,codeValueCode,parentId,projectId

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Minimum Length: 0

  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId(required): integer (int64)
  The unique identifier for the code type.The code type object can also be identified by its unique criteria.
• codeValueCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueFundId: integer (int64)
  The unique identifier for the fund.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• fundId: integer (int64)
  The unique identification code of the fund.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code of a Project of a Project CodeType.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.

{
    "title":"ApiEntityCodeValueFundInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "codeValueFundId":{
            "type":"integer",
            "description":"The unique identifier for the fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The unique identification code of the fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeValueFund object, a unique CodeValueFund object can be identified by the following combinations of the fields.<ul><li>codeValueFundId</li><li>codeValueId</li><li>codeTypeId,codeValueCode</li><li>codeTypeCode,codeValueCode</li><li>codeTypeCode,parentId,codeValueCode</li><li>codeValueCode,codeTypeId,parentId</li><li>codeTypeCode,codeValueCode,projectCode</li><li>codeTypeCode,codeValueCode,projectId</li><li>codeTypeCode,codeValueCode,parentId,projectCode</li><li>codeTypeCode,codeValueCode,parentId,projectId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundConfiguredFieldValueInput

Type: object

Title: ApiEntityFundConfiguredFieldValueInput

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

• fundConfiguredFieldValueId
• columnDefinitionId
• columnName
• columnLabel

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• fundConfiguredFieldValueId: integer (int64)
  The unique identifier for funds configured field
• fundId: integer (int64)
  The system-generated identifier for funds
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.

{
    "title":"ApiEntityFundConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "fundId":{
            "type":"integer",
            "description":"The system-generated identifier for funds",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for funds configured field",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a FundConfiguredFieldValue object, a unique FundConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>fundConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundCostInput

Type: object

Title: ApiEntityFundCostInput

Show Source

• allocatedCOR: number (double)
  The portion of the fund that has been committed to work on a project. This is an input field, will not be a part of response.
• allocatedProject: number (double)
  The portion of the fund that has been committed to work on a project. This value is based on the project currency.
• appropriatedCOR: number (double)
  Minimum Value: 0

  The portion of the fund that has been committed to work on a project. This is an input field, will not be a part of response.
• appropriatedProject: number (double)
  Minimum Value: 0

  The portion of the fund that has been committed to work on a project. This value is based on the project currency.
• consumedCOR: number (double)
  The portion of the fund that has been spent to complete work on a project. This is an input field, will not be a part of response.
• consumedProject: number (double)
  The portion of the fund that has been spent to complete work on a project. The portion of the fund that has been spent to complete work on a project. This value is based on the project currency.
• distributedTotalCOR: number (double)
  The amount of money that has been distributed for the fund. This is an input field, will not be a part of response.
• distributedTotalProject: number (double)
  The amount of money that has been distributed for the fund. This value is based on the project currency.
• fundId: integer (int64)
  The system generated identifier of a fund.
• remainingCOR: number (double)
  The portion of the fund that has not been consumed. This is an input field, will not be a part of response.
• remainingProject: number (double)
  The portion of the fund that has not been consumed. This value is based on the project currency.
• totalCOR: number (double)
  Minimum Value: 0

  The amount of money granted for the fund. This is an input field, will not be a part of response.
• totalProject: number (double)
  Minimum Value: 0

  The amount of money granted for the fund. This value is based on the project currency.
• unallocatedCOR: number (double)
  The portion of the fund that has not been reserved for work on projects or in other workspaces. This is an input field, will not be a part of response.
• unallocatedProject: number (double)
  The portion of the fund that has not been reserved for work on projects or in other workspaces. This value is based on the project currency.
• unappropriatedCOR: number (double)
  The portion of the fund that has not yet been committed to actual work. This is an input field, will not be a part of response.
• unappropriatedProject: number (double)
  The portion of the fund that has not yet been committed to actual work. This value is based on the project currency.
• undistributedTotalCOR: number (double)
  The amount of money that has not been distributed for the fund. This is an input field, will not be a part of response.
• undistributedTotalProject: number (double)
  The amount of money that has not been distributed for the fund. This value is based on the project currency.

{
    "title":"ApiEntityFundCostInput",
    "type":"object",
    "properties":{
        "totalProject":{
            "minimum":0,
            "type":"number",
            "description":"The amount of money granted for the fund. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedProject":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on a project. The portion of the fund that has been spent to complete work on a project. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "fundId":{
            "type":"integer",
            "description":"The system generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "unappropriatedProject":{
            "type":"number",
            "description":"The portion of the fund that has not yet been committed to actual work. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedProject":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on a project. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingProject":{
            "type":"number",
            "description":"The portion of the fund that has not been consumed. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedProject":{
            "minimum":0,
            "type":"number",
            "description":"The portion of the fund that has been committed to work on a project. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedTotalProject":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedTotalProject":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedProject":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedCOR":{
            "type":"number",
            "description":"The portion of the fund that has not yet been committed to actual work. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedTotalCOR":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedTotalCOR":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCOR":{
            "minimum":0,
            "type":"number",
            "description":"The amount of money granted for the fund. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingCOR":{
            "type":"number",
            "description":"The portion of the fund that has not been consumed. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedCOR":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on a project. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedCOR":{
            "minimum":0,
            "type":"number",
            "description":"The portion of the fund that has been committed to work on a project. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedCOR":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedCOR":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on a project. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundSpreadRowInput

Type: object

Title: ApiEntityFundSpreadRowInput

Show Source

• fundAllocationSpreadRows: array fundAllocationSpreadRows
  Defines the spread rows for a fund allocation.
• fundId: integer (int64)
  The system generated identifier of a fund.
• fundSpreadRowCost: fundSpreadRowCost
  Defines the cost associated with the spread rows of the fund.
• fundSpreadRowId: integer (int64)
  The unique identification code of the spread row.
• month: string (date-time)
  The time period during which funding takes place in months.

{
    "title":"ApiEntityFundSpreadRowInput",
    "type":"object",
    "properties":{
        "month":{
            "type":"string",
            "description":"The time period during which funding takes place in months.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the spread row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The system generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundAllocationSpreadRows":{
            "type":"array",
            "description":"Defines the spread rows for a fund allocation.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundAllocationSpreadRowInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "fundSpreadRowCost":{
            "description":"Defines the cost associated with the spread rows of the fund.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFundCostSpreadRowInput"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : fundAllocationSpreadRows

Type: array

Defines the spread rows for a fund allocation.

Show Source

• Array of: object ApiEntityFundAllocationSpreadRowInput
  Title: ApiEntityFundAllocationSpreadRowInput

{
    "type":"array",
    "description":"Defines the spread rows for a fund allocation.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityFundAllocationSpreadRowInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : fundSpreadRowCost

Defines the cost associated with the spread rows of the fund.

Match All

Defines the cost associated with the spread rows of the fund.

Show Source

• object ApiEntityFundCostSpreadRowInput
  Title: ApiEntityFundCostSpreadRowInput

{
    "description":"Defines the cost associated with the spread rows of the fund.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityFundCostSpreadRowInput"
        }
    ]
}

Nested Schema : ApiEntityFundAllocationSpreadRowInput

Type: object

Title: ApiEntityFundAllocationSpreadRowInput

Show Source

• fundAllocationSpreadRowCost: fundAllocationSpreadRowCost
  Defines the cost associated with the spread rows of the workspace total item.
• fundAllocationSpreadRowId: integer (int64)
  The unique identification code of the allocation row.
• fundId: integer (int64)
  The unique identification code of the fund.
• fundSpreadRowId: integer (int64)
  The unique identification code of the spread row.

{
    "title":"ApiEntityFundAllocationSpreadRowInput",
    "type":"object",
    "properties":{
        "fundSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the spread row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The unique identification code of the fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundAllocationSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the allocation row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundAllocationSpreadRowCost":{
            "description":"Defines the cost associated with the spread rows of the workspace total item.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFundAllocationSpreadRowCostInput"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : fundAllocationSpreadRowCost

Defines the cost associated with the spread rows of the workspace total item.

Match All

Defines the cost associated with the spread rows of the workspace total item.

Show Source

• object ApiEntityFundAllocationSpreadRowCostInput
  Title: ApiEntityFundAllocationSpreadRowCostInput

{
    "description":"Defines the cost associated with the spread rows of the workspace total item.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityFundAllocationSpreadRowCostInput"
        }
    ]
}

Nested Schema : ApiEntityFundAllocationSpreadRowCostInput

Type: object

Title: ApiEntityFundAllocationSpreadRowCostInput

Show Source

• allocatedCOR: number (double)
  The portion of the fund that has been committed to work on a project. This is an input field, will not be a part of response.
• allocatedProject: number (double)
  The portion of the fund that has been committed to work on a project. This value is based on the project currency.
• fundAllocationSpreadRowId: integer (int64)
  The unique identification code of the allocation row.

{
    "title":"ApiEntityFundAllocationSpreadRowCostInput",
    "type":"object",
    "properties":{
        "allocatedProject":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on a project. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "fundAllocationSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the allocation row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "allocatedCOR":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on a project. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundCostSpreadRowInput

Type: object

Title: ApiEntityFundCostSpreadRowInput

Show Source

• allocatedCOR: number (double)
  The portion of the fund that has been committed to work on a project. This is an input field, will not be a part of response.
• allocatedProject: number (double)
  The portion of the fund that has been committed to work on a project. This value is based on the project currency.
• appropriatedCOR: number (double)
  The portion of the fund that has not yet been committed to actual work. This is an input field, will not be a part of response.
• appropriatedProject: number (double)
  The portion of the fund that has not yet been committed to actual work. This value is based on the project currency.
• consumedCOR: number (double)
  The portion of the fund that has been spent to complete work on project. This is an input field, will not be a part of response.
• consumedProject: number (double)
  The portion of the fund that has been spent to complete work on project. This value is based on the project currency.
• fundSpreadRowId: integer (int64)
  The unique identification code of the spread row.
• remainingCOR: number (double)
  The portion of the fund that has not been consumed. This is an input field, will not be a part of response.
• remainingProject: number (double)
  The portion of the fund that has not been consumed. This value is based on the project currency.
• totalCOR: number (double)
  The amount of money granted for the fund. This is an input field, will not be a part of response.
• totalProject: number (double)
  The amount of money granted for the fund. This value is based on the project currency.
• unallocatedCOR: number (double)
  The portion of the fund that has not been reserved for work on projects or in other workspaces. This is an input field, will not be a part of response.
• unallocatedProject: number (double)
  The portion of the fund that has not been reserved for work on projects or in other workspaces. This value is based on the project currency.
• unappropriatedCOR: number (double)
  The portion of the fund that has not yet been committed to actual work. This is an input field, will not be a part of response.
• unappropriatedProject: number (double)
  The portion of the fund that has not yet been committed to actual work. This value is based on the project currency.

{
    "title":"ApiEntityFundCostSpreadRowInput",
    "type":"object",
    "properties":{
        "totalProject":{
            "type":"number",
            "description":"The amount of money granted for the fund. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedProject":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on project. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "fundSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the spread row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "unappropriatedProject":{
            "type":"number",
            "description":"The portion of the fund that has not yet been committed to actual work. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedProject":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on a project. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingProject":{
            "type":"number",
            "description":"The portion of the fund that has not been consumed. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedProject":{
            "type":"number",
            "description":"The portion of the fund that has not yet been committed to actual work. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedProject":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedCOR":{
            "type":"number",
            "description":"The portion of the fund that has not yet been committed to actual work. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCOR":{
            "type":"number",
            "description":"The amount of money granted for the fund. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingCOR":{
            "type":"number",
            "description":"The portion of the fund that has not been consumed. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedCOR":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on a project. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedCOR":{
            "type":"number",
            "description":"The portion of the fund that has not yet been committed to actual work. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedCOR":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedCOR":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on project. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Project Funds Batch Update Project Funds by Assigning Code Values Using Codes or IDs Batch Update Project Funds by Assigning Hierarchical Code Values Using Codes Batch Update Project Funds to Assign Configured Field

Back to Top

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.

Back to Top