Jump to

• Request
• Response

View Fund Totals by Workspace Code

get

/api/restapi/funds/workspace/fundtotal

Send a request to this endpoint to view fund totals for the specified workspace code.

Request

Query Parameters

• workspaceCode(required): string
  Code of the workspace to be found.
  This is a required field.

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<ApiEntityFundTotal>

Type: array

Title: List<ApiEntityFundTotal>

Show Source

• Array of: object ApiEntityFundTotal
  Title: ApiEntityFundTotal

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

Nested Schema : ApiEntityFundTotal

Type: object

Title: ApiEntityFundTotal

Show Source

• capitalPortfolioId: integer (int64)
  The system-generated unique identifier for Portfolio Fund.
• fundTotalId: integer (int64)
  The auto-generated sequence number for the Fund Total.
• fundTotalItemCost: fundTotalItemCost
  The Cost value for the Fund Total Item.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• sourceId: integer (int64)
  The unique identifier for the source of the fund. This could be Portfolio, Program, Project, or Workspace.
• type: string
  Allowed Values: [ "WORKSPACE", "PROJECT", "PORTFOLIO" ]

  The Type value specifies whether the fund total is of the Type Portfolio, Program, Project, or Workspace.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• workspaceId: integer (int64)
  The unique identifier for the workspace.

{
    "title":"ApiEntityFundTotal",
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"The Type value specifies whether the fund total is of the Type Portfolio, Program, Project, or Workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "WORKSPACE",
                "PROJECT",
                "PORTFOLIO"
            ]
        },
        "capitalPortfolioId":{
            "type":"integer",
            "description":"The system-generated unique identifier for Portfolio Fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceId":{
            "type":"integer",
            "description":"The unique identifier for the source of the fund. This could be Portfolio, Program, Project, or Workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundTotalId":{
            "type":"integer",
            "description":"The auto-generated sequence number for the Fund Total.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundTotalItemCost":{
            "description":"The Cost value for the Fund Total Item.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFundTotalItemCost"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : fundTotalItemCost

The Cost value for the Fund Total Item.

Match All

Show Source

• object ApiEntityFundTotalItemCost
  Title: ApiEntityFundTotalItemCost

{
    "description":"The Cost value for the Fund Total Item.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityFundTotalItemCost"
        }
    ]
}

Nested Schema : ApiEntityFundTotalItemCost

Type: object

Title: ApiEntityFundTotalItemCost

Show Source

• allocated: number (double)
  The portion of all funds in the workspace that has been reserved for work on projects, programs and other workspaces.
• allocatedWorkspace1: number (double)
  The portion of all funds in the workspace that has been reserved for work on projects, programs and other workspaces. This value is based on the workspace1 currency.
• allocatedWorkspace2: number (double)
  The portion of all funds in the workspace that has been reserved for work on projects, programs and other workspaces. This value is based on the workspace2 currency.
• allocatedWorkspace3: number (double)
  The portion of all funds in the workspace that has been reserved for work on projects, programs and other workspaces. This value is based on the workspace3 currency.
• appropriated: number (double)
  The portion of all funds in the workspace that has been committed to work on projects or programs.
• appropriatedWorkspace1: number (double)
  The portion of all funds in the workspace that has been committed to work on projects or programs. This value is based on the workspace1 currency.
• appropriatedWorkspace2: number (double)
  The portion of all funds in the workspace that has been committed to work on projects or programs. This value is based on the workspace2 currency.
• appropriatedWorkspace3: number (double)
  The portion of all funds in the workspace that has been committed to work on projects or programs. This value is based on the workspace3 currency.
• consumed: number (double)
  The portion of all funds in the workspace that has been spent to complete work on projects or programs.
• consumedWorkspace1: number (double)
  The portion of all funds in the workspace that has been spent to complete work on projects or programs. This value is based on the workspace1 currency.
• consumedWorkspace2: number (double)
  The portion of all funds in the workspace that has been spent to complete work on projects or programs. This value is based on the workspace2 currency.
• consumedWorkspace3: number (double)
  The portion of all funds in the workspace that has been spent to complete work on projects or programs. This value is based on the workspace3 currency.
• fundTotalItemId: integer (int64)
  The auto-generated sequence number for the Fund Total.
• link: string (url)
  Read Only: true

  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 all funds in the workspace that has not been consumed.
• remainingWorkspace1: number (double)
  The portion of all funds in the workspace that has not been consumed. This value is based on the workspace1 currency.
• remainingWorkspace2: number (double)
  The portion of all funds in the workspace that has not been consumed. This value is based on the workspace2 currency.
• remainingWorkspace3: number (double)
  The portion of all funds in the workspace that has not been consumed. This value is based on the workspace3 currency.
• total: number (double)
  The total amount of money granted for funds in the workspace.
• totalWorkspace1: number (double)
  The total amount of money granted for funds in the workspace. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  The total amount of money granted for funds in the workspace. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  The total amount of money granted for funds in the workspace. This value is based on the workspace3 currency.
• unallocated: number (double)
  The portion of all funds in the workspace that has not been reserved for work on projects, programs or other workspaces.
• unallocatedWorkspace1: number (double)
  The portion of all funds in the workspace that has not been reserved for work on projects, programs or other workspaces. This value is based on the workspace1 currency.
• unallocatedWorkspace2: number (double)
  The portion of all funds in the workspace that has not been reserved for work on projects, programs or other workspaces. This value is based on the workspace2 currency.
• unallocatedWorkspace3: number (double)
  The portion of all funds in the workspace that has not been reserved for work on projects, programs or other workspaces. This value is based on the workspace3 currency.
• unappropriated: number (double)
  The portion of all funds in the workspace that has not yet been committed to actual work.
• unappropriatedWorkspace1: number (double)
  The portion of all funds in the workspace that has not yet been committed to actual work. This value is based on the workspace1 currency.
• unappropriatedWorkspace2: number (double)
  The portion of all funds in the workspace that has not yet been committed to actual work. This value is based on the workspace2 currency.
• unappropriatedWorkspace3: number (double)
  The portion of all funds in the workspace that has not yet been committed to actual work. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityFundTotalItemCost",
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remaining":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has not been consumed.",
            "format":"double",
            "exampleSetFlag":false
        },
        "total":{
            "type":"number",
            "description":"The total amount of money granted for funds in the workspace.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "type":"number",
            "description":"The total amount of money granted for funds in the workspace. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "type":"number",
            "description":"The total amount of money granted for funds in the workspace. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "type":"number",
            "description":"The total amount of money granted for funds in the workspace. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriated":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has been committed to work on projects or programs.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace1":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has been committed to work on projects or programs. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace2":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has been committed to work on projects or programs. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "appropriatedWorkspace3":{
            "type":"number",
            "description":"The portion of all funds in the workspace 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 all funds in the workspace that has not yet been committed to actual work.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace1":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has not yet been committed to actual work. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace2":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has not yet been committed to actual work. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unappropriatedWorkspace3":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has not yet been committed to actual work. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumed":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has been spent to complete work on projects or programs.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace1":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has been spent to complete work on projects or programs. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace2":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has been spent to complete work on projects or programs. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "consumedWorkspace3":{
            "type":"number",
            "description":"The portion of all funds in the workspace 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 all funds in the workspace that has not been consumed. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace2":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has not been consumed. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingWorkspace3":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has not been consumed. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocated":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has been reserved for work on projects, programs and other workspaces.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace1":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has been reserved for work on projects, programs and other workspaces. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace2":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has been reserved for work on projects, programs and other workspaces. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedWorkspace3":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has been reserved for work on projects, programs and other workspaces. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocated":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has not been reserved for work on projects, programs or other workspaces.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace1":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has not been reserved for work on projects, programs or other workspaces. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace2":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has not been reserved for work on projects, programs or other workspaces. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unallocatedWorkspace3":{
            "type":"number",
            "description":"The portion of all funds in the workspace that has not been reserved for work on projects, programs or other workspaces. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "fundTotalItemId":{
            "type":"integer",
            "description":"The auto-generated sequence number for the Fund Total.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

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

Back to Top