View a Fund
get
/api/restapi/funds/{fundId}
Send a request to this endpoint to view a fund for the specified fund ID.
Request
Path Parameters
-
fundId(required): integer(int64)
ID of the fund to be found.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityFund
Type:
object
Title:
ApiEntityFund
Read Only:
Show Source
true
-
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.
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
Nested Schema : configuredFields
Type:
array
The list of configured fields for a fund.
Show Source
-
Array of:
object ApiEntityFundConfiguredFieldValue
Title:
ApiEntityFundConfiguredFieldValue
Nested Schema : fundCost
Defines the fund cost of a fund.
Match All
Show Source
-
object
ApiEntityFundCost
Title:
ApiEntityFundCost
Nested Schema : spreadRows
Type:
array
Defines the spread rows for a fund.
Show Source
-
Array of:
object ApiEntityFundSpreadRow
Title:
ApiEntityFundSpreadRow
Nested Schema : ApiEntityCodeValueFund
Type:
object
Title:
Show Source
ApiEntityCodeValueFund
-
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.
Nested Schema : ApiEntityFundConfiguredFieldValue
Type:
object
Title:
Show Source
ApiEntityFundConfiguredFieldValue
-
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.
Nested Schema : ApiEntityFundCost
Type:
object
Title:
Show Source
ApiEntityFundCost
-
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.
Nested Schema : ApiEntityFundSpreadRow
Type:
object
Title:
Show Source
ApiEntityFundSpreadRow
-
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.
Nested Schema : fundAllocationSpreadRows
Type:
array
Defines the spread rows for a fund allocation.
Show Source
-
Array of:
object ApiEntityFundAllocationSpreadRow
Title:
ApiEntityFundAllocationSpreadRow
Nested Schema : fundSpreadRowCost
Defines the cost associated with the spread rows of the fund.
Match All
Show Source
-
object
ApiEntityFundCostSpreadRow
Title:
ApiEntityFundCostSpreadRow
Nested Schema : ApiEntityFundAllocationSpreadRow
Type:
object
Title:
Show Source
ApiEntityFundAllocationSpreadRow
-
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.
Nested Schema : fund
The unique identification code of the fund.
Match All
Show Source
-
object
ApiEntityFund
Title:
ApiEntityFund
Read Only:true
Nested Schema : fundAllocationSpreadRowCost
Defines the cost associated with the spread rows of the workspace total item.
Match All
Show Source
-
object
ApiEntityFundAllocationSpreadRowCost
Title:
ApiEntityFundAllocationSpreadRowCost
Nested Schema : ApiEntityFundAllocationSpreadRowCost
Type:
object
Title:
Show Source
ApiEntityFundAllocationSpreadRowCost
-
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.
Nested Schema : ApiEntityFundCostSpreadRow
Type:
object
Title:
Show Source
ApiEntityFundCostSpreadRow
-
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.
404 Response
The requested object does not exist, or you do not have access to it.