Jump to

• Request
• Response

View all Fund Plan Projects

get

/api/restapi/budgetPlanningScenario/fund/planProjects/scenario/{scenarioId}

Send a request to this endpoint to view all plan projects with fund data in the budget planning scenario.

Request

Path Parameters

• scenarioId(required): integer(int64)
  The system-generated identifier of an Budget Plan Scenario.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityFundPlanProject>

Type: array

Title: List<ApiEntityFundPlanProject>

Show Source

• Array of: object ApiEntityFundPlanProject
  Title: ApiEntityFundPlanProject

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

Nested Schema : ApiEntityFundPlanProject

Type: object

Title: ApiEntityFundPlanProject

Show Source

• appropriated: number (double)
  The total portion of the funds that has been committed to work on projects.
• appropriatedWorkspace1: number (double)
  The total portion of the funds that has been committed to work on projects based on the workspace currency. This value is based on the workspace1 currency.
• appropriatedWorkspace2: number (double)
  The total portion of the funds that has been committed to work on projects based on the workspace currency. This value is based on the workspace2 currency.
• appropriatedWorkspace3: number (double)
  The total portion of the funds that has been committed to work on projects based on the workspace currency. This value is based on the workspace3 currency.
• consumed: number (double)
  The total portion of the funds that has been spent to complete work on projects.
• consumedWorkspace1: number (double)
  The total portion of the funds that has been spent to complete work on projects based on the workspace currency. This value is based on the workspace1 currency.
• consumedWorkspace2: number (double)
  The total portion of the funds that has been spent to complete work on projects based on the workspace currency. This value is based on the workspace2 currency.
• consumedWorkspace3: number (double)
  The total portion of the funds that has been spent to complete work on projects based on the workspace currency. This value is based on the workspace3 currency.
• description: string
  Maximum Length: 4000

  The description of a plan project.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• linked: boolean
  The flag to link or unlink a project in a scenario.
• portfolioProjectFundPeriods: array portfolioProjectFundPeriods
  The phase funds associated with a plan project.
• portfolioProjectFunds: array portfolioProjectFunds
  The funds assigned to a plan project.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier of a project.
• projectName: string
  Maximum Length: 255

  The name of a plan project associated with a scenario.
• projectStatus: string
  Allowed Values: [ "PENDING", "ACCEPTED", "CHANGES_REQUESTED" ]

  The budget review status of a plan project associated with a scenario.
• proposedFundDistributed: number (double)
  The proposed distributed amount of a plan project.
• proposedFundDistributedWorkspace1: number (double)
  The proposed distributed amount of a plan project based on the workspace currency. This value is based on the workspace1 currency.
• proposedFundDistributedWorkspace2: number (double)
  The proposed distributed amount of a plan project based on the workspace currency. This value is based on the workspace2 currency.
• proposedFundDistributedWorkspace3: number (double)
  The proposed distributed amount of a plan project based on the workspace currency. This value is based on the workspace3 currency.
• proposedFundFinish: string (date-time)
  The finish date of proposed fund of a project.
• proposedFundStart: string (date-time)
  The start date of proposed fund of a project.
• proposedFundTotal: number (double)
  The proposed fund total of a plan project.
• proposedFundTotalWorkspace1: number (double)
  The proposed fund total of a plan project based on the workspace currency. This value is based on the workspace1 currency.
• proposedFundTotalWorkspace2: number (double)
  The proposed fund total of a plan project based on the workspace currency. This value is based on the workspace2 currency.
• proposedFundTotalWorkspace3: number (double)
  The proposed fund total of a plan project based on the workspace currency. This value is based on the workspace3 currency.
• proposedFundUndistributed: number (double)
  The proposed undistributed amount of a plan project.
• proposedFundUndistributedWorkspace1: number (double)
  The proposed undistributed amount of a plan project based on the workspace currency. This value is based on the workspace1 currency.
• proposedFundUndistributedWorkspace2: number (double)
  The proposed undistributed amount of a plan project based on the workspace currency. This value is based on the workspace2 currency.
• proposedFundUndistributedWorkspace3: number (double)
  The proposed undistributed amount of a plan project based on the workspace currency. This value is based on the workspace3 currency.
• remaining: number (double)
  The total portion of the funds that has not been consumed.
• remainingWorkspace1: number (double)
  The total portion of the funds that has not been consumed based on the workspace currency. This value is based on the workspace1 currency.
• remainingWorkspace2: number (double)
  The total portion of the funds that has not been consumed based on the workspace currency. This value is based on the workspace2 currency.
• remainingWorkspace3: number (double)
  The total portion of the funds that has not been consumed based on the workspace currency. This value is based on the workspace3 currency.
• state: string
  Allowed Values: [ "SELECTED", "UNSELECTED", "FORCED_IN", "FORCED_OUT" ]

  The state of capital plan project.
• totalFund: number (double)
  The total fund of a plan project.
• totalFundWorkspace1: number (double)
  The total fund of a plan project based on the workspace currency. This value is based on the workspace1 currency.
• totalFundWorkspace2: number (double)
  The total fund of a plan project based on the workspace currency. This value is based on the workspace2 currency.
• totalFundWorkspace3: number (double)
  The total fund of a plan project based on the workspace currency. This value is based on the workspace3 currency.
• unappropriated: number (double)
  The total portion of the funds that has not been committed to actual work.
• unappropriatedWorkspace1: number (double)
  The total portion of the funds that has not been committed to actual work based on the workspace currency. This value is based on the workspace1 currency.
• unappropriatedWorkspace2: number (double)
  The total portion of the funds that has not been committed to actual work based on the workspace currency. This value is based on the workspace2 currency.
• unappropriatedWorkspace3: number (double)
  The total portion of the funds that has not been committed to actual work based on the workspace currency. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityFundPlanProject",
    "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 total portion of the funds that has not been consumed.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundTotal":{
            "type":"number",
            "description":"The proposed fund total of a plan project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundTotalWorkspace1":{
            "type":"number",
            "description":"The proposed fund total of a plan project based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundTotalWorkspace2":{
            "type":"number",
            "description":"The proposed fund total of a plan project based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundTotalWorkspace3":{
            "type":"number",
            "description":"The proposed fund total of a plan project based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundDistributed":{
            "type":"number",
            "description":"The proposed distributed amount of a plan project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundDistributedWorkspace1":{
            "type":"number",
            "description":"The proposed distributed amount of a plan project based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundDistributedWorkspace2":{
            "type":"number",
            "description":"The proposed distributed amount of a plan project based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundDistributedWorkspace3":{
            "type":"number",
            "description":"The proposed distributed amount of a plan project based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundUndistributed":{
            "type":"number",
            "description":"The proposed undistributed amount of a plan project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundUndistributedWorkspace1":{
            "type":"number",
            "description":"The proposed undistributed amount of a plan project based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundUndistributedWorkspace2":{
            "type":"number",
            "description":"The proposed undistributed amount of a plan project based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundUndistributedWorkspace3":{
            "type":"number",
            "description":"The proposed undistributed amount of a plan project based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalFund":{
            "type":"number",
            "description":"The total fund of a plan project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalFundWorkspace1":{
            "type":"number",
            "description":"The total fund of a plan project based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalFundWorkspace2":{
            "type":"number",
            "description":"The total fund of a plan project based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalFundWorkspace3":{
            "type":"number",
            "description":"The total fund of a plan project based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriated":{
            "type":"number",
            "description":"The total portion of the funds that has been committed to work on projects.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace1":{
            "type":"number",
            "description":"The total portion of the funds that has been committed to work on projects based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace2":{
            "type":"number",
            "description":"The total portion of the funds that has been committed to work on projects based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace3":{
            "type":"number",
            "description":"The total portion of the funds that has been committed to work on projects based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriated":{
            "type":"number",
            "description":"The total portion of the funds that has not been committed to actual work.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace1":{
            "type":"number",
            "description":"The total portion of the funds that has not been committed to actual work based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace2":{
            "type":"number",
            "description":"The total portion of the funds that has not been committed to actual work based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace3":{
            "type":"number",
            "description":"The total portion of the funds that has not been committed to actual work based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumed":{
            "type":"number",
            "description":"The total portion of the funds that has been spent to complete work on projects.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace1":{
            "type":"number",
            "description":"The total portion of the funds that has been spent to complete work on projects based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace2":{
            "type":"number",
            "description":"The total portion of the funds that has been spent to complete work on projects based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace3":{
            "type":"number",
            "description":"The total portion of the funds that has been spent to complete work on projects based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace1":{
            "type":"number",
            "description":"The total portion of the funds that has not been consumed based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace2":{
            "type":"number",
            "description":"The total portion of the funds that has not been consumed based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace3":{
            "type":"number",
            "description":"The total portion of the funds that has not been consumed based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundStart":{
            "type":"string",
            "description":"The start date of proposed fund of a project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedFundFinish":{
            "type":"string",
            "description":"The finish date of proposed fund of a project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioProjectFundPeriods":{
            "type":"array",
            "description":"The phase funds associated with a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundPeriod",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "portfolioProjectFunds":{
            "type":"array",
            "description":"The funds assigned to a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityPortfolioProjectFund",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "state":{
            "type":"string",
            "description":"The state of capital plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SELECTED",
                "UNSELECTED",
                "FORCED_IN",
                "FORCED_OUT"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"The description of a plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of  a plan project associated with a scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectStatus":{
            "type":"string",
            "description":"The budget review status of a plan project associated with a scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PENDING",
                "ACCEPTED",
                "CHANGES_REQUESTED"
            ]
        },
        "linked":{
            "type":"boolean",
            "description":"The flag to link or unlink a project in a scenario.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : portfolioProjectFundPeriods

Type: array

The phase funds associated with a plan project.

Show Source

• Array of: object ApiEntityFundPeriod
  Title: ApiEntityFundPeriod

{
    "type":"array",
    "description":"The phase funds associated with a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityFundPeriod",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : portfolioProjectFunds

Type: array

The funds assigned to a plan project.

Show Source

• Array of: object ApiEntityPortfolioProjectFund
  Title: ApiEntityPortfolioProjectFund

{
    "type":"array",
    "description":"The funds assigned to a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityPortfolioProjectFund",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityFundPeriod

Type: object

Title: ApiEntityFundPeriod

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• proposedFundCost: number (double)
  The cost of portfolio project fund based on base currency.
• proposedFundCostWorkspace1: number (double)
  The cost of portfolio project fund based on the workspace currency. This value is based on the workspace1 currency.
• proposedFundCostWorkspace2: number (double)
  The cost of portfolio project fund based on the workspace currency. This value is based on the workspace2 currency.
• proposedFundCostWorkspace3: number (double)
  The cost of portfolio project fund based on the workspace currency. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.
• year: integer (int32)
  The year of phase period of a fund.

{
    "title":"ApiEntityFundPeriod",
    "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"
            ]
        },
        "year":{
            "type":"integer",
            "description":"The year of phase period of a fund.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "proposedFundCost":{
            "type":"number",
            "description":"The cost of portfolio project fund based on base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundCostWorkspace1":{
            "type":"number",
            "description":"The cost of portfolio project fund based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundCostWorkspace2":{
            "type":"number",
            "description":"The cost of portfolio project fund based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundCostWorkspace3":{
            "type":"number",
            "description":"The cost of portfolio project fund based on the workspace currency. This value is based on the workspace3 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 : ApiEntityPortfolioProjectFund

Type: object

Title: ApiEntityPortfolioProjectFund

Show Source

• allocated: number (double)
  The portion of the fund that has been distributed to projects.
• allocatedWorkspace1: number (double)
  The portion of the fund that has been distributed to projects based on the workspace currency. This value is based on the workspace1 currency.
• allocatedWorkspace2: number (double)
  The portion of the fund that has been distributed to projects based on the workspace currency. This value is based on the workspace2 currency.
• allocatedWorkspace3: number (double)
  The portion of the fund that has been distributed to projects based on the workspace currency. This value is based on the workspace3 currency.
• appropriated: number (double)
  The portion of the fund that has been committed to work on projects.
• appropriatedWorkspace1: number (double)
  The portion of the fund that has been committed to work on projects based on the workspace currency. This value is based on the workspace1 currency.
• appropriatedWorkspace2: number (double)
  The portion of the fund that has been committed to work on projects based on the workspace currency. This value is based on the workspace2 currency.
• appropriatedWorkspace3: number (double)
  The portion of the fund that has been committed to work on projects based on the workspace currency. 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.
• consumedWorkspace1: number (double)
  The portion of the fund that has been spent to complete work on projects based on the workspace currency. 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 based on the workspace currency. 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 based on the workspace currency. This value is based on the workspace3 currency.
• fundAssignUnAssignAction: string
  Allowed Values: [ "ASSIGN", "UNASSIGN" ]

  The action to be taken for a fund associated with a plan project.
• fundCode: string
  Maximum Length: 60

  The user-specified identifier of a fund associated with a plan project.
• fundEndDate: string (date-time)
  The date when money in the fund will no longer be available.
• fundId: integer (int64)
  The unique identifier of a fund associated with a plan project.
• fundName: string
  Maximum Length: 255

  The name of a fund associated with a plan project.
• fundStartDate: string (date-time)
  The date when money in the fund will start being available.
• fundStatus: string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  The status of a fund associated with a plan project.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• periods: array periods
  The phase wise fund associated with a plan project.
• proposedFund: number (double)
  The proposed fund of a fund associated with a plan project based on base currency.
• proposedFundDistributed: number (double)
  The amount of money that has been distributed for the fund.
• proposedFundDistributedWorkspace1: number (double)
  The amount of money that has been distributed for the fund based on the workspace currency. This value is based on the workspace1 currency.
• proposedFundDistributedWorkspace2: number (double)
  The amount of money that has been distributed for the fund based on the workspace currency. This value is based on the workspace2 currency.
• proposedFundDistributedWorkspace3: number (double)
  The amount of money that has been distributed for the fund based on the workspace currency. This value is based on the workspace3 currency.
• proposedFundUndistributed: number (double)
  The amount of money that has not been distributed for the fund.
• proposedFundUndistributedWorkspace1: number (double)
  The amount of money that has not been distributed for the fund based on the workspace currency. This value is based on the workspace1 currency.
• proposedFundUndistributedWorkspace2: number (double)
  The amount of money that has not been distributed for the fund based on the workspace currency. This value is based on the workspace2 currency.
• proposedFundUndistributedWorkspace3: number (double)
  The amount of money that has not been distributed for the fund based on the workspace currency. This value is based on the workspace3 currency.
• proposedFundWorkspace1: number (double)
  The proposed fund of a fund associated with a plan project based on the workspace currency. This value is based on the workspace1 currency.
• proposedFundWorkspace2: number (double)
  The proposed fund of a fund associated with a plan project based on the workspace currency. This value is based on the workspace2 currency.
• proposedFundWorkspace3: number (double)
  The proposed fund of a fund associated with a plan project based on the workspace currency. This value is based on the workspace3 currency.
• remaining: number (double)
  The portion of the fund that has not been consumed.
• remainingWorkspace1: number (double)
  The portion of the fund that has not been consumed based on the workspace currency. This value is based on the workspace1 currency.
• remainingWorkspace2: number (double)
  The portion of the fund that has not been consumed based on the workspace currency. This value is based on the workspace2 currency.
• remainingWorkspace3: number (double)
  The portion of the fund that has not been consumed based on the workspace currency. This value is based on the workspace3 currency.
• total: number (double)
  The amount of money granted for the fund.
• totalWorkspace1: number (double)
  The amount of money granted for the fund based on the workspace currency. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  The amount of money granted for the fund based on the workspace currency. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  The amount of money granted for the fund based on the workspace currency. This value is based on the workspace3 currency.
• unappropriated: number (double)
  The portion of the fund that has not been committed to actual work.
• unappropriatedWorkspace1: number (double)
  The portion of the fund that has not been committed to actual work based on the workspace currency. This value is based on the workspace1 currency.
• unappropriatedWorkspace2: number (double)
  The portion of the fund that has not been committed to actual work based on the workspace currency. This value is based on the workspace2 currency.
• unappropriatedWorkspace3: number (double)
  The portion of the fund that has not been committed to actual work based on the workspace currency. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityPortfolioProjectFund",
    "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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "total":{
            "type":"number",
            "description":"The amount of money granted for the fund.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "type":"number",
            "description":"The amount of money granted for the fund based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "type":"number",
            "description":"The amount of money granted for the fund based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "type":"number",
            "description":"The amount of money granted for the fund based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundDistributed":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundDistributedWorkspace1":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundDistributedWorkspace2":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundDistributedWorkspace3":{
            "type":"number",
            "description":"The amount of money that has been distributed for the fund based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundUndistributed":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundUndistributedWorkspace1":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundUndistributedWorkspace2":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundUndistributedWorkspace3":{
            "type":"number",
            "description":"The amount of money that has not been distributed for the fund based on the workspace currency. 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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been committed to work on projects based on the workspace currency. 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 based on the workspace currency. 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 based on the workspace currency. 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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has not been committed to actual work based on the workspace currency. 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 based on the workspace currency. 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 based on the workspace currency. 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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been spent to complete work on projects based on the workspace currency. 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 based on the workspace currency. 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 based on the workspace currency. 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 based on the workspace currency. 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 based on the workspace currency. 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 based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "fundId":{
            "type":"integer",
            "description":"The unique identifier of a fund associated with a plan project. ",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of a fund associated with a plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a fund associated with a plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundStatus":{
            "type":"string",
            "description":"The status of a fund associated with a plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "fundStartDate":{
            "type":"string",
            "description":"The date when money in the fund will start being available.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundEndDate":{
            "type":"string",
            "description":"The date when money in the fund will no longer be available.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedFund":{
            "type":"number",
            "description":"The proposed fund of a fund associated with a plan project based on base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "periods":{
            "type":"array",
            "description":"The phase wise fund associated with a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundPeriod",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "allocated":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects.",
            "format":"double",
            "exampleSetFlag":false
        },
        "fundAssignUnAssignAction":{
            "type":"string",
            "description":"The action to be taken for a fund associated with a plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ASSIGN",
                "UNASSIGN"
            ]
        },
        "proposedFundWorkspace1":{
            "type":"number",
            "description":"The proposed fund of a fund associated with a plan project based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundWorkspace2":{
            "type":"number",
            "description":"The proposed fund of a fund associated with a plan project based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFundWorkspace3":{
            "type":"number",
            "description":"The proposed fund of a fund associated with a plan project based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that has been distributed to projects based on the workspace currency. 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 based on the workspace currency. 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 based on the workspace currency. This value is based on the workspace3 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 : periods

Type: array

The phase wise fund associated with a plan project.

Show Source

• Array of: object ApiEntityFundPeriod
  Title: ApiEntityFundPeriod

{
    "type":"array",
    "description":"The phase wise fund associated with a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityFundPeriod",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

204 Response

Successful operation with no content.

404 Response

The requested scenario does not exist, or you do not have access to it.

Back to Top