Jump to

• Request
• Response

Batch Create Portfolio Funds

post

/api/restapi/funds/portfolio/batch

Send a request to this endpoint to create one or more portfolio funds. An application object will be created for each JSON object provided in the request body.

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"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a fund.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier of a program.",
            "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"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The system generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "parentWorkspaceId":{
            "type":"integer",
            "description":"The user-specified identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentWorkspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "distributionType":{
            "type":"string",
            "description":"Specifies how money is distributed for the fund.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "YEARLY",
                "QUARTERLY",
                "MONTHLY",
                "LUMP_SUM"
            ]
        },
        "fromAllocation":{
            "type":"boolean",
            "description":"Specifies whether the fund has allocations.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "hasAllocations":{
            "type":"boolean",
            "description":"Specifies whether the fund has allocations.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "appropriationType":{
            "type":"string",
            "description":"The type of appropriation.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NONE",
                "MANUAL",
                "FROM_ALLOCATION"
            ]
        },
        "consumptionType":{
            "type":"string",
            "description":"The type of consumption.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NONE",
                "MANUAL",
                "FROM_ALLOCATION",
                "FROM_ACTUAL"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        }
    },
    "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

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.
• codeTypeName: string
  Minimum Length: 0

  Maximum Length: 255

  Deprecated. As of 23.11.
  The name of a code or value.
• 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.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• sequenceNumber: integer (int32)
  Deprecated. As of 23.11.
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityCodeValueFundInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The unique identification code of the fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueFundId":{
            "type":"integer",
            "description":"The unique identifier for the fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "deprecated":true,
            "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "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"
            ]
        },
        "codeTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The name of a code or value.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "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.
• costValue: number
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Read Only: true

  Maximum Length: 4000

  Deprecated. As of 23.10.
  Provides the error message for why the formula calculation resulted in an error.
• fundConfiguredFieldValueId: integer (int64)
  The unique identifier for funds configured field
• fundId: integer (int64)
  The system-generated identifier for funds
• hasException: boolean
  Read Only: true

  Deprecated. As of 23.10.
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityFundConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Determines if formula calculation hit an error calculating a value for this field.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Provides the error message for why the formula calculation resulted in an error.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "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

• allocated: number (double)
  Deprecated. As of 23.4.
  The portion of the fund that has been distributed to projects, programs, or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.
• 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.
• appropriated: number (double)
  Minimum Value: 0

  Deprecated. As of 23.4.
  The portion of the fund that has been committed to work on projects or programs. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.
• 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.
• consumed: number (double)
  Minimum Value: 0

  Deprecated. As of 23.4.
  The portion of the fund that has been spent to complete work on projects or programs. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.
• consumedCOR: number (double)
  Minimum Value: 0

  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)
  Minimum Value: 0

  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.
• distributedTotal: number (double)
  Deprecated. As of 23.4.
  The amount of money that has been distributed for the fund. This field is in base currency and is calculated from distributedTotalProject field based on the specified exchange rate.
• 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.
• remaining: number (double)
  Deprecated. As of 23.4.
  The portion of the fund that has not been consumed. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.
• 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.
• total: number (double)
  Minimum Value: 0

  Deprecated. As of 23.4.
  The amount of money granted for the fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.
• 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.
• unallocated: number (double)
  Deprecated. As of 23.4.
  The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.
• 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.
• unappropriated: number (double)
  Deprecated. As of 23.4.
  The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.
• 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.
• undistributedTotal: number (double)
  Deprecated. As of 23.4.
  The amount of money that has not been distributed for the fund. This field is in base currency and is calculated from undistributedTotalProject field based on the specified exchange rate.
• 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":{
        "remaining":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The portion of the fund that has not been consumed. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "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
        },
        "total":{
            "minimum":"0",
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The amount of money granted for the fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "appropriated":{
            "minimum":"0",
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The portion of the fund that has been committed to work on projects or programs. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "unappropriated":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "consumed":{
            "minimum":"0",
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The portion of the fund that has been spent to complete work on projects or programs. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "fundId":{
            "type":"integer",
            "description":"The system generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "allocated":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The portion of the fund that has been distributed to projects, programs, or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "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
        },
        "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
        },
        "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
        },
        "consumedProject":{
            "minimum":"0",
            "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
        },
        "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
        },
        "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
        },
        "unallocated":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "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
        },
        "distributedTotal":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The amount of money that has been distributed for the fund. This field is in base currency and is calculated from distributedTotalProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "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
        },
        "undistributedTotal":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The amount of money that has not been distributed for the fund. This field is in base currency and is calculated from undistributedTotalProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "consumedCOR":{
            "minimum":"0",
            "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"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The system generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the spread row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundSpreadRowCost":{
            "description":"Defines the cost associated with the spread rows of the fund.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFundCostSpreadRowInput"
                }
            ]
        },
        "fundAllocationSpreadRows":{
            "type":"array",
            "description":"Defines the spread rows for a fund allocation.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundAllocationSpreadRowInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "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

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

• fund: fund
  Read Only: true

  Deprecated. As of 23.12.
  The unique identification code of the fund.
• 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":{
        "fundId":{
            "type":"integer",
            "description":"The unique identification code of the fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fund":{
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The unique identification code of the fund.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFund"
                }
            ]
        },
        "fundSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the spread 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"
                }
            ]
        },
        "fundAllocationSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the allocation row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : fund

Read Only: true

Deprecated. As of 23.12.
The unique identification code of the fund.

Match All

Show Source

• object ApiEntityFund
  Title: ApiEntityFund

  Read Only: true

{
    "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The unique identification code of the fund.",
    "readOnly":true,
    "deprecated":true,
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityFund"
        }
    ]
}

Nested Schema : fundAllocationSpreadRowCost

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

Match All

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 : ApiEntityFund

Type: object

Title: ApiEntityFund

Read Only: true

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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• updateDate: string (date-time)
  Date when the record was last updated.
• 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":"ApiEntityFund",
    "required":[
        "endDate",
        "fundCode",
        "fundName",
        "startDate"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundCost":{
            "description":"Defines the fund cost of a fund.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFundCost"
                }
            ]
        },
        "spreadRows":{
            "type":"array",
            "description":"Defines the spread rows for a fund.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundSpreadRow",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a fund.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier of a program.",
            "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"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The system generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "parentWorkspaceId":{
            "type":"integer",
            "description":"The user-specified identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentWorkspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "distributionType":{
            "type":"string",
            "description":"Specifies how money is distributed for the fund.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "YEARLY",
                "QUARTERLY",
                "MONTHLY",
                "LUMP_SUM"
            ]
        },
        "fromAllocation":{
            "type":"boolean",
            "description":"Specifies whether the fund has allocations.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "hasAllocations":{
            "type":"boolean",
            "description":"Specifies whether the fund has allocations.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "appropriationType":{
            "type":"string",
            "description":"The type of appropriation.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NONE",
                "MANUAL",
                "FROM_ALLOCATION"
            ]
        },
        "consumptionType":{
            "type":"string",
            "description":"The type of consumption.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NONE",
                "MANUAL",
                "FROM_ALLOCATION",
                "FROM_ACTUAL"
            ]
        },
        "parentFundId":{
            "type":"integer",
            "description":"The unique identification code of the parent fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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/ApiEntityCodeValueFund",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "readOnly":true,
    "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 ApiEntityCodeValueFund
  Title: ApiEntityCodeValueFund

{
    "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/ApiEntityCodeValueFund",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a fund.

Show Source

• Array of: object ApiEntityFundConfiguredFieldValue
  Title: ApiEntityFundConfiguredFieldValue

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

Nested Schema : fundCost

Defines the fund cost of a fund.

Match All

Show Source

• object ApiEntityFundCost
  Title: ApiEntityFundCost

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

Nested Schema : spreadRows

Type: array

Defines the spread rows for a fund.

Show Source

• Array of: object ApiEntityFundSpreadRow
  Title: ApiEntityFundSpreadRow

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

Nested Schema : ApiEntityCodeValueFund

Type: object

Title: ApiEntityCodeValueFund

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.
• codeTypeName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of a code or value.
• 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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• sequenceNumber: integer (int32)
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCodeValueFund",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The unique identification code of the fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueFundId":{
            "type":"integer",
            "description":"The unique identifier for the fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "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"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "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"
            ]
        },
        "codeTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"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"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundConfiguredFieldValue

Type: object

Title: ApiEntityFundConfiguredFieldValue

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.
• costValue: number
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• fundConfiguredFieldValueId: integer (int64)
  The unique identifier for funds configured field
• fundId: integer (int64)
  The system-generated identifier for funds
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundConfiguredFieldValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundCost

Type: object

Title: ApiEntityFundCost

Show Source

• allocated: number (double)
  The portion of the fund that has been distributed to projects, programs, or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.
• 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.
• allocatedWorkspace1: number (double)
  The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace1 currency.
• allocatedWorkspace2: number (double)
  The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace2 currency.
• allocatedWorkspace3: number (double)
  The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace3 currency.
• appropriated: number (double)
  Minimum Value: 0

  The portion of the fund that has been committed to work on projects or programs. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.
• 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.
• appropriatedWorkspace1: number (double)
  Minimum Value: 0

  The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace1 currency.
• appropriatedWorkspace2: number (double)
  Minimum Value: 0

  The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace2 currency.
• appropriatedWorkspace3: number (double)
  Minimum Value: 0

  The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace3 currency.
• consumed: number (double)
  Minimum Value: 0

  The portion of the fund that has been spent to complete work on projects or programs. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.
• consumedProject: number (double)
  Minimum Value: 0

  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.
• consumedWorkspace1: number (double)
  Minimum Value: 0

  The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace1 currency.
• consumedWorkspace2: number (double)
  Minimum Value: 0

  The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace2 currency.
• consumedWorkspace3: number (double)
  Minimum Value: 0

  The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace3 currency.
• distributedTotal: number (double)
  The amount of money that has been distributed for the fund. This field is in base currency and is calculated from distributedTotalProject field based on the specified exchange rate.
• distributedTotalProject: number (double)
  The amount of money that has been distributed for the fund. This value is based on the project currency.
• distributedTotalWorkspace1: number (double)
  The amount of money that has been distributed for the fund. This value is based on the workspace1 currency.
• distributedTotalWorkspace2: number (double)
  The amount of money that has been distributed for the fund. This value is based on the workspace2 currency.
• distributedTotalWorkspace3: number (double)
  The amount of money that has been distributed for the fund. This value is based on the workspace3 currency.
• fundId: integer (int64)
  The system generated identifier of a fund.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• remaining: number (double)
  The portion of the fund that has not been consumed. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.
• remainingProject: number (double)
  The portion of the fund that has not been consumed. This value is based on the project currency.
• remainingWorkspace1: number (double)
  The portion of the fund that has not been consumed. This value is based on the workspace1 currency.
• remainingWorkspace2: number (double)
  The portion of the fund that has not been consumed. This value is based on the workspace2 currency.
• remainingWorkspace3: number (double)
  The portion of the fund that has not been consumed. This value is based on the workspace3 currency.
• total: number (double)
  Minimum Value: 0

  The amount of money granted for the fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.
• totalProject: number (double)
  Minimum Value: 0

  The amount of money granted for the fund. This value is based on the project currency.
• totalWorkspace1: number (double)
  Minimum Value: 0

  The amount of money granted for the fund. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  Minimum Value: 0

  The amount of money granted for the fund. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  Minimum Value: 0

  The amount of money granted for the fund. This value is based on the workspace3 currency.
• unallocated: number (double)
  The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.
• 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.
• unallocatedWorkspace1: number (double)
  The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace1 currency.
• unallocatedWorkspace2: number (double)
  The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace2 currency.
• unallocatedWorkspace3: number (double)
  The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace3 currency.
• unappropriated: number (double)
  The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.
• 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.
• unappropriatedWorkspace1: number (double)
  The portion of the fund that has not been committed to actual work. This value is based on the workspace1 currency.
• unappropriatedWorkspace2: number (double)
  The portion of the fund that has not been committed to actual work. This value is based on the workspace2 currency.
• unappropriatedWorkspace3: number (double)
  Minimum Value: 0

  The portion of the fund that has not been committed to actual work. This value is based on the workspace3 currency.
• undistributedTotal: number (double)
  The amount of money that has not been distributed for the fund. This field is in base currency and is calculated from undistributedTotalProject field based on the specified exchange rate.
• undistributedTotalProject: number (double)
  The amount of money that has not been distributed for the fund. This value is based on the project currency.
• undistributedTotalWorkspace1: number (double)
  The amount of money that has not been distributed for the fund. This value is based on the workspace1 currency.
• undistributedTotalWorkspace2: number (double)
  The amount of money that has not been distributed for the fund. This value is based on the workspace2 currency.
• undistributedTotalWorkspace3: number (double)
  The amount of money that has not been distributed for the fund. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundCost",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remaining":{
            "type":"number",
            "description":"The portion of the fund that has not been consumed. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "total":{
            "minimum":"0",
            "type":"number",
            "description":"The amount of money granted for the fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "minimum":"0",
            "type":"number",
            "description":"The amount of money granted for the fund. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "minimum":"0",
            "type":"number",
            "description":"The amount of money granted for the fund. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "minimum":"0",
            "type":"number",
            "description":"The amount of money granted for the fund. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriated":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects or programs. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace1":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace2":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace3":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriated":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace3":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumed":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects or programs. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace1":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace2":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace3":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has not been consumed. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has not been consumed. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has not been consumed. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "fundId":{
            "type":"integer",
            "description":"The system generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "allocated":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects, programs, or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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
        },
        "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
        },
        "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
        },
        "consumedProject":{
            "minimum":"0",
            "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
        },
        "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
        },
        "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
        },
        "unallocated":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace3 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
        },
        "distributedTotal":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund. This field is in base currency and is calculated from distributedTotalProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedTotalWorkspace1":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedTotalWorkspace2":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedTotalWorkspace3":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund. This value is based on the workspace3 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
        },
        "undistributedTotal":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund. This field is in base currency and is calculated from undistributedTotalProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedTotalWorkspace1":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedTotalWorkspace2":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedTotalWorkspace3":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund. This value is based on the workspace3 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
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundSpreadRow

Type: object

Title: ApiEntityFundSpreadRow

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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• month: string (date-time)
  The time period during which funding takes place in months.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundSpreadRow",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "month":{
            "type":"string",
            "description":"The time period during which funding takes place in months.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The system generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the spread row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundSpreadRowCost":{
            "description":"Defines the cost associated with the spread rows of the fund.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFundCostSpreadRow"
                }
            ]
        },
        "fundAllocationSpreadRows":{
            "type":"array",
            "description":"Defines the spread rows for a fund allocation.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundAllocationSpreadRow",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : fundAllocationSpreadRows

Type: array

Defines the spread rows for a fund allocation.

Show Source

• Array of: object ApiEntityFundAllocationSpreadRow
  Title: ApiEntityFundAllocationSpreadRow

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

Nested Schema : fundSpreadRowCost

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

Match All

Show Source

• object ApiEntityFundCostSpreadRow
  Title: ApiEntityFundCostSpreadRow

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

Nested Schema : ApiEntityFundAllocationSpreadRow

Type: object

Title: ApiEntityFundAllocationSpreadRow

Show Source

• fund: fund
  The unique identification code of the fund.
• 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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundAllocationSpreadRow",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The unique identification code of the fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fund":{
            "description":"The unique identification code of the fund.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFund"
                }
            ]
        },
        "fundSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the spread 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/ApiEntityFundAllocationSpreadRowCost"
                }
            ]
        },
        "fundAllocationSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the allocation row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : fund

The unique identification code of the fund.

Match All

Show Source

• object ApiEntityFund
  Title: ApiEntityFund

  Read Only: true

{
    "description":"The unique identification code of the fund.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityFund"
        }
    ]
}

Nested Schema : fundAllocationSpreadRowCost

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

Match All

Show Source

• object ApiEntityFundAllocationSpreadRowCost
  Title: ApiEntityFundAllocationSpreadRowCost

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

Nested Schema : ApiEntityFundAllocationSpreadRowCost

Type: object

Title: ApiEntityFundAllocationSpreadRowCost

Show Source

• allocated: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.
• 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.
• allocatedWorkspace1: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace1 currency.
• allocatedWorkspace2: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace2 currency.
• allocatedWorkspace3: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace3 currency.
• fundAllocationSpreadRowId: integer (int64)
  The unique identification code of the allocation row.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundAllocationSpreadRowCost",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "allocated":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace3 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
        },
        "fundAllocationSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the allocation row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundCostSpreadRow

Type: object

Title: ApiEntityFundCostSpreadRow

Show Source

• allocated: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.
• 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.
• allocatedWorkspace1: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace1 currency.
• allocatedWorkspace2: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace2 currency.
• allocatedWorkspace3: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace3 currency.
• appropriated: number (double)
  The portion of the fund that has been committed to work on projects. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.
• 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.
• appropriatedWorkspace1: number (double)
  The portion of the fund that has been committed to work on projects. This value is based on the workspace1 currency.
• appropriatedWorkspace2: number (double)
  The portion of the fund that has been committed to work on projects. This value is based on the workspace2 currency.
• appropriatedWorkspace3: number (double)
  The portion of the fund that has been committed to work on projects. This value is based on the workspace3 currency.
• consumed: number (double)
  The portion of the fund that has been spent to complete work on projects. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.
• 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.
• consumedWorkspace1: number (double)
  The portion of the fund that has been spent to complete work on projects. This value is based on the workspace1 currency.
• consumedWorkspace2: number (double)
  The portion of the fund that has been spent to complete work on projects. This value is based on the workspace2 currency.
• consumedWorkspace3: number (double)
  The portion of the fund that has been spent to complete work on projects. This value is based on the workspace3 currency.
• fundSpreadRowId: integer (int64)
  The unique identification code of the spread row.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• remaining: number (double)
  The amount left to be spent.
  If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
  If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.
• remainingProject: number (double)
  The portion of the fund that has not been consumed. This value is based on the project currency.
• remainingWorkspace1: number (double)
  The amount left to be spent.
  If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
  If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace1 currency.
• remainingWorkspace2: number (double)
  The amount left to be spent.
  If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
  If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace2 currency.
• remainingWorkspace3: number (double)
  The amount left to be spent.
  If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
  If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace3 currency.
• total: number (double)
  The cost to be added to or subtracted from the workspace or portfolio fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.
• totalProject: number (double)
  The amount of money granted for the fund. This value is based on the project currency.
• totalWorkspace1: number (double)
  The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace3 currency.
• unallocated: number (double)
  The portion of the fund that has not been reserved for work on projects or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.
• 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.
• unallocatedWorkspace1: 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 workspace1 currency.
• unallocatedWorkspace2: 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 workspace2 currency.
• unallocatedWorkspace3: 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 workspace3 currency.
• unappropriated: number (double)
  The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.
• 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.
• unappropriatedWorkspace1: number (double)
  The portion of the fund that has not been committed to actual work. This value is based on the workspace1 currency.
• unappropriatedWorkspace2: number (double)
  The portion of the fund that has not been committed to actual work. This value is based on the workspace2 currency.
• unappropriatedWorkspace3: number (double)
  The portion of the fund that has not been committed to actual work. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundCostSpreadRow",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remaining":{
            "type":"number",
            "description":"The amount left to be spent. <br />If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate. <br />If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "total":{
            "type":"number",
            "description":"The cost to be added to or subtracted from the workspace or portfolio fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "type":"number",
            "description":"The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "type":"number",
            "description":"The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "type":"number",
            "description":"The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriated":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriated":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumed":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace1":{
            "type":"number",
            "description":"The amount left to be spent. <br />If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate. <br />If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace2":{
            "type":"number",
            "description":"The amount left to be spent. <br />If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate. <br />If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace3":{
            "type":"number",
            "description":"The amount left to be spent. <br />If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate. <br />If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocated":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalProject":{
            "type":"number",
            "description":"The amount of money granted for the fund. 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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "unallocated":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace1":{
            "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 workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace2":{
            "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 workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace3":{
            "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 workspace3 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
        },
        "fundSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the spread row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundAllocationSpreadRowCostInput

Type: object

Title: ApiEntityFundAllocationSpreadRowCostInput

Show Source

• allocated: number (double)
  Deprecated. As of 23.4.
  The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.
• 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":{
        "allocated":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "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
        },
        "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

• allocated: number (double)
  Deprecated. As of 23.4.
  The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.
• 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.
• appropriated: number (double)
  Deprecated. As of 23.4.
  The portion of the fund that has been committed to work on projects. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.
• 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.
• consumed: number (double)
  Deprecated. As of 23.4.
  The portion of the fund that has been spent to complete work on projects. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.
• 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.
• remaining: number (double)
  Deprecated. As of 23.4.
  The amount left to be spent.
  If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
  If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.
• 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.
• total: number (double)
  Deprecated. As of 23.4.
  The cost to be added to or subtracted from the workspace or portfolio fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.
• 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.
• unallocated: number (double)
  Deprecated. As of 23.4.
  The portion of the fund that has not been reserved for work on projects or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.
• 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.
• unappropriated: number (double)
  Deprecated. As of 23.4.
  The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.
• 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":{
        "remaining":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The amount left to be spent. <br />If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate. <br />If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "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
        },
        "total":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The cost to be added to or subtracted from the workspace or portfolio fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "appropriated":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The portion of the fund that has been committed to work on projects. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "unappropriated":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "consumed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The portion of the fund that has been spent to complete work on projects. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "allocated":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "totalProject":{
            "type":"number",
            "description":"The amount of money granted for the fund. 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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "unallocated":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The portion of the fund that has not been reserved for work on projects or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "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
        },
        "fundSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the spread row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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 Create Portfolio Funds

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityFund>

Type: array

Title: List<ApiEntityFund>

Show Source

• Array of: object ApiEntityFund
  Title: ApiEntityFund

  Read Only: true

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

Nested Schema : ApiEntityFund

Type: object

Title: ApiEntityFund

Read Only: true

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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• updateDate: string (date-time)
  Date when the record was last updated.
• 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":"ApiEntityFund",
    "required":[
        "endDate",
        "fundCode",
        "fundName",
        "startDate"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundCost":{
            "description":"Defines the fund cost of a fund.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFundCost"
                }
            ]
        },
        "spreadRows":{
            "type":"array",
            "description":"Defines the spread rows for a fund.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundSpreadRow",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a fund.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier of a program.",
            "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"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The system generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "parentWorkspaceId":{
            "type":"integer",
            "description":"The user-specified identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentWorkspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "distributionType":{
            "type":"string",
            "description":"Specifies how money is distributed for the fund.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "YEARLY",
                "QUARTERLY",
                "MONTHLY",
                "LUMP_SUM"
            ]
        },
        "fromAllocation":{
            "type":"boolean",
            "description":"Specifies whether the fund has allocations.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "hasAllocations":{
            "type":"boolean",
            "description":"Specifies whether the fund has allocations.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "appropriationType":{
            "type":"string",
            "description":"The type of appropriation.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NONE",
                "MANUAL",
                "FROM_ALLOCATION"
            ]
        },
        "consumptionType":{
            "type":"string",
            "description":"The type of consumption.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NONE",
                "MANUAL",
                "FROM_ALLOCATION",
                "FROM_ACTUAL"
            ]
        },
        "parentFundId":{
            "type":"integer",
            "description":"The unique identification code of the parent fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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/ApiEntityCodeValueFund",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "readOnly":true,
    "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 ApiEntityCodeValueFund
  Title: ApiEntityCodeValueFund

{
    "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/ApiEntityCodeValueFund",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a fund.

Show Source

• Array of: object ApiEntityFundConfiguredFieldValue
  Title: ApiEntityFundConfiguredFieldValue

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

Nested Schema : fundCost

Defines the fund cost of a fund.

Match All

Show Source

• object ApiEntityFundCost
  Title: ApiEntityFundCost

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

Nested Schema : spreadRows

Type: array

Defines the spread rows for a fund.

Show Source

• Array of: object ApiEntityFundSpreadRow
  Title: ApiEntityFundSpreadRow

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

Nested Schema : ApiEntityCodeValueFund

Type: object

Title: ApiEntityCodeValueFund

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.
• codeTypeName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of a code or value.
• 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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• sequenceNumber: integer (int32)
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCodeValueFund",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The unique identification code of the fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueFundId":{
            "type":"integer",
            "description":"The unique identifier for the fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "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"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "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"
            ]
        },
        "codeTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"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"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundConfiguredFieldValue

Type: object

Title: ApiEntityFundConfiguredFieldValue

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.
• costValue: number
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• fundConfiguredFieldValueId: integer (int64)
  The unique identifier for funds configured field
• fundId: integer (int64)
  The system-generated identifier for funds
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundConfiguredFieldValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundCost

Type: object

Title: ApiEntityFundCost

Show Source

• allocated: number (double)
  The portion of the fund that has been distributed to projects, programs, or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.
• 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.
• allocatedWorkspace1: number (double)
  The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace1 currency.
• allocatedWorkspace2: number (double)
  The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace2 currency.
• allocatedWorkspace3: number (double)
  The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace3 currency.
• appropriated: number (double)
  Minimum Value: 0

  The portion of the fund that has been committed to work on projects or programs. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.
• 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.
• appropriatedWorkspace1: number (double)
  Minimum Value: 0

  The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace1 currency.
• appropriatedWorkspace2: number (double)
  Minimum Value: 0

  The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace2 currency.
• appropriatedWorkspace3: number (double)
  Minimum Value: 0

  The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace3 currency.
• consumed: number (double)
  Minimum Value: 0

  The portion of the fund that has been spent to complete work on projects or programs. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.
• consumedProject: number (double)
  Minimum Value: 0

  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.
• consumedWorkspace1: number (double)
  Minimum Value: 0

  The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace1 currency.
• consumedWorkspace2: number (double)
  Minimum Value: 0

  The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace2 currency.
• consumedWorkspace3: number (double)
  Minimum Value: 0

  The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace3 currency.
• distributedTotal: number (double)
  The amount of money that has been distributed for the fund. This field is in base currency and is calculated from distributedTotalProject field based on the specified exchange rate.
• distributedTotalProject: number (double)
  The amount of money that has been distributed for the fund. This value is based on the project currency.
• distributedTotalWorkspace1: number (double)
  The amount of money that has been distributed for the fund. This value is based on the workspace1 currency.
• distributedTotalWorkspace2: number (double)
  The amount of money that has been distributed for the fund. This value is based on the workspace2 currency.
• distributedTotalWorkspace3: number (double)
  The amount of money that has been distributed for the fund. This value is based on the workspace3 currency.
• fundId: integer (int64)
  The system generated identifier of a fund.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• remaining: number (double)
  The portion of the fund that has not been consumed. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.
• remainingProject: number (double)
  The portion of the fund that has not been consumed. This value is based on the project currency.
• remainingWorkspace1: number (double)
  The portion of the fund that has not been consumed. This value is based on the workspace1 currency.
• remainingWorkspace2: number (double)
  The portion of the fund that has not been consumed. This value is based on the workspace2 currency.
• remainingWorkspace3: number (double)
  The portion of the fund that has not been consumed. This value is based on the workspace3 currency.
• total: number (double)
  Minimum Value: 0

  The amount of money granted for the fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.
• totalProject: number (double)
  Minimum Value: 0

  The amount of money granted for the fund. This value is based on the project currency.
• totalWorkspace1: number (double)
  Minimum Value: 0

  The amount of money granted for the fund. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  Minimum Value: 0

  The amount of money granted for the fund. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  Minimum Value: 0

  The amount of money granted for the fund. This value is based on the workspace3 currency.
• unallocated: number (double)
  The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.
• 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.
• unallocatedWorkspace1: number (double)
  The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace1 currency.
• unallocatedWorkspace2: number (double)
  The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace2 currency.
• unallocatedWorkspace3: number (double)
  The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace3 currency.
• unappropriated: number (double)
  The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.
• 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.
• unappropriatedWorkspace1: number (double)
  The portion of the fund that has not been committed to actual work. This value is based on the workspace1 currency.
• unappropriatedWorkspace2: number (double)
  The portion of the fund that has not been committed to actual work. This value is based on the workspace2 currency.
• unappropriatedWorkspace3: number (double)
  Minimum Value: 0

  The portion of the fund that has not been committed to actual work. This value is based on the workspace3 currency.
• undistributedTotal: number (double)
  The amount of money that has not been distributed for the fund. This field is in base currency and is calculated from undistributedTotalProject field based on the specified exchange rate.
• undistributedTotalProject: number (double)
  The amount of money that has not been distributed for the fund. This value is based on the project currency.
• undistributedTotalWorkspace1: number (double)
  The amount of money that has not been distributed for the fund. This value is based on the workspace1 currency.
• undistributedTotalWorkspace2: number (double)
  The amount of money that has not been distributed for the fund. This value is based on the workspace2 currency.
• undistributedTotalWorkspace3: number (double)
  The amount of money that has not been distributed for the fund. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundCost",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remaining":{
            "type":"number",
            "description":"The portion of the fund that has not been consumed. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "total":{
            "minimum":"0",
            "type":"number",
            "description":"The amount of money granted for the fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "minimum":"0",
            "type":"number",
            "description":"The amount of money granted for the fund. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "minimum":"0",
            "type":"number",
            "description":"The amount of money granted for the fund. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "minimum":"0",
            "type":"number",
            "description":"The amount of money granted for the fund. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriated":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects or programs. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace1":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace2":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace3":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriated":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace3":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumed":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects or programs. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace1":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace2":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace3":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has not been consumed. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has not been consumed. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has not been consumed. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "fundId":{
            "type":"integer",
            "description":"The system generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "allocated":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects, programs, or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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
        },
        "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
        },
        "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
        },
        "consumedProject":{
            "minimum":"0",
            "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
        },
        "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
        },
        "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
        },
        "unallocated":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace3 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
        },
        "distributedTotal":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund. This field is in base currency and is calculated from distributedTotalProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedTotalWorkspace1":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedTotalWorkspace2":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedTotalWorkspace3":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund. This value is based on the workspace3 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
        },
        "undistributedTotal":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund. This field is in base currency and is calculated from undistributedTotalProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedTotalWorkspace1":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedTotalWorkspace2":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedTotalWorkspace3":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund. This value is based on the workspace3 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
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundSpreadRow

Type: object

Title: ApiEntityFundSpreadRow

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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• month: string (date-time)
  The time period during which funding takes place in months.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundSpreadRow",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "month":{
            "type":"string",
            "description":"The time period during which funding takes place in months.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The system generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the spread row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundSpreadRowCost":{
            "description":"Defines the cost associated with the spread rows of the fund.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFundCostSpreadRow"
                }
            ]
        },
        "fundAllocationSpreadRows":{
            "type":"array",
            "description":"Defines the spread rows for a fund allocation.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundAllocationSpreadRow",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : fundAllocationSpreadRows

Type: array

Defines the spread rows for a fund allocation.

Show Source

• Array of: object ApiEntityFundAllocationSpreadRow
  Title: ApiEntityFundAllocationSpreadRow

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

Nested Schema : fundSpreadRowCost

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

Match All

Show Source

• object ApiEntityFundCostSpreadRow
  Title: ApiEntityFundCostSpreadRow

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

Nested Schema : ApiEntityFundAllocationSpreadRow

Type: object

Title: ApiEntityFundAllocationSpreadRow

Show Source

• fund: fund
  The unique identification code of the fund.
• 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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundAllocationSpreadRow",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The unique identification code of the fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fund":{
            "description":"The unique identification code of the fund.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFund"
                }
            ]
        },
        "fundSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the spread 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/ApiEntityFundAllocationSpreadRowCost"
                }
            ]
        },
        "fundAllocationSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the allocation row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : fund

The unique identification code of the fund.

Match All

Show Source

• object ApiEntityFund
  Title: ApiEntityFund

  Read Only: true

{
    "description":"The unique identification code of the fund.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityFund"
        }
    ]
}

Nested Schema : fundAllocationSpreadRowCost

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

Match All

Show Source

• object ApiEntityFundAllocationSpreadRowCost
  Title: ApiEntityFundAllocationSpreadRowCost

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

Nested Schema : ApiEntityFundAllocationSpreadRowCost

Type: object

Title: ApiEntityFundAllocationSpreadRowCost

Show Source

• allocated: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.
• 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.
• allocatedWorkspace1: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace1 currency.
• allocatedWorkspace2: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace2 currency.
• allocatedWorkspace3: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace3 currency.
• fundAllocationSpreadRowId: integer (int64)
  The unique identification code of the allocation row.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundAllocationSpreadRowCost",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "allocated":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace3 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
        },
        "fundAllocationSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the allocation row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityFundCostSpreadRow

Type: object

Title: ApiEntityFundCostSpreadRow

Show Source

• allocated: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.
• 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.
• allocatedWorkspace1: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace1 currency.
• allocatedWorkspace2: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace2 currency.
• allocatedWorkspace3: number (double)
  The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace3 currency.
• appropriated: number (double)
  The portion of the fund that has been committed to work on projects. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.
• 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.
• appropriatedWorkspace1: number (double)
  The portion of the fund that has been committed to work on projects. This value is based on the workspace1 currency.
• appropriatedWorkspace2: number (double)
  The portion of the fund that has been committed to work on projects. This value is based on the workspace2 currency.
• appropriatedWorkspace3: number (double)
  The portion of the fund that has been committed to work on projects. This value is based on the workspace3 currency.
• consumed: number (double)
  The portion of the fund that has been spent to complete work on projects. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.
• 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.
• consumedWorkspace1: number (double)
  The portion of the fund that has been spent to complete work on projects. This value is based on the workspace1 currency.
• consumedWorkspace2: number (double)
  The portion of the fund that has been spent to complete work on projects. This value is based on the workspace2 currency.
• consumedWorkspace3: number (double)
  The portion of the fund that has been spent to complete work on projects. This value is based on the workspace3 currency.
• fundSpreadRowId: integer (int64)
  The unique identification code of the spread row.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• remaining: number (double)
  The amount left to be spent.
  If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
  If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.
• remainingProject: number (double)
  The portion of the fund that has not been consumed. This value is based on the project currency.
• remainingWorkspace1: number (double)
  The amount left to be spent.
  If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
  If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace1 currency.
• remainingWorkspace2: number (double)
  The amount left to be spent.
  If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
  If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace2 currency.
• remainingWorkspace3: number (double)
  The amount left to be spent.
  If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
  If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace3 currency.
• total: number (double)
  The cost to be added to or subtracted from the workspace or portfolio fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.
• totalProject: number (double)
  The amount of money granted for the fund. This value is based on the project currency.
• totalWorkspace1: number (double)
  The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace3 currency.
• unallocated: number (double)
  The portion of the fund that has not been reserved for work on projects or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.
• 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.
• unallocatedWorkspace1: 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 workspace1 currency.
• unallocatedWorkspace2: 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 workspace2 currency.
• unallocatedWorkspace3: 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 workspace3 currency.
• unappropriated: number (double)
  The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.
• 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.
• unappropriatedWorkspace1: number (double)
  The portion of the fund that has not been committed to actual work. This value is based on the workspace1 currency.
• unappropriatedWorkspace2: number (double)
  The portion of the fund that has not been committed to actual work. This value is based on the workspace2 currency.
• unappropriatedWorkspace3: number (double)
  The portion of the fund that has not been committed to actual work. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundCostSpreadRow",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remaining":{
            "type":"number",
            "description":"The amount left to be spent. <br />If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate. <br />If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "total":{
            "type":"number",
            "description":"The cost to be added to or subtracted from the workspace or portfolio fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "type":"number",
            "description":"The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "type":"number",
            "description":"The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "type":"number",
            "description":"The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriated":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriated":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumed":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace1":{
            "type":"number",
            "description":"The amount left to be spent. <br />If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate. <br />If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace2":{
            "type":"number",
            "description":"The amount left to be spent. <br />If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate. <br />If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace3":{
            "type":"number",
            "description":"The amount left to be spent. <br />If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate. <br />If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocated":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalProject":{
            "type":"number",
            "description":"The amount of money granted for the fund. 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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "unallocated":{
            "type":"number",
            "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace1":{
            "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 workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace2":{
            "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 workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace3":{
            "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 workspace3 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
        },
        "fundSpreadRowId":{
            "type":"integer",
            "description":"The unique identification code of the spread row.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid Input.

Back to Top