API V3 Documentation – FCO
Preview: this documents PQFORCE 4.26.6, which has not been released yet.
Endpoints
GET /API/V3/FCO/BudgetPosition/:budgetPositionId
Returns a budget position owned by a project portfolio
HTTP syntax
GET /API/V3/FCO/BudgetPosition/:budgetPositionId
<- application/json : BudgetPosition JavaScript syntax
Pqf.fco.getBudgetPosition(budgetPositionId) // returns BudgetPosition Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetPositionId |
UUID | The budget position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: BudgetPosition
PUT /API/V3/FCO/BudgetPosition/:budgetPositionId
Updates a budget position owned by a project portfolio
HTTP syntax
PUT /API/V3/FCO/BudgetPosition/:budgetPositionId
-> application/json : BudgetPosition JavaScript syntax
Pqf.fco.putBudgetPosition(budgetPositionId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetPositionId |
UUID | The budget position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
BudgetPosition | JSON object of type BudgetPosition | ✔️ |
DELETE /API/V3/FCO/BudgetPosition/:budgetPositionId
Deletes a budget position owned by a project portfolio
HTTP syntax
DELETE /API/V3/FCO/BudgetPosition/:budgetPositionId JavaScript syntax
Pqf.fco.delBudgetPosition(budgetPositionId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetPositionId |
UUID | The budget position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/FCO/BudgetPosition/:budgetPositionId/Parent
Returns a reference to the project portfolio owning a budget position. It needs no more than the permission to identify that portfolio, where reading the budget position itself with fco.getBudgetPosition needs to read the portfolio's budget
HTTP syntax
GET /API/V3/FCO/BudgetPosition/:budgetPositionId/Parent
<- application/json : PF.Reference JavaScript syntax
Pqf.fco.getBudgetPositionParent(budgetPositionId) // returns PF.Reference Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetPositionId |
UUID | The budget position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/FCO/BudgetPosition/:budgetPositionId/Timeline
Returns the version (history) timeline of a budget position owned by a project portfolio
HTTP syntax
GET /API/V3/FCO/BudgetPosition/:budgetPositionId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.fco.getBudgetPositionTimeline(budgetPositionId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.fco.getBudgetPositionTimeline(budgetPositionId, limit, until, from) // returns PF.VersionTimeline
Pqf.fco.getBudgetPositionTimeline(budgetPositionId, limit, until) // returns PF.VersionTimeline
Pqf.fco.getBudgetPositionTimeline(budgetPositionId, limit) // returns PF.VersionTimeline
Pqf.fco.getBudgetPositionTimeline(budgetPositionId) // returns PF.VersionTimeline Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetPositionId |
UUID | The budget position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
limit |
int? | Limits the number of slots | i > 0 (The value, if present, must be greater than 0.) |
|
until |
datetime | Latest date of the timeline | ||
from |
datetime | Earliest date of the timeline | ||
granularity |
PF.CalendarGranularity | The granularity of the timeline |
Result
This endpoint returns the following data: PF.VersionTimeline
GET /API/V3/FCO/BudgetPositions
Returns references to all budget positions owned by project portfolios, each one with its owning portfolio as its parent
HTTP syntax
GET /API/V3/FCO/BudgetPositions?sort=...
<- application/json JavaScript syntax
Pqf.fco.getAllBudgetPositions(sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.fco.getAllBudgetPositions() // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectPortfolioId, costsTypeId, budgetAmount, sortIndex and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
GET /API/V3/FCO/BudgetPositions/:budgetPositionIds
Returns some budget positions owned by project portfolios, specified by their IDs
HTTP syntax
GET /API/V3/FCO/BudgetPositions/:budgetPositionIds
<- application/json JavaScript syntax
Pqf.fco.getBudgetPositions(budgetPositionIds) // returns BudgetPosition[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetPositionIds |
array of UUID | The budget positions' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of BudgetPosition
POST /API/V3/FCO/Calculator/Sum
Calculates a sum of currency amounts
HTTP syntax
POST /API/V3/FCO/Calculator/Sum?targetCurrencyId=...&day=...
-> application/json
<- application/json : PF.CurrencyAmount JavaScript syntax
Pqf.fco.calculateSum(targetCurrencyId, day, requestJson) // returns PF.CurrencyAmount
// Overloads for optional parameters
Pqf.fco.calculateSum(targetCurrencyId, requestJson) // returns PF.CurrencyAmount
Pqf.fco.calculateSum(requestJson) // returns PF.CurrencyAmount Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
targetCurrencyId |
UUID | The destination currency (optional, use single or home currency if not specified) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
day |
date | The day whose exchange rates should be used (optional) | ||
requestJson |
array of PF.CurrencyAmount | JSON object of type array of CurrencyAmount | ✔️ |
Result
This endpoint returns the following data: PF.CurrencyAmount
GET /API/V3/FCO/CostsActual/:costsActualId
Get a costs actual
HTTP syntax
GET /API/V3/FCO/CostsActual/:costsActualId
<- application/json : CostsActual JavaScript syntax
Pqf.fco.getCostsActual(costsActualId) // returns CostsActual Other endpoints for objects of type costs actual
This endpoint is part of a group of endpoints manipulating objects of type costs actual. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple costs actualsFCO/ CostsActuals/ :costsActualIds - PUT /API/
V3/ : Update an existing costs actualFCO/ CostsActual/ :costsActualId - DELETE /API/
V3/ : Delete a costs actualFCO/ CostsActual/ :costsActualId - GET /API/
V3/ : Get a costs actual identificationFCO/ CostsActual/ :costsActualId/ Identification - GET /API/
V3/ : Get multiple costs actual identificationsFCO/ CostsActuals/ :costsActualIds/ Identification
Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on parent with type ProjectCostsPositionobject of type ProjectCostsActual and ID specified in parameter costsActualId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsActualId |
UUID | The costs actual's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsActual
PUT /API/V3/FCO/CostsActual/:costsActualId
Update an existing costs actual
HTTP syntax
PUT /API/V3/FCO/CostsActual/:costsActualId
-> application/json : CostsActual JavaScript syntax
Pqf.fco.putCostsActual(costsActualId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type costs actual
This endpoint is part of a group of endpoints manipulating objects of type costs actual. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a costs actualFCO/ CostsActual/ :costsActualId - GET /API/
V3/ : Get multiple costs actualsFCO/ CostsActuals/ :costsActualIds - DELETE /API/
V3/ : Delete a costs actualFCO/ CostsActual/ :costsActualId - GET /API/
V3/ : Get a costs actual identificationFCO/ CostsActual/ :costsActualId/ Identification - GET /API/
V3/ : Get multiple costs actual identificationsFCO/ CostsActuals/ :costsActualIds/ Identification
Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission UPDATE on parent with type ProjectCostsPositionobject of type ProjectCostsActual and ID specified in parameter costsActualId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsActualId |
UUID | The costs actual's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
CostsActual | JSON object of type CostsActual | ✔️ |
DELETE /API/V3/FCO/CostsActual/:costsActualId
Delete a costs actual
HTTP syntax
DELETE /API/V3/FCO/CostsActual/:costsActualId JavaScript syntax
Pqf.fco.delCostsActual(costsActualId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type costs actual
This endpoint is part of a group of endpoints manipulating objects of type costs actual. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a costs actualFCO/ CostsActual/ :costsActualId - GET /API/
V3/ : Get multiple costs actualsFCO/ CostsActuals/ :costsActualIds - PUT /API/
V3/ : Update an existing costs actualFCO/ CostsActual/ :costsActualId - GET /API/
V3/ : Get a costs actual identificationFCO/ CostsActual/ :costsActualId/ Identification - GET /API/
V3/ : Get multiple costs actual identificationsFCO/ CostsActuals/ :costsActualIds/ Identification
Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission UPDATE on parent with type ProjectCostsPositionobject of type ProjectCostsActual and ID specified in parameter costsActualId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsActualId |
UUID | The costs actual's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/FCO/CostsActual/:costsActualId/Converted
Returns the amount of a costs actual converted into the requested currency at its day of payment
HTTP syntax
GET /API/V3/FCO/CostsActual/:costsActualId/Converted?targetCurrencyId=...
<- application/json : CostsActualConverted JavaScript syntax
Pqf.fco.getCostsActualConverted(costsActualId, targetCurrencyId) // returns CostsActualConverted Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on parent with type ProjectCostsPositionobject of type ProjectCostsActual and ID specified in parameter costsActualId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsActualId |
UUID | The costs actual's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
targetCurrencyId |
UUID | The ID of the currency to convert all money values into | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsActualConverted
GET /API/V3/FCO/CostsActual/:costsActualId/Identification
Get a costs actual identification
HTTP syntax
GET /API/V3/FCO/CostsActual/:costsActualId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.fco.getCostsActualIdentification(costsActualId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.fco.getCostsActualIdentification(costsActualId) // returns PF.IdentificationExtended Other endpoints for objects of type costs actual
This endpoint is part of a group of endpoints manipulating objects of type costs actual. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a costs actualFCO/ CostsActual/ :costsActualId - GET /API/
V3/ : Get multiple costs actualsFCO/ CostsActuals/ :costsActualIds - PUT /API/
V3/ : Update an existing costs actualFCO/ CostsActual/ :costsActualId - DELETE /API/
V3/ : Delete a costs actualFCO/ CostsActual/ :costsActualId - GET /API/
V3/ : Get multiple costs actual identificationsFCO/ CostsActuals/ :costsActualIds/ Identification
Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on parent with type ProjectCostsPositionobject of type ProjectCostsActual and ID specified in parameter costsActualId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
costsActualId |
UUID | The costs actual's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/FCO/CostsActuals/:costsActualIds
Get multiple costs actuals
HTTP syntax
GET /API/V3/FCO/CostsActuals/:costsActualIds
<- application/json JavaScript syntax
Pqf.fco.getCostsActuals(costsActualIds) // returns CostsActual[] Other endpoints for objects of type costs actual
This endpoint is part of a group of endpoints manipulating objects of type costs actual. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a costs actualFCO/ CostsActual/ :costsActualId - PUT /API/
V3/ : Update an existing costs actualFCO/ CostsActual/ :costsActualId - DELETE /API/
V3/ : Delete a costs actualFCO/ CostsActual/ :costsActualId - GET /API/
V3/ : Get a costs actual identificationFCO/ CostsActual/ :costsActualId/ Identification - GET /API/
V3/ : Get multiple costs actual identificationsFCO/ CostsActuals/ :costsActualIds/ Identification
Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on parent with type ProjectCostsPositionobject of type ProjectCostsActual and ID in specified in parameter costsActualIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsActualIds |
array of UUID | The costs actual IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of CostsActual
GET /API/V3/FCO/CostsActuals/:costsActualIds/Converted
Returns the amounts of some costs actuals specified by their IDs, converted into the requested currency at their days of payment
HTTP syntax
GET /API/V3/FCO/CostsActuals/:costsActualIds/Converted?targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.fco.getCostsActualsConverted(costsActualIds, targetCurrencyId) // returns CostsActualConverted[] Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on parent with type ProjectCostsPositionobject of type ProjectCostsActual and ID in specified in parameter costsActualIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsActualIds |
array of UUID | The costs actuals' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
targetCurrencyId |
UUID | The ID of the currency to convert all money values into | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of CostsActualConverted
GET /API/V3/FCO/CostsActuals/:costsActualIds/Identification
Get multiple costs actual identifications
HTTP syntax
GET /API/V3/FCO/CostsActuals/:costsActualIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.fco.getCostsActualIdentifications(costsActualIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.fco.getCostsActualIdentifications(costsActualIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type costs actual
This endpoint is part of a group of endpoints manipulating objects of type costs actual. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a costs actualFCO/ CostsActual/ :costsActualId - GET /API/
V3/ : Get multiple costs actualsFCO/ CostsActuals/ :costsActualIds - PUT /API/
V3/ : Update an existing costs actualFCO/ CostsActual/ :costsActualId - DELETE /API/
V3/ : Delete a costs actualFCO/ CostsActual/ :costsActualId - GET /API/
V3/ : Get a costs actual identificationFCO/ CostsActual/ :costsActualId/ Identification
Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on parent with type ProjectCostsPositionobject of type ProjectCostsActual and ID in specified in parameter costsActualIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
costsActualIds |
array of UUID | The costs actual IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: array of PF.IdentificationExtended
GET /API/V3/FCO/CostsCenterEnumType
Returns a reference to the costs center enum type, so that it can be addressed via the generic pf enum endpoints
HTTP syntax
GET /API/V3/FCO/CostsCenterEnumType
<- application/json : PF.Reference JavaScript syntax
Pqf.fco.getCostsCenterEnumType() // returns PF.Reference Required license
This endpoint requires the following licenses:
- costmanagement
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/FCO/CostsPosition/:costsPositionId
Get a project costs position
HTTP syntax
GET /API/V3/FCO/CostsPosition/:costsPositionId
<- application/json : ProjectCostsPosition JavaScript syntax
Pqf.fco.getCostsPosition(costsPositionId) // returns ProjectCostsPosition Other endpoints for objects of type costs position
This endpoint is part of a group of endpoints manipulating objects of type costs position. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple project costs positionsFCO/ CostsPositions/ :costsPositionIds - PUT /API/
V3/ : Create or update a project costs positionFCO/ CostsPosition/ :costsPositionId - DELETE /API/
V3/ : Delete a project costs positionFCO/ CostsPosition/ :costsPositionId - GET /API/
V3/ : Get a project costs position identificationFCO/ CostsPosition/ :costsPositionId/ Identification - GET /API/
V3/ : Get multiple project costs position identificationsFCO/ CostsPositions/ :costsPositionIds/ Identification
Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type ProjectCostsPosition and ID specified in parameter costsPositionId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsPositionId |
UUID | The project costs position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectCostsPosition
PUT /API/V3/FCO/CostsPosition/:costsPositionId
Create or update a project costs position
HTTP syntax
PUT /API/V3/FCO/CostsPosition/:costsPositionId
-> application/json : ProjectCostsPosition JavaScript syntax
Pqf.fco.putCostsPosition(costsPositionId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type costs position
This endpoint is part of a group of endpoints manipulating objects of type costs position. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project costs positionFCO/ CostsPosition/ :costsPositionId - GET /API/
V3/ : Get multiple project costs positionsFCO/ CostsPositions/ :costsPositionIds - DELETE /API/
V3/ : Delete a project costs positionFCO/ CostsPosition/ :costsPositionId - GET /API/
V3/ : Get a project costs position identificationFCO/ CostsPosition/ :costsPositionId/ Identification - GET /API/
V3/ : Get multiple project costs position identificationsFCO/ CostsPositions/ :costsPositionIds/ Identification
Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission UPDATE or CREATE on object of type ProjectCostsPosition and ID specified in parameter costsPositionId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsPositionId |
UUID | The project costs position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectCostsPosition | JSON object of type ProjectCostsPosition | ✔️ |
DELETE /API/V3/FCO/CostsPosition/:costsPositionId
Delete a project costs position
HTTP syntax
DELETE /API/V3/FCO/CostsPosition/:costsPositionId JavaScript syntax
Pqf.fco.delCostsPosition(costsPositionId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type costs position
This endpoint is part of a group of endpoints manipulating objects of type costs position. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project costs positionFCO/ CostsPosition/ :costsPositionId - GET /API/
V3/ : Get multiple project costs positionsFCO/ CostsPositions/ :costsPositionIds - PUT /API/
V3/ : Create or update a project costs positionFCO/ CostsPosition/ :costsPositionId - GET /API/
V3/ : Get a project costs position identificationFCO/ CostsPosition/ :costsPositionId/ Identification - GET /API/
V3/ : Get multiple project costs position identificationsFCO/ CostsPositions/ :costsPositionIds/ Identification
Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission DELETE on object of type ProjectCostsPosition and ID specified in parameter costsPositionId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsPositionId |
UUID | The project costs position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/FCO/CostsPosition/:costsPositionId/Converted
Returns a costs position with all money values converted into the requested currency
HTTP syntax
GET /API/V3/FCO/CostsPosition/:costsPositionId/Converted?targetCurrencyId=...
<- application/json : CostsPositionConverted JavaScript syntax
Pqf.fco.getCostsPositionConverted(costsPositionId, targetCurrencyId) // returns CostsPositionConverted Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type ProjectCostsPosition and ID specified in parameter costsPositionId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsPositionId |
UUID | The costs position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
targetCurrencyId |
UUID | The ID of the currency to convert all money values into | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsPositionConverted
POST /API/V3/FCO/CostsPosition/:costsPositionId/CostsActual/:costsActualId/Move/:targetCostsPositionId
Moves an actual (bill) from one costs position to another on the same project
HTTP syntax
POST /API/V3/FCO/CostsPosition/:costsPositionId/CostsActual/:costsActualId/Move/:targetCostsPositionId
<- application/json : PF.Reference JavaScript syntax
Pqf.fco.moveCostsPositionActual(costsPositionId, costsActualId, targetCostsPositionId) // returns PF.Reference Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission UPDATE on object of type ProjectCostsPosition and ID specified in parameter costsPositionId.
Requires permission UPDATE on object of type ProjectCostsPosition and ID specified in parameter targetCostsPositionId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsPositionId |
UUID | The source costs position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
costsActualId |
UUID | The costs actual's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
targetCostsPositionId |
UUID | The target costs position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/FCO/CostsPosition/:costsPositionId/CostsActuals
Returns references to all costs actuals belonging to a specific costs position
HTTP syntax
GET /API/V3/FCO/CostsPosition/:costsPositionId/CostsActuals?sort=...
<- application/json JavaScript syntax
Pqf.fco.getCostsActualsOfCostsPosition(costsPositionId, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.fco.getCostsActualsOfCostsPosition(costsPositionId) // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type ProjectCostsPosition and ID specified in parameter costsPositionId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsPositionId |
UUID | The costs position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, costsPositionId, timeOfPayment, sortIndex and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
POST /API/V3/FCO/CostsPosition/:costsPositionId/CostsActuals/Add
Adds a costs actual to a costs position
HTTP syntax
POST /API/V3/FCO/CostsPosition/:costsPositionId/CostsActuals/Add?name=...&code=...&description=...&color=...&iconRef=...¤cyId=...&amount=...&timeOfPayment=...&sortIndex=...
<- application/json : PF.Reference JavaScript syntax
Pqf.fco.addCostsActual(costsPositionId, name, code, description, color, iconRef, currencyId, amount, timeOfPayment, sortIndex) // returns PF.Reference
// Overloads for optional parameters
Pqf.fco.addCostsActual(costsPositionId, name, code, description, color, iconRef, currencyId, amount, timeOfPayment) // returns PF.Reference
Pqf.fco.addCostsActual(costsPositionId, name, code, description, color, iconRef, currencyId, amount) // returns PF.Reference
Pqf.fco.addCostsActual(costsPositionId, name, code, description, color, iconRef, currencyId) // returns PF.Reference
Pqf.fco.addCostsActual(costsPositionId, name, code, description, color, iconRef) // returns PF.Reference
Pqf.fco.addCostsActual(costsPositionId, name, code, description, color) // returns PF.Reference
Pqf.fco.addCostsActual(costsPositionId, name, code, description) // returns PF.Reference
Pqf.fco.addCostsActual(costsPositionId, name, code) // returns PF.Reference
Pqf.fco.addCostsActual(costsPositionId, name) // returns PF.Reference
Pqf.fco.addCostsActual(costsPositionId) // returns PF.Reference Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission UPDATE on object of type ProjectCostsPosition and ID specified in parameter costsPositionId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
costsPositionId |
UUID | The costs position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
name |
string | The name of the new costs actual, a localized default name if omitted | |||
code |
string | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
||
description |
string | A descriptive text about the new costs actual, may contain HTML | |||
color |
color | The color of the new costs actual | |||
iconRef |
URI | The icon of the new costs actual, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
||
currencyId |
UUID | The ID of the currency of the new costs actual, the user's currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
amount |
double | The amount of the new costs actual | 0 |
||
timeOfPayment |
date | The day when the new costs actual was (or will be) paid, today if omitted | |||
sortIndex |
double? | The sort index that determines the position of the inserted object, appended behind the existing ones if omitted |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/FCO/CostsPosition/:costsPositionId/CostsTimeline
Calculates a costs timeline for a project costs position, broken down by calendar period and cascaded into groups by the requested dimensions
HTTP syntax
GET /API/V3/FCO/CostsPosition/:costsPositionId/CostsTimeline?start=...&end=...&zoom=...&grouping=...&targetCurrencyId=...&flowFilter=...&costsTypeFilter=...&costsTypeGroupFilter=...&costsContainerFilter=...&managementPhaseFilter=...
<- application/json : CostsMatrix JavaScript syntax
Pqf.fco.getCostsPositionCostsTimeline(costsPositionId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter, costsContainerFilter, managementPhaseFilter) // returns CostsMatrix
// Overloads for optional parameters
Pqf.fco.getCostsPositionCostsTimeline(costsPositionId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter, costsContainerFilter) // returns CostsMatrix
Pqf.fco.getCostsPositionCostsTimeline(costsPositionId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter) // returns CostsMatrix
Pqf.fco.getCostsPositionCostsTimeline(costsPositionId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter) // returns CostsMatrix
Pqf.fco.getCostsPositionCostsTimeline(costsPositionId, start, end, zoom, grouping, targetCurrencyId, flowFilter) // returns CostsMatrix
Pqf.fco.getCostsPositionCostsTimeline(costsPositionId, start, end, zoom, grouping, targetCurrencyId) // returns CostsMatrix
Pqf.fco.getCostsPositionCostsTimeline(costsPositionId, start, end, zoom, grouping) // returns CostsMatrix
Pqf.fco.getCostsPositionCostsTimeline(costsPositionId, start, end, zoom) // returns CostsMatrix
Pqf.fco.getCostsPositionCostsTimeline(costsPositionId, start, end) // returns CostsMatrix
Pqf.fco.getCostsPositionCostsTimeline(costsPositionId, start) // returns CostsMatrix
Pqf.fco.getCostsPositionCostsTimeline(costsPositionId) // returns CostsMatrix Required license
This endpoint requires the following licenses:
- costtimeline
Required permission
Requires permission READ on object of type ProjectCostsPosition and ID specified in parameter costsPositionId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
costsPositionId |
UUID | The costs position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
||
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
||
zoom |
array of PF.CalendarGranularity | The calendar granularities to break the timeline into, from coarsest to finest layer; no calendar layers if omitted | |||
grouping |
array of CostsDimension | The dimensions to cascade the grouping by, outermost first; grouped by container then flow if omitted | Container, Flow |
||
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
flowFilter |
array of CostsFlow | Filter by costs flow; all flows if omitted | |||
costsTypeFilter |
array of UUID | Filter by costs type; a null element matches costs without a costs type; all costs types if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
costsTypeGroupFilter |
array of UUID | Filter by costs type group; a null element matches costs without a costs type group; all costs type groups if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
costsContainerFilter |
array of UUID | Filter by costs container; a null element matches costs without a costs container; all costs containers if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
managementPhaseFilter |
array of UUID | Filter by project management phase; a null element matches costs without a management phase; all management phases if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsMatrix
GET /API/V3/FCO/CostsPosition/:costsPositionId/Identification
Get a project costs position identification
HTTP syntax
GET /API/V3/FCO/CostsPosition/:costsPositionId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.fco.getCostsPositionIdentification(costsPositionId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.fco.getCostsPositionIdentification(costsPositionId) // returns PF.IdentificationExtended Other endpoints for objects of type costs position
This endpoint is part of a group of endpoints manipulating objects of type costs position. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project costs positionFCO/ CostsPosition/ :costsPositionId - GET /API/
V3/ : Get multiple project costs positionsFCO/ CostsPositions/ :costsPositionIds - PUT /API/
V3/ : Create or update a project costs positionFCO/ CostsPosition/ :costsPositionId - DELETE /API/
V3/ : Delete a project costs positionFCO/ CostsPosition/ :costsPositionId - GET /API/
V3/ : Get multiple project costs position identificationsFCO/ CostsPositions/ :costsPositionIds/ Identification
Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission IDENTIFY on object of type ProjectCostsPosition and ID specified in parameter costsPositionId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
costsPositionId |
UUID | The project costs position's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/FCO/CostsPositions
Returns references to all costs positions of all projects
HTTP syntax
GET /API/V3/FCO/CostsPositions?sort=...
<- application/json JavaScript syntax
Pqf.fco.getAllCostsPositions(sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.fco.getAllCostsPositions() // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectId, costsTypeId, costsCenterId, payPlanId, sortIndex and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
GET /API/V3/FCO/CostsPositions/:costsPositionIds
Get multiple project costs positions
HTTP syntax
GET /API/V3/FCO/CostsPositions/:costsPositionIds
<- application/json JavaScript syntax
Pqf.fco.getCostsPositions(costsPositionIds) // returns ProjectCostsPosition[] Other endpoints for objects of type costs position
This endpoint is part of a group of endpoints manipulating objects of type costs position. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project costs positionFCO/ CostsPosition/ :costsPositionId - PUT /API/
V3/ : Create or update a project costs positionFCO/ CostsPosition/ :costsPositionId - DELETE /API/
V3/ : Delete a project costs positionFCO/ CostsPosition/ :costsPositionId - GET /API/
V3/ : Get a project costs position identificationFCO/ CostsPosition/ :costsPositionId/ Identification - GET /API/
V3/ : Get multiple project costs position identificationsFCO/ CostsPositions/ :costsPositionIds/ Identification
Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type ProjectCostsPosition and ID in specified in parameter costsPositionIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsPositionIds |
array of UUID | The project costs position IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ProjectCostsPosition
GET /API/V3/FCO/CostsPositions/:costsPositionIds/Converted
Returns some costs positions specified by their IDs with all money values converted into the requested currency
HTTP syntax
GET /API/V3/FCO/CostsPositions/:costsPositionIds/Converted?targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.fco.getCostsPositionsConverted(costsPositionIds, targetCurrencyId) // returns CostsPositionConverted[] Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type ProjectCostsPosition and ID in specified in parameter costsPositionIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsPositionIds |
array of UUID | The costs positions' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
targetCurrencyId |
UUID | The ID of the currency to convert all money values into | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of CostsPositionConverted
GET /API/V3/FCO/CostsPositions/:costsPositionIds/Identification
Get multiple project costs position identifications
HTTP syntax
GET /API/V3/FCO/CostsPositions/:costsPositionIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.fco.getCostsPositionIdentifications(costsPositionIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.fco.getCostsPositionIdentifications(costsPositionIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type costs position
This endpoint is part of a group of endpoints manipulating objects of type costs position. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project costs positionFCO/ CostsPosition/ :costsPositionId - GET /API/
V3/ : Get multiple project costs positionsFCO/ CostsPositions/ :costsPositionIds - PUT /API/
V3/ : Create or update a project costs positionFCO/ CostsPosition/ :costsPositionId - DELETE /API/
V3/ : Delete a project costs positionFCO/ CostsPosition/ :costsPositionId - GET /API/
V3/ : Get a project costs position identificationFCO/ CostsPosition/ :costsPositionId/ Identification
Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission IDENTIFY on object of type ProjectCostsPosition and ID in specified in parameter costsPositionIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
costsPositionIds |
array of UUID | The project costs position IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: array of PF.IdentificationExtended
GET /API/V3/FCO/CostsType/:costsTypeId
Get a costs type
HTTP syntax
GET /API/V3/FCO/CostsType/:costsTypeId
<- application/json : CostsType JavaScript syntax
Pqf.fco.getCostsType(costsTypeId) // returns CostsType Required license
This endpoint requires the following licenses:
- costmanagement
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsTypeId |
UUID | The ID of the desired costs type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsType
GET /API/V3/FCO/CostsType/:costsTypeId/WithTranslations
Get a costs type with translations
HTTP syntax
GET /API/V3/FCO/CostsType/:costsTypeId/WithTranslations
<- application/json : CostsTypeTranslated JavaScript syntax
Pqf.fco.getCostsTypeTranslated(costsTypeId) // returns CostsTypeTranslated Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsTypeId |
UUID | The ID of the desired costs type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsTypeTranslated
PUT /API/V3/FCO/CostsType/:costsTypeId/WithTranslations
Sets a costs type
HTTP syntax
PUT /API/V3/FCO/CostsType/:costsTypeId/WithTranslations
-> application/json : CostsTypeTranslated JavaScript syntax
Pqf.fco.putCostsTypeTranslated(costsTypeId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsTypeId |
UUID | The ID of the desired costs type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
CostsTypeTranslated | JSON object of type CostsTypeTranslated | ✔️ |
DELETE /API/V3/FCO/CostsType/:costsTypeId/WithTranslations
Deletes a costs type
HTTP syntax
DELETE /API/V3/FCO/CostsType/:costsTypeId/WithTranslations JavaScript syntax
Pqf.fco.delCostsTypeTranslated(costsTypeId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsTypeId |
UUID | The ID of the desired costs type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/FCO/CostsTypeGroup/:costsTypeGroupId
Get a costs type group
HTTP syntax
GET /API/V3/FCO/CostsTypeGroup/:costsTypeGroupId
<- application/json : CostsTypeGroup JavaScript syntax
Pqf.fco.getCostsTypeGroup(costsTypeGroupId) // returns CostsTypeGroup Required license
This endpoint requires the following licenses:
- costmanagement
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsTypeGroupId |
UUID | The ID of the desired costs type group | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsTypeGroup
GET /API/V3/FCO/CostsTypeGroup/:costsTypeGroupId/WithTranslations
Get a costs type group with translations
HTTP syntax
GET /API/V3/FCO/CostsTypeGroup/:costsTypeGroupId/WithTranslations
<- application/json : CostsTypeGroupTranslated JavaScript syntax
Pqf.fco.getCostsTypeGroupTranslated(costsTypeGroupId) // returns CostsTypeGroupTranslated Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsTypeGroupId |
UUID | The ID of the desired costs type group | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsTypeGroupTranslated
PUT /API/V3/FCO/CostsTypeGroup/:costsTypeGroupId/WithTranslations
Sets a costs type group
HTTP syntax
PUT /API/V3/FCO/CostsTypeGroup/:costsTypeGroupId/WithTranslations
-> application/json : CostsTypeGroupTranslated JavaScript syntax
Pqf.fco.putCostsTypeGroupTranslated(costsTypeGroupId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsTypeGroupId |
UUID | The ID of the desired costs type group | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
CostsTypeGroupTranslated | JSON object of type CostsTypeGroupTranslated | ✔️ |
DELETE /API/V3/FCO/CostsTypeGroup/:costsTypeGroupId/WithTranslations
Deletes a costs type group
HTTP syntax
DELETE /API/V3/FCO/CostsTypeGroup/:costsTypeGroupId/WithTranslations JavaScript syntax
Pqf.fco.delCostsTypeGroupTranslated(costsTypeGroupId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsTypeGroupId |
UUID | The ID of the desired costs type group | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/FCO/CostsTypeGroups
Returns references to all costs type groups
HTTP syntax
GET /API/V3/FCO/CostsTypeGroups?sort=...
<- application/json JavaScript syntax
Pqf.fco.getAllCostsTypeGroups(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.fco.getAllCostsTypeGroups() // returns PF.Reference[] Required license
This endpoint requires the following licenses:
- costmanagement
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, sortIndex | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/FCO/CostsTypeGroups/:costsTypeGroupIds
Get costs type groups specified by their IDs
HTTP syntax
GET /API/V3/FCO/CostsTypeGroups/:costsTypeGroupIds
<- application/json JavaScript syntax
Pqf.fco.getCostsTypeGroups(costsTypeGroupIds) // returns CostsTypeGroup[] Required license
This endpoint requires the following licenses:
- costmanagement
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsTypeGroupIds |
array of UUID | The costs type groups' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of CostsTypeGroup
GET /API/V3/FCO/CostsTypeGroups/:costsTypeGroupIds/WithTranslations
Get costs type groups specified by their IDs with translations
HTTP syntax
GET /API/V3/FCO/CostsTypeGroups/:costsTypeGroupIds/WithTranslations
<- application/json JavaScript syntax
Pqf.fco.getCostsTypeGroupsTranslated(costsTypeGroupIds) // returns CostsTypeGroupTranslated[] Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsTypeGroupIds |
array of UUID | The costs type groups' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of CostsTypeGroupTranslated
GET /API/V3/FCO/CostsTypes
Returns references to all costs types
HTTP syntax
GET /API/V3/FCO/CostsTypes?sort=...
<- application/json JavaScript syntax
Pqf.fco.getAllCostsTypes(sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.fco.getAllCostsTypes() // returns PF.ReferenceWithParent[]Required license
This endpoint requires the following licenses:
- costmanagement
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, sortIndex | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
GET /API/V3/FCO/CostsTypes/:costsTypeIds
Get costs types specified by their IDs
HTTP syntax
GET /API/V3/FCO/CostsTypes/:costsTypeIds
<- application/json JavaScript syntax
Pqf.fco.getCostsTypes(costsTypeIds) // returns CostsType[] Required license
This endpoint requires the following licenses:
- costmanagement
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsTypeIds |
array of UUID | The costs types' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of CostsType
GET /API/V3/FCO/CostsTypes/:costsTypeIds/WithTranslations
Get costs types specified by their IDs with translations
HTTP syntax
GET /API/V3/FCO/CostsTypes/:costsTypeIds/WithTranslations
<- application/json JavaScript syntax
Pqf.fco.getCostsTypesTranslated(costsTypeIds) // returns CostsTypeTranslated[] Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
costsTypeIds |
array of UUID | The costs types' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of CostsTypeTranslated
GET /API/V3/FCO/Currencies
Returns references to all available currencies
HTTP syntax
GET /API/V3/FCO/Currencies?sort=...
<- application/json JavaScript syntax
Pqf.fco.getAllCurrencies(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.fco.getAllCurrencies() // returns PF.Reference[]Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, sortIndex | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/FCO/Currencies/:currencyIds
Returns some currencies specified by their IDs
HTTP syntax
GET /API/V3/FCO/Currencies/:currencyIds
<- application/json JavaScript syntax
Pqf.fco.getCurrencies(currencyIds) // returns Currency[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
currencyIds |
array of UUID | The currencies' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of Currency
GET /API/V3/FCO/Currencies/:currencyIds/WithTranslations
Returns some currencies specified by their IDs with translations
HTTP syntax
GET /API/V3/FCO/Currencies/:currencyIds/WithTranslations
<- application/json JavaScript syntax
Pqf.fco.getCurrenciesTranslated(currencyIds) // returns CurrencyTranslated[] Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
currencyIds |
array of UUID | The currencies' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of CurrencyTranslated
GET /API/V3/FCO/Currency/:currencyId
Returns a currency
HTTP syntax
GET /API/V3/FCO/Currency/:currencyId
<- application/json : Currency JavaScript syntax
Pqf.fco.getCurrency(currencyId) // returns Currency Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
currencyId |
UUID | The ID of the currency | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: Currency
GET /API/V3/FCO/Currency/:currencyId/ExchangeRate/At/:day
Returns an exchange rate of a given currency at a specific date
HTTP syntax
GET /API/V3/FCO/Currency/:currencyId/ExchangeRate/At/:day?reciprocal=...
<- application/json : CurrencyExchangeRate JavaScript syntax
Pqf.fco.getCurrencyExchangeRateAt(currencyId, day, reciprocal) // returns CurrencyExchangeRate
// Overloads for optional parameters
Pqf.fco.getCurrencyExchangeRateAt(currencyId, day) // returns CurrencyExchangeRate Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
currencyId |
UUID | The ID of the currency | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
day |
date | The date where the rate should apply | ✔️ | ||
reciprocal |
boolean | Use reciprocal values | false |
Result
This endpoint returns the following data: CurrencyExchangeRate
PUT /API/V3/FCO/Currency/:currencyId/ExchangeRate/At/:day
Sets an exchange rate of a given currency at a specific date
HTTP syntax
PUT /API/V3/FCO/Currency/:currencyId/ExchangeRate/At/:day?reciprocal=...
-> application/json : CurrencyExchangeRate JavaScript syntax
Pqf.fco.putCurrencyExchangeRateAt(currencyId, day, reciprocal, requestJson) // returns Number - the return code (HTTP 2xx code) of the call
// Overloads for optional parameters
Pqf.fco.putCurrencyExchangeRateAt(currencyId, day, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
currencyId |
UUID | The ID of the currency | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
day |
date | The first date where the rate should apply | ✔️ | ||
reciprocal |
boolean | Use reciprocal values | false |
||
requestJson |
CurrencyExchangeRate | JSON object of type CurrencyExchangeRate | ✔️ |
DELETE /API/V3/FCO/Currency/:currencyId/ExchangeRate/At/:day
Deletes an exchange rate of a given currency at a specific date (that means the rate from the day before is still valid until the next explicit rate)
HTTP syntax
DELETE /API/V3/FCO/Currency/:currencyId/ExchangeRate/At/:day JavaScript syntax
Pqf.fco.delCurrencyExchangeRateAt(currencyId, day) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
currencyId |
UUID | The ID of the currency | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
day |
date | The first date where the rate should apply | ✔️ |
GET /API/V3/FCO/Currency/:currencyId/ExchangeRate/Today
Returns an exchange rate of a given currency at current date
HTTP syntax
GET /API/V3/FCO/Currency/:currencyId/ExchangeRate/Today?reciprocal=...
<- application/json : CurrencyExchangeRate JavaScript syntax
Pqf.fco.getCurrencyExchangeRateToday(currencyId, reciprocal) // returns CurrencyExchangeRate
// Overloads for optional parameters
Pqf.fco.getCurrencyExchangeRateToday(currencyId) // returns CurrencyExchangeRate Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
currencyId |
UUID | The ID of the currency | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
reciprocal |
boolean | Use reciprocal values | false |
Result
This endpoint returns the following data: CurrencyExchangeRate
GET /API/V3/FCO/Currency/:currencyId/ExchangeRates
Returns all exchange rates of a given currency
HTTP syntax
GET /API/V3/FCO/Currency/:currencyId/ExchangeRates?reciprocal=...
<- application/json : CurrencyExchangeRates JavaScript syntax
Pqf.fco.getCurrencyExchangeRates(currencyId, reciprocal) // returns CurrencyExchangeRates
// Overloads for optional parameters
Pqf.fco.getCurrencyExchangeRates(currencyId) // returns CurrencyExchangeRates Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
currencyId |
UUID | The ID of the currency | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
reciprocal |
boolean | Use reciprocal values | false |
Result
This endpoint returns the following data: CurrencyExchangeRates
GET /API/V3/FCO/Currency/:currencyId/WithTranslations
Returns a currency with translations
HTTP syntax
GET /API/V3/FCO/Currency/:currencyId/WithTranslations
<- application/json : CurrencyTranslated JavaScript syntax
Pqf.fco.getCurrencyTranslated(currencyId) // returns CurrencyTranslated Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
currencyId |
UUID | The ID of the currency | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CurrencyTranslated
PUT /API/V3/FCO/Currency/:currencyId/WithTranslations
Updates or creates a currency and its translations
HTTP syntax
PUT /API/V3/FCO/Currency/:currencyId/WithTranslations
-> application/json : CurrencyTranslated JavaScript syntax
Pqf.fco.putCurrencyTranslated(currencyId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
currencyId |
UUID | The ID of the currency | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
CurrencyTranslated | JSON object of type CurrencyTranslated | ✔️ |
DELETE /API/V3/FCO/Currency/:currencyId/WithTranslations
Deletes a currency
HTTP syntax
DELETE /API/V3/FCO/Currency/:currencyId/WithTranslations JavaScript syntax
Pqf.fco.delCurrencyTranslated(currencyId) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 5BD4980FE6C147218521122ED8D66C7D.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
currencyId |
UUID | The ID of the currency | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/FCO/CurrencyExchange/:currencyId/:amount
Converts a currency into another
HTTP syntax
GET /API/V3/FCO/CurrencyExchange/:currencyId/:amount?targetCurrencyId=...&day=...
<- application/json : PF.CurrencyAmount JavaScript syntax
Pqf.fco.convertCurrency(currencyId, amount, targetCurrencyId, day) // returns PF.CurrencyAmount
// Overloads for optional parameters
Pqf.fco.convertCurrency(currencyId, amount, targetCurrencyId) // returns PF.CurrencyAmount
Pqf.fco.convertCurrency(currencyId, amount) // returns PF.CurrencyAmount Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
currencyId |
UUID | The ID of the currency | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
amount |
double | The amount of money to convert | ✔️ | |
targetCurrencyId |
UUID | The destination currency (optional, use home currency if not specified) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
day |
date | The day whose exchange rates should be used (optional) |
Result
This endpoint returns the following data: PF.CurrencyAmount
GET /API/V3/FCO/HomeCurrency
Returns the tenant's home currency, i.e. the reference currency that monetary amounts are converted to when no other currency is specified
HTTP syntax
GET /API/V3/FCO/HomeCurrency
<- application/json : CurrencyJavaScript syntax
Pqf.fco.getHomeCurrency() // returns CurrencyResult
This endpoint returns the following data: Currency
GET /API/V3/FCO/PayPlanEnumType
Returns a reference to the pay plan enum type, so that it can be addressed via the generic pf enum endpoints
HTTP syntax
GET /API/V3/FCO/PayPlanEnumType
<- application/json : PF.ReferenceJavaScript syntax
Pqf.fco.getPayPlanEnumType() // returns PF.ReferenceRequired license
This endpoint requires the following licenses:
- costmanagement
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/FCO/PortfolioBudgetAssignment/:budgetAssignmentId
Returns a budget assignment of a project portfolio: a share of a budget position that has been assigned to it
HTTP syntax
GET /API/V3/FCO/PortfolioBudgetAssignment/:budgetAssignmentId
<- application/json : BudgetAssignment JavaScript syntax
Pqf.fco.getPortfolioBudgetAssignment(budgetAssignmentId) // returns BudgetAssignment Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetAssignmentId |
UUID | The budget assignment's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: BudgetAssignment
PUT /API/V3/FCO/PortfolioBudgetAssignment/:budgetAssignmentId
Updates a budget assignment of a project portfolio: only its amount can be changed
HTTP syntax
PUT /API/V3/FCO/PortfolioBudgetAssignment/:budgetAssignmentId
-> application/json : BudgetAssignment JavaScript syntax
Pqf.fco.putPortfolioBudgetAssignment(budgetAssignmentId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetAssignmentId |
UUID | The budget assignment's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
BudgetAssignment | JSON object of type BudgetAssignment | ✔️ |
DELETE /API/V3/FCO/PortfolioBudgetAssignment/:budgetAssignmentId
Deletes a budget assignment of a project portfolio, which withdraws the assigned share of the budget position
HTTP syntax
DELETE /API/V3/FCO/PortfolioBudgetAssignment/:budgetAssignmentId JavaScript syntax
Pqf.fco.delPortfolioBudgetAssignment(budgetAssignmentId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetAssignmentId |
UUID | The budget assignment's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/FCO/PortfolioBudgetAssignment/:budgetAssignmentId/Parents
Returns references to the parents of a budget assignment of a project portfolio: the project portfolio holding the assignment first, then the budget position the assigned budget stems from. It needs no more than the permission to identify that portfolio, where reading the assignment itself with fco.
HTTP syntax
GET /API/V3/FCO/PortfolioBudgetAssignment/:budgetAssignmentId/Parents
<- application/json JavaScript syntax
Pqf.fco.getPortfolioBudgetAssignmentParents(budgetAssignmentId) // returns PF.Reference[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetAssignmentId |
UUID | The budget assignment's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/FCO/PortfolioBudgetAssignment/:budgetAssignmentId/Timeline
Returns the version (history) timeline of a budget assignment of a project portfolio
HTTP syntax
GET /API/V3/FCO/PortfolioBudgetAssignment/:budgetAssignmentId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.fco.getPortfolioBudgetAssignmentTimeline(budgetAssignmentId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.fco.getPortfolioBudgetAssignmentTimeline(budgetAssignmentId, limit, until, from) // returns PF.VersionTimeline
Pqf.fco.getPortfolioBudgetAssignmentTimeline(budgetAssignmentId, limit, until) // returns PF.VersionTimeline
Pqf.fco.getPortfolioBudgetAssignmentTimeline(budgetAssignmentId, limit) // returns PF.VersionTimeline
Pqf.fco.getPortfolioBudgetAssignmentTimeline(budgetAssignmentId) // returns PF.VersionTimeline Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetAssignmentId |
UUID | The budget assignment's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
limit |
int? | Limits the number of slots | i > 0 (The value, if present, must be greater than 0.) |
|
until |
datetime | Latest date of the timeline | ||
from |
datetime | Earliest date of the timeline | ||
granularity |
PF.CalendarGranularity | The granularity of the timeline |
Result
This endpoint returns the following data: PF.VersionTimeline
GET /API/V3/FCO/PortfolioBudgetAssignments
Returns references to the budget assignments of all project portfolios, each one with the project portfolio holding it as its parent. An assignment is listed if the caller may identify the holder's budget; reading it needs fco.
HTTP syntax
GET /API/V3/FCO/PortfolioBudgetAssignments?sort=...
<- application/json JavaScript syntax
Pqf.fco.getAllPortfoliosBudgetAssignments(sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.fco.getAllPortfoliosBudgetAssignments() // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, holderId, budgetPositionId, sourcePortfolioId, amount | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
GET /API/V3/FCO/PortfolioBudgetAssignments/:budgetAssignmentIds
Returns some budget assignments of project portfolios, specified by their IDs
HTTP syntax
GET /API/V3/FCO/PortfolioBudgetAssignments/:budgetAssignmentIds
<- application/json JavaScript syntax
Pqf.fco.getPortfolioBudgetAssignments(budgetAssignmentIds) // returns BudgetAssignment[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetAssignmentIds |
array of UUID | The budget assignments' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of BudgetAssignment
GET /API/V3/FCO/PortfolioCosts/:projectPortfolioId/CostsTimeline
Calculates a costs timeline for a project portfolio, broken down by calendar period and cascaded into groups by the requested dimensions
HTTP syntax
GET /API/V3/FCO/PortfolioCosts/:projectPortfolioId/CostsTimeline?start=...&end=...&zoom=...&grouping=...&targetCurrencyId=...&flowFilter=...&costsTypeFilter=...&costsTypeGroupFilter=...&costsContainerFilter=...&projectFilter=...&costsPositionFilter=...&managementPhaseFilter=...
<- application/json : CostsMatrix JavaScript syntax
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter, costsContainerFilter, projectFilter, costsPositionFilter, managementPhaseFilter) // returns CostsMatrix
// Overloads for optional parameters
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter, costsContainerFilter, projectFilter, costsPositionFilter) // returns CostsMatrix
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter, costsContainerFilter, projectFilter) // returns CostsMatrix
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter, costsContainerFilter) // returns CostsMatrix
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter) // returns CostsMatrix
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter) // returns CostsMatrix
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId, start, end, zoom, grouping, targetCurrencyId, flowFilter) // returns CostsMatrix
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId, start, end, zoom, grouping, targetCurrencyId) // returns CostsMatrix
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId, start, end, zoom, grouping) // returns CostsMatrix
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId, start, end, zoom) // returns CostsMatrix
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId, start, end) // returns CostsMatrix
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId, start) // returns CostsMatrix
Pqf.fco.getPortfolioCostsTimeline(projectPortfolioId) // returns CostsMatrix Required license
This endpoint requires the following licenses:
- costtimeline
Required permission
Requires permission READ on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
||
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
||
zoom |
array of PF.CalendarGranularity | The calendar granularities to break the timeline into, from coarsest to finest layer; no calendar layers if omitted | |||
grouping |
array of CostsDimension | The dimensions to cascade the grouping by, outermost first; grouped by container then flow if omitted | Container, Flow |
||
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
flowFilter |
array of CostsFlow | Filter by costs flow; all flows if omitted | |||
costsTypeFilter |
array of UUID | Filter by costs type; a null element matches costs without a costs type; all costs types if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
costsTypeGroupFilter |
array of UUID | Filter by costs type group; a null element matches costs without a costs type group; all costs type groups if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
costsContainerFilter |
array of UUID | Filter by costs container; a null element matches costs without a costs container; all costs containers if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
projectFilter |
array of UUID | Filter by project; a null element matches costs without a project; all projects if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
costsPositionFilter |
array of UUID | Filter by project costs position; a null element matches costs without a costs position; all costs positions if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
managementPhaseFilter |
array of UUID | Filter by project management phase; a null element matches costs without a management phase; all management phases if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsMatrix
GET /API/V3/FCO/PortfolioCosts/:projectPortfolioId/ExternalBudgets
Returns the budgets that are consumed within a project portfolio but managed outside of it, one entry per budget position and managing project portfolio. External budgets are the union of the foreign budgets and the sub object budgets: every budget managed by a project portfolio other than this one, wherever that portfolio sits in the hierarchy. Read the two halves separately with fco.
HTTP syntax
GET /API/V3/FCO/PortfolioCosts/:projectPortfolioId/ExternalBudgets?referencePortfolioId=...&start=...&end=...&targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.fco.getPortfolioExternalBudgets(projectPortfolioId, referencePortfolioId, start, end, targetCurrencyId) // returns ExternalBudget[]
// Overloads for optional parameters
Pqf.fco.getPortfolioExternalBudgets(projectPortfolioId, referencePortfolioId, start, end) // returns ExternalBudget[]
Pqf.fco.getPortfolioExternalBudgets(projectPortfolioId, referencePortfolioId, start) // returns ExternalBudget[]
Pqf.fco.getPortfolioExternalBudgets(projectPortfolioId, referencePortfolioId) // returns ExternalBudget[]
Pqf.fco.getPortfolioExternalBudgets(projectPortfolioId) // returns ExternalBudget[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type ProjectPortfolioBudget and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
referencePortfolioId |
UUID | The project portfolio from which the costs should be seen, which decides which budgets count as owned rather than as managed by a sub object; the portfolio itself if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ExternalBudget
GET /API/V3/FCO/PortfolioCosts/:projectPortfolioId/ForeignBudgets
Returns the budgets that are consumed within a project portfolio but managed by a project portfolio outside its own subtree, one entry per budget position and managing project portfolio. Foreign budgets are the half of the external budgets that comes from elsewhere in the hierarchy, as opposed to the sub object budgets of fco.
HTTP syntax
GET /API/V3/FCO/PortfolioCosts/:projectPortfolioId/ForeignBudgets?referencePortfolioId=...&start=...&end=...&targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.fco.getPortfolioForeignBudgets(projectPortfolioId, referencePortfolioId, start, end, targetCurrencyId) // returns ExternalBudget[]
// Overloads for optional parameters
Pqf.fco.getPortfolioForeignBudgets(projectPortfolioId, referencePortfolioId, start, end) // returns ExternalBudget[]
Pqf.fco.getPortfolioForeignBudgets(projectPortfolioId, referencePortfolioId, start) // returns ExternalBudget[]
Pqf.fco.getPortfolioForeignBudgets(projectPortfolioId, referencePortfolioId) // returns ExternalBudget[]
Pqf.fco.getPortfolioForeignBudgets(projectPortfolioId) // returns ExternalBudget[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type ProjectPortfolioBudget and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
referencePortfolioId |
UUID | The project portfolio from which the costs should be seen; a budget is foreign when it is managed outside the addressed portfolio's own subtree, so this parameter does not change the result | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ExternalBudget
GET /API/V3/FCO/PortfolioCosts/:projectPortfolioId/Overview
Calculates a costs overview for a project portfolio, optionally as seen from another, enclosing portfolio
HTTP syntax
GET /API/V3/FCO/PortfolioCosts/:projectPortfolioId/Overview?referencePortfolioId=...&start=...&end=...&targetCurrencyId=...
<- application/json : CostsOverview JavaScript syntax
Pqf.fco.getPortfolioCostsOverview(projectPortfolioId, referencePortfolioId, start, end, targetCurrencyId) // returns CostsOverview
// Overloads for optional parameters
Pqf.fco.getPortfolioCostsOverview(projectPortfolioId, referencePortfolioId, start, end) // returns CostsOverview
Pqf.fco.getPortfolioCostsOverview(projectPortfolioId, referencePortfolioId, start) // returns CostsOverview
Pqf.fco.getPortfolioCostsOverview(projectPortfolioId, referencePortfolioId) // returns CostsOverview
Pqf.fco.getPortfolioCostsOverview(projectPortfolioId) // returns CostsOverview Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type ProjectPortfolioBudget and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
referencePortfolioId |
UUID | The portfolio from which the costs should be seen (with respect to own / foreign budgets); the portfolio itself if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsOverview
GET /API/V3/FCO/PortfolioCosts/:projectPortfolioId/SubObjectBudgets
Returns the budgets that are consumed within a project portfolio but managed by one of its descendant project portfolios, one entry per budget position and managing project portfolio. Sub object budgets are the half of the external budgets that stays inside this portfolio's own subtree, as opposed to the foreign budgets of fco.
HTTP syntax
GET /API/V3/FCO/PortfolioCosts/:projectPortfolioId/SubObjectBudgets?referencePortfolioId=...&start=...&end=...&targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.fco.getPortfolioSubObjectBudgets(projectPortfolioId, referencePortfolioId, start, end, targetCurrencyId) // returns ExternalBudget[]
// Overloads for optional parameters
Pqf.fco.getPortfolioSubObjectBudgets(projectPortfolioId, referencePortfolioId, start, end) // returns ExternalBudget[]
Pqf.fco.getPortfolioSubObjectBudgets(projectPortfolioId, referencePortfolioId, start) // returns ExternalBudget[]
Pqf.fco.getPortfolioSubObjectBudgets(projectPortfolioId, referencePortfolioId) // returns ExternalBudget[]
Pqf.fco.getPortfolioSubObjectBudgets(projectPortfolioId) // returns ExternalBudget[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type ProjectPortfolioBudget and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
referencePortfolioId |
UUID | The project portfolio from which the costs should be seen, which decides which budgets count as owned rather than as managed by a sub object; the portfolio itself if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ExternalBudget
GET /API/V3/FCO/PortfoliosCosts/:projectPortfolioIds/Overviews
Calculates costs overviews for a given set of project portfolios, optionally as seen from another, enclosing portfolio
HTTP syntax
GET /API/V3/FCO/PortfoliosCosts/:projectPortfolioIds/Overviews?referencePortfolioId=...&start=...&end=...&targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.fco.getPortfoliosCostsOverviews(projectPortfolioIds, referencePortfolioId, start, end, targetCurrencyId) // returns CostsOverview[]
// Overloads for optional parameters
Pqf.fco.getPortfoliosCostsOverviews(projectPortfolioIds, referencePortfolioId, start, end) // returns CostsOverview[]
Pqf.fco.getPortfoliosCostsOverviews(projectPortfolioIds, referencePortfolioId, start) // returns CostsOverview[]
Pqf.fco.getPortfoliosCostsOverviews(projectPortfolioIds, referencePortfolioId) // returns CostsOverview[]
Pqf.fco.getPortfoliosCostsOverviews(projectPortfolioIds) // returns CostsOverview[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type ProjectPortfolioBudget and ID in specified in parameter projectPortfolioIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioIds |
array of UUID | The project portfolios' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
referencePortfolioId |
UUID | The portfolio from which the costs should be seen (with respect to own / foreign budgets); the portfolio itself if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of CostsOverview
GET /API/V3/FCO/Project/:projectId/BudgetAssignments
Returns references to the budget assignments of a project: the shares of budget positions that have been assigned to it, each one with that project as its parent
HTTP syntax
GET /API/V3/FCO/Project/:projectId/BudgetAssignments?sort=...
<- application/json JavaScript syntax
Pqf.fco.getAllBudgetAssignmentsOfProject(projectId, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.fco.getAllBudgetAssignmentsOfProject(projectId) // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, holderId, budgetPositionId, sourcePortfolioId, amount | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
POST /API/V3/FCO/Project/:projectId/BudgetAssignments/Add
Assigns a project a share of a budget position one of the project portfolios it belongs to holds
HTTP syntax
POST /API/V3/FCO/Project/:projectId/BudgetAssignments/Add?sourcePortfolioId=...&budgetPositionId=...¤cyId=...&amount=...
<- application/json : PF.Reference JavaScript syntax
Pqf.fco.addProjectBudgetAssignment(projectId, sourcePortfolioId, budgetPositionId, currencyId, amount) // returns PF.Reference
// Overloads for optional parameters
Pqf.fco.addProjectBudgetAssignment(projectId, sourcePortfolioId, budgetPositionId, currencyId) // returns PF.Reference
Pqf.fco.addProjectBudgetAssignment(projectId, sourcePortfolioId, budgetPositionId) // returns PF.Reference Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
sourcePortfolioId |
UUID | The ID of the project portfolio that grants the budget, which must be one the project belongs to | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
budgetPositionId |
UUID | The ID of the budget position the assigned budget stems from, which must be one the granting project portfolio holds; the ID of a budget assignment is not accepted | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
currencyId |
UUID | The ID of the currency of the assigned amount, the user's currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
amount |
double | The amount of the budget position that is assigned to the project | 0 |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/FCO/Project/:projectId/BudgetLines
Returns the budget lines of a project: the shares of budget positions that have been assigned to it, each with the calculated amounts
HTTP syntax
GET /API/V3/FCO/Project/:projectId/BudgetLines
<- application/json JavaScript syntax
Pqf.fco.getProjectBudgetLines(projectId) // returns BudgetLine[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of BudgetLine
GET /API/V3/FCO/ProjectBudgetAssignment/:budgetAssignmentId
Returns a budget assignment of a project: a share of a budget position that has been assigned to it
HTTP syntax
GET /API/V3/FCO/ProjectBudgetAssignment/:budgetAssignmentId
<- application/json : BudgetAssignment JavaScript syntax
Pqf.fco.getProjectBudgetAssignment(budgetAssignmentId) // returns BudgetAssignment Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetAssignmentId |
UUID | The budget assignment's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: BudgetAssignment
PUT /API/V3/FCO/ProjectBudgetAssignment/:budgetAssignmentId
Updates a budget assignment of a project: only its amount can be changed
HTTP syntax
PUT /API/V3/FCO/ProjectBudgetAssignment/:budgetAssignmentId
-> application/json : BudgetAssignment JavaScript syntax
Pqf.fco.putProjectBudgetAssignment(budgetAssignmentId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetAssignmentId |
UUID | The budget assignment's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
BudgetAssignment | JSON object of type BudgetAssignment | ✔️ |
DELETE /API/V3/FCO/ProjectBudgetAssignment/:budgetAssignmentId
Deletes a budget assignment of a project, which withdraws the assigned share of the budget position
HTTP syntax
DELETE /API/V3/FCO/ProjectBudgetAssignment/:budgetAssignmentId JavaScript syntax
Pqf.fco.delProjectBudgetAssignment(budgetAssignmentId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetAssignmentId |
UUID | The budget assignment's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/FCO/ProjectBudgetAssignment/:budgetAssignmentId/Parents
Returns references to the parents of a budget assignment of a project: the project holding the assignment first, then the project portfolio granting the budget, then the budget position the assigned budget stems from. It needs no more than the permission to identify that project, where reading the assignment itself with fco.getProjectBudgetAssignment needs to read the project
HTTP syntax
GET /API/V3/FCO/ProjectBudgetAssignment/:budgetAssignmentId/Parents
<- application/json JavaScript syntax
Pqf.fco.getProjectBudgetAssignmentParents(budgetAssignmentId) // returns PF.Reference[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetAssignmentId |
UUID | The budget assignment's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/FCO/ProjectBudgetAssignments
Returns references to the budget assignments of all projects, each one with the project holding it as its parent. An assignment is listed if the caller may identify the holding project; reading it needs fco.getProjectBudgetAssignment and the permission to read that project
HTTP syntax
GET /API/V3/FCO/ProjectBudgetAssignments?sort=...
<- application/json JavaScript syntax
Pqf.fco.getAllProjectsBudgetAssignments(sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.fco.getAllProjectsBudgetAssignments() // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, holderId, budgetPositionId, sourcePortfolioId, amount | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
GET /API/V3/FCO/ProjectBudgetAssignments/:budgetAssignmentIds
Returns some budget assignments of projects, specified by their IDs
HTTP syntax
GET /API/V3/FCO/ProjectBudgetAssignments/:budgetAssignmentIds
<- application/json JavaScript syntax
Pqf.fco.getProjectBudgetAssignments(budgetAssignmentIds) // returns BudgetAssignment[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
budgetAssignmentIds |
array of UUID | The budget assignments' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of BudgetAssignment
GET /API/V3/FCO/ProjectCosts/:projectId/CostsActuals
Returns references to all costs actuals belonging to a specific project
HTTP syntax
GET /API/V3/FCO/ProjectCosts/:projectId/CostsActuals?sort=...
<- application/json JavaScript syntax
Pqf.fco.getCostsActualsOfProject(projectId, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.fco.getCostsActualsOfProject(projectId) // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, costsPositionId, timeOfPayment, sortIndex and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
GET /API/V3/FCO/ProjectCosts/:projectId/CostsPositions
Returns references to all costs positions belonging to a specific project
HTTP syntax
GET /API/V3/FCO/ProjectCosts/:projectId/CostsPositions?sort=...
<- application/json JavaScript syntax
Pqf.fco.getCostsPositionsOfProject(projectId, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.fco.getCostsPositionsOfProject(projectId) // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectId, costsTypeId, costsCenterId, payPlanId, sortIndex and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
POST /API/V3/FCO/ProjectCosts/:projectId/CostsPositions/Add
Adds a new costs position to a project
HTTP syntax
POST /API/V3/FCO/ProjectCosts/:projectId/CostsPositions/Add?name=...&code=...&description=...&color=...&iconRef=...¤cyId=...&amount=...&forecastScheme=...&sortIndex=...
<- application/json : PF.Reference JavaScript syntax
Pqf.fco.addCostsPosition(projectId, name, code, description, color, iconRef, currencyId, amount, forecastScheme, sortIndex) // returns PF.Reference
// Overloads for optional parameters
Pqf.fco.addCostsPosition(projectId, name, code, description, color, iconRef, currencyId, amount, forecastScheme) // returns PF.Reference
Pqf.fco.addCostsPosition(projectId, name, code, description, color, iconRef, currencyId, amount) // returns PF.Reference
Pqf.fco.addCostsPosition(projectId, name, code, description, color, iconRef, currencyId) // returns PF.Reference
Pqf.fco.addCostsPosition(projectId, name, code, description, color, iconRef) // returns PF.Reference
Pqf.fco.addCostsPosition(projectId, name, code, description, color) // returns PF.Reference
Pqf.fco.addCostsPosition(projectId, name, code, description) // returns PF.Reference
Pqf.fco.addCostsPosition(projectId, name, code) // returns PF.Reference
Pqf.fco.addCostsPosition(projectId, name) // returns PF.Reference
Pqf.fco.addCostsPosition(projectId) // returns PF.Reference Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission CREATE on object of type ProjectCostsPosition.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectId |
UUID | The project ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
name |
string | The name of the new costs position, a localized default name if omitted | |||
code |
string | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
||
description |
string | A descriptive text about the new costs position, may contain HTML | |||
color |
color | The color of the new costs position | |||
iconRef |
URI | The icon of the new costs position, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
||
currencyId |
UUID | The ID of the currency of the new costs position, the user's currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
amount |
double | The amount of the new costs position | 0 |
||
forecastScheme |
ForecastSchema | How the forecast should be calculated (takes values of type ForecastSchema) | |||
sortIndex |
double? | The sort index that determines the position of the inserted object, appended behind the existing ones if omitted |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/FCO/ProjectCosts/:projectId/CostsTimeline
Calculates a costs timeline for a project, broken down by calendar period and cascaded into groups by the requested dimensions
HTTP syntax
GET /API/V3/FCO/ProjectCosts/:projectId/CostsTimeline?start=...&end=...&zoom=...&grouping=...&targetCurrencyId=...&flowFilter=...&costsTypeFilter=...&costsTypeGroupFilter=...&costsContainerFilter=...&costsPositionFilter=...&managementPhaseFilter=...
<- application/json : CostsMatrix JavaScript syntax
Pqf.fco.getProjectCostsTimeline(projectId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter, costsContainerFilter, costsPositionFilter, managementPhaseFilter) // returns CostsMatrix
// Overloads for optional parameters
Pqf.fco.getProjectCostsTimeline(projectId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter, costsContainerFilter, costsPositionFilter) // returns CostsMatrix
Pqf.fco.getProjectCostsTimeline(projectId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter, costsContainerFilter) // returns CostsMatrix
Pqf.fco.getProjectCostsTimeline(projectId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter) // returns CostsMatrix
Pqf.fco.getProjectCostsTimeline(projectId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter) // returns CostsMatrix
Pqf.fco.getProjectCostsTimeline(projectId, start, end, zoom, grouping, targetCurrencyId, flowFilter) // returns CostsMatrix
Pqf.fco.getProjectCostsTimeline(projectId, start, end, zoom, grouping, targetCurrencyId) // returns CostsMatrix
Pqf.fco.getProjectCostsTimeline(projectId, start, end, zoom, grouping) // returns CostsMatrix
Pqf.fco.getProjectCostsTimeline(projectId, start, end, zoom) // returns CostsMatrix
Pqf.fco.getProjectCostsTimeline(projectId, start, end) // returns CostsMatrix
Pqf.fco.getProjectCostsTimeline(projectId, start) // returns CostsMatrix
Pqf.fco.getProjectCostsTimeline(projectId) // returns CostsMatrix Required license
This endpoint requires the following licenses:
- costtimeline
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
||
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
||
zoom |
array of PF.CalendarGranularity | The calendar granularities to break the timeline into, from coarsest to finest layer; no calendar layers if omitted | |||
grouping |
array of CostsDimension | The dimensions to cascade the grouping by, outermost first; grouped by container then flow if omitted | Container, Flow |
||
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
flowFilter |
array of CostsFlow | Filter by costs flow; all flows if omitted | |||
costsTypeFilter |
array of UUID | Filter by costs type; a null element matches costs without a costs type; all costs types if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
costsTypeGroupFilter |
array of UUID | Filter by costs type group; a null element matches costs without a costs type group; all costs type groups if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
costsContainerFilter |
array of UUID | Filter by costs container; a null element matches costs without a costs container; all costs containers if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
costsPositionFilter |
array of UUID | Filter by project costs position; a null element matches costs without a costs position; all costs positions if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
managementPhaseFilter |
array of UUID | Filter by project management phase; a null element matches costs without a management phase; all management phases if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsMatrix
GET /API/V3/FCO/ProjectCosts/:projectId/ExternalBudgets
Returns the budgets a project consumes that are granted by a project portfolio other than the reference portfolio, one entry per budget position and granting project portfolio. External budgets are the union of the foreign budgets and the sub object budgets: every budget the project holds from a portfolio other than the reference one, wherever that portfolio sits in the hierarchy. Read the two halves separately with fco.getProjectForeignBudgets, whose budgets are granted from outside the reference portfolio's subtree, and fco.
HTTP syntax
GET /API/V3/FCO/ProjectCosts/:projectId/ExternalBudgets?referencePortfolioId=...&start=...&end=...&targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.fco.getProjectExternalBudgets(projectId, referencePortfolioId, start, end, targetCurrencyId) // returns ExternalBudget[]
// Overloads for optional parameters
Pqf.fco.getProjectExternalBudgets(projectId, referencePortfolioId, start, end) // returns ExternalBudget[]
Pqf.fco.getProjectExternalBudgets(projectId, referencePortfolioId, start) // returns ExternalBudget[]
Pqf.fco.getProjectExternalBudgets(projectId, referencePortfolioId) // returns ExternalBudget[]
Pqf.fco.getProjectExternalBudgets(projectId) // returns ExternalBudget[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
referencePortfolioId |
UUID | The project portfolio from which the costs should be seen, which decides whether a granting portfolio counts as foreign or as a sub object; no budgets are returned if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ExternalBudget
GET /API/V3/FCO/ProjectCosts/:projectId/ForeignBudgets
Returns the budgets a project consumes that are granted by a project portfolio outside the reference portfolio's subtree, one entry per budget position and granting project portfolio. Foreign budgets are the half of the external budgets that comes from elsewhere in the hierarchy, as opposed to the sub object budgets of fco.
HTTP syntax
GET /API/V3/FCO/ProjectCosts/:projectId/ForeignBudgets?referencePortfolioId=...&start=...&end=...&targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.fco.getProjectForeignBudgets(projectId, referencePortfolioId, start, end, targetCurrencyId) // returns ExternalBudget[]
// Overloads for optional parameters
Pqf.fco.getProjectForeignBudgets(projectId, referencePortfolioId, start, end) // returns ExternalBudget[]
Pqf.fco.getProjectForeignBudgets(projectId, referencePortfolioId, start) // returns ExternalBudget[]
Pqf.fco.getProjectForeignBudgets(projectId, referencePortfolioId) // returns ExternalBudget[]
Pqf.fco.getProjectForeignBudgets(projectId) // returns ExternalBudget[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
referencePortfolioId |
UUID | The project portfolio from which the costs should be seen, which decides whether a granting portfolio counts as foreign or as a sub object; no budgets are returned if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ExternalBudget
GET /API/V3/FCO/ProjectCosts/:projectId/Overview
Calculates a costs overview for a project, optionally as seen from an enclosing project portfolio
HTTP syntax
GET /API/V3/FCO/ProjectCosts/:projectId/Overview?referencePortfolioId=...&start=...&end=...&targetCurrencyId=...
<- application/json : CostsOverview JavaScript syntax
Pqf.fco.getProjectCostsOverview(projectId, referencePortfolioId, start, end, targetCurrencyId) // returns CostsOverview
// Overloads for optional parameters
Pqf.fco.getProjectCostsOverview(projectId, referencePortfolioId, start, end) // returns CostsOverview
Pqf.fco.getProjectCostsOverview(projectId, referencePortfolioId, start) // returns CostsOverview
Pqf.fco.getProjectCostsOverview(projectId, referencePortfolioId) // returns CostsOverview
Pqf.fco.getProjectCostsOverview(projectId) // returns CostsOverview Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
referencePortfolioId |
UUID | The portfolio from which the costs should be seen (with respect to own / foreign budgets); no reference portfolio if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsOverview
GET /API/V3/FCO/ProjectCosts/:projectId/SubObjectBudgets
Returns the budgets a project consumes that are granted by a descendant of the reference project portfolio, one entry per budget position and granting project portfolio. Sub object budgets are the half of the external budgets that stays inside the reference portfolio's subtree, as opposed to the foreign budgets of fco.getProjectForeignBudgets, which are granted from outside it; fco.getProjectExternalBudgets returns both halves together. The amounts add up to the budgetsInSubObjs of the project's costs overview
HTTP syntax
GET /API/V3/FCO/ProjectCosts/:projectId/SubObjectBudgets?referencePortfolioId=...&start=...&end=...&targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.fco.getProjectSubObjectBudgets(projectId, referencePortfolioId, start, end, targetCurrencyId) // returns ExternalBudget[]
// Overloads for optional parameters
Pqf.fco.getProjectSubObjectBudgets(projectId, referencePortfolioId, start, end) // returns ExternalBudget[]
Pqf.fco.getProjectSubObjectBudgets(projectId, referencePortfolioId, start) // returns ExternalBudget[]
Pqf.fco.getProjectSubObjectBudgets(projectId, referencePortfolioId) // returns ExternalBudget[]
Pqf.fco.getProjectSubObjectBudgets(projectId) // returns ExternalBudget[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
referencePortfolioId |
UUID | The project portfolio from which the costs should be seen, which decides whether a granting portfolio counts as foreign or as a sub object; no budgets are returned if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ExternalBudget
GET /API/V3/FCO/ProjectPortfolio/:projectPortfolioId/BudgetAssignments
Returns references to the budget assignments of a project portfolio: the shares of budget positions that have been assigned to it, each one with that portfolio as its parent
HTTP syntax
GET /API/V3/FCO/ProjectPortfolio/:projectPortfolioId/BudgetAssignments?sort=...
<- application/json JavaScript syntax
Pqf.fco.getAllBudgetAssignmentsOfProjectPortfolio(projectPortfolioId, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.fco.getAllBudgetAssignmentsOfProjectPortfolio(projectPortfolioId) // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type ProjectPortfolioBudget and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, holderId, budgetPositionId, sourcePortfolioId, amount | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
POST /API/V3/FCO/ProjectPortfolio/:projectPortfolioId/BudgetAssignments/Add
Assigns a project portfolio a share of a budget position its parent portfolio holds
HTTP syntax
POST /API/V3/FCO/ProjectPortfolio/:projectPortfolioId/BudgetAssignments/Add?budgetPositionId=...¤cyId=...&amount=...
<- application/json : PF.Reference JavaScript syntax
Pqf.fco.addPortfolioBudgetAssignment(projectPortfolioId, budgetPositionId, currencyId, amount) // returns PF.Reference
// Overloads for optional parameters
Pqf.fco.addPortfolioBudgetAssignment(projectPortfolioId, budgetPositionId, currencyId) // returns PF.Reference
Pqf.fco.addPortfolioBudgetAssignment(projectPortfolioId, budgetPositionId) // returns PF.Reference Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type ProjectPortfolioBudget and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
budgetPositionId |
UUID | The ID of the budget position the assigned budget stems from, which must be one the parent project portfolio holds; the ID of a budget assignment is not accepted | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
currencyId |
UUID | The ID of the currency of the assigned amount, the user's currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
amount |
double | The amount of the budget position that is assigned to the project portfolio | 0 |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/FCO/ProjectPortfolio/:projectPortfolioId/BudgetLines
Returns the budget lines of a project portfolio: the budget positions it owns and the shares of budget positions that have been assigned to it, each with the calculated amounts
HTTP syntax
GET /API/V3/FCO/ProjectPortfolio/:projectPortfolioId/BudgetLines
<- application/json JavaScript syntax
Pqf.fco.getPortfolioBudgetLines(projectPortfolioId) // returns PortfolioBudgetLine[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type ProjectPortfolioBudget and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PortfolioBudgetLine
GET /API/V3/FCO/ProjectPortfolio/:projectPortfolioId/BudgetPositions
Returns references to all budget positions owned by a project portfolio, each one with that portfolio as its parent
HTTP syntax
GET /API/V3/FCO/ProjectPortfolio/:projectPortfolioId/BudgetPositions?sort=...
<- application/json JavaScript syntax
Pqf.fco.getAllBudgetPositionsOfProjectPortfolio(projectPortfolioId, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.fco.getAllBudgetPositionsOfProjectPortfolio(projectPortfolioId) // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type ProjectPortfolioBudget and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectPortfolioId, costsTypeId, budgetAmount, sortIndex and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
POST /API/V3/FCO/ProjectPortfolio/:projectPortfolioId/BudgetPositions/Add
Adds a budget position to the budget of a project portfolio
HTTP syntax
POST /API/V3/FCO/ProjectPortfolio/:projectPortfolioId/BudgetPositions/Add?name=...&code=...&description=...&color=...&iconRef=...&periodStart=...&periodEnd=...¤cyId=...&amount=...&sortIndex=...
<- application/json : PF.Reference JavaScript syntax
Pqf.fco.addBudgetPosition(projectPortfolioId, name, code, description, color, iconRef, periodStart, periodEnd, currencyId, amount, sortIndex) // returns PF.Reference
// Overloads for optional parameters
Pqf.fco.addBudgetPosition(projectPortfolioId, name, code, description, color, iconRef, periodStart, periodEnd, currencyId, amount) // returns PF.Reference
Pqf.fco.addBudgetPosition(projectPortfolioId, name, code, description, color, iconRef, periodStart, periodEnd, currencyId) // returns PF.Reference
Pqf.fco.addBudgetPosition(projectPortfolioId, name, code, description, color, iconRef, periodStart, periodEnd) // returns PF.Reference
Pqf.fco.addBudgetPosition(projectPortfolioId, name, code, description, color, iconRef, periodStart) // returns PF.Reference
Pqf.fco.addBudgetPosition(projectPortfolioId, name, code, description, color, iconRef) // returns PF.Reference
Pqf.fco.addBudgetPosition(projectPortfolioId, name, code, description, color) // returns PF.Reference
Pqf.fco.addBudgetPosition(projectPortfolioId, name, code, description) // returns PF.Reference
Pqf.fco.addBudgetPosition(projectPortfolioId, name, code) // returns PF.Reference
Pqf.fco.addBudgetPosition(projectPortfolioId, name) // returns PF.Reference
Pqf.fco.addBudgetPosition(projectPortfolioId) // returns PF.Reference Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission UPDATE on object of type ProjectPortfolioBudget and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
name |
string | The name of the new budget position, a localized default name if omitted | |||
code |
string | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
||
description |
string | A descriptive text about the new budget position, may contain HTML | |||
color |
color | The color of the new budget position | |||
iconRef |
URI | The icon of the new budget position, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
||
periodStart |
date | Start (inclusive) of the budget period; either none or both days of the period must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
||
periodEnd |
date | End (exclusive) of the budget period; either none or both days of the period must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
||
currencyId |
UUID | The ID of the currency of the new budget position, the user's currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
amount |
double | The amount of budget to spend | 0 |
||
sortIndex |
double? | The sort index that determines the position of the inserted object, appended behind the existing ones if omitted |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/FCO/ProjectPortfolios/:projectPortfolioIds/BudgetLines
Returns the budget lines of some project portfolios: the budget positions they own and the shares of budget positions that have been assigned to them, each with the calculated amounts. Every line names the portfolio holding it
HTTP syntax
GET /API/V3/FCO/ProjectPortfolios/:projectPortfolioIds/BudgetLines
<- application/json JavaScript syntax
Pqf.fco.getPortfoliosBudgetLines(projectPortfolioIds) // returns PortfolioBudgetLine[][] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type ProjectPortfolioBudget and ID in specified in parameter projectPortfolioIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioIds |
array of UUID | The project portfolios' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of array of PortfolioBudgetLine
GET /API/V3/FCO/Projects/:projectIds/BudgetLines
Returns the budget lines of some projects: the shares of budget positions that have been assigned to them, each with the calculated amounts. Every line names the project holding it
HTTP syntax
GET /API/V3/FCO/Projects/:projectIds/BudgetLines
<- application/json JavaScript syntax
Pqf.fco.getProjectsBudgetLines(projectIds) // returns BudgetLine[][] Required license
This endpoint requires the following licenses:
- portfoliobudget
Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of array of BudgetLine
GET /API/V3/FCO/ProjectsCosts/:projectIds/Overviews
Calculates costs overviews for a given set of projects, optionally as seen from an enclosing project portfolio
HTTP syntax
GET /API/V3/FCO/ProjectsCosts/:projectIds/Overviews?referencePortfolioId=...&start=...&end=...&targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.fco.getProjectsCostsOverviews(projectIds, referencePortfolioId, start, end, targetCurrencyId) // returns CostsOverview[]
// Overloads for optional parameters
Pqf.fco.getProjectsCostsOverviews(projectIds, referencePortfolioId, start, end) // returns CostsOverview[]
Pqf.fco.getProjectsCostsOverviews(projectIds, referencePortfolioId, start) // returns CostsOverview[]
Pqf.fco.getProjectsCostsOverviews(projectIds, referencePortfolioId) // returns CostsOverview[]
Pqf.fco.getProjectsCostsOverviews(projectIds) // returns CostsOverview[] Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
referencePortfolioId |
UUID | The portfolio from which the costs should be seen (with respect to own / foreign budgets); no reference portfolio if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of CostsOverview
GET /API/V3/FCO/ProjectWorkItemCosts/:projectWorkItemId/PlannedCosts
Returns the planned costs of a project work item: one forecast per costs type, together with their total and the effective forecast. Read them grouped by costs type group, and the work item's own and its accumulated costs in one call, with pm.
HTTP syntax
GET /API/V3/FCO/ProjectWorkItemCosts/:projectWorkItemId/PlannedCosts?recursive=...&targetCurrencyId=...
<- application/json : CostsForecasts JavaScript syntax
Pqf.fco.getProjectWorkItemPlannedCosts(projectWorkItemId, recursive, targetCurrencyId) // returns CostsForecasts
// Overloads for optional parameters
Pqf.fco.getProjectWorkItemPlannedCosts(projectWorkItemId, recursive) // returns CostsForecasts
Pqf.fco.getProjectWorkItemPlannedCosts(projectWorkItemId) // returns CostsForecasts Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
recursive |
boolean | Whether the costs of the work item's descendants are included as well | false |
||
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsForecasts
GET /API/V3/FCO/ResourceAllocationCosts/:resourceAllocationId/PlannedCosts
Returns the planned costs of a resource allocation: one forecast for the costs type of the allocated resource. An allocation that carries no costs is answered with a forecast whose amounts are all null
HTTP syntax
GET /API/V3/FCO/ResourceAllocationCosts/:resourceAllocationId/PlannedCosts?targetCurrencyId=...
<- application/json : CostsForecast JavaScript syntax
Pqf.fco.getResourceAllocationPlannedCosts(resourceAllocationId, targetCurrencyId) // returns CostsForecast
// Overloads for optional parameters
Pqf.fco.getResourceAllocationPlannedCosts(resourceAllocationId) // returns CostsForecast Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on parent with type ProjectWorkItemobject of type MacroAllocation and ID specified in parameter resourceAllocationId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceAllocationId |
UUID | The resource allocation's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsForecast
GET /API/V3/FCO/ScenarioCosts/:projectScenarioId/CostsTimeline
Calculates a costs timeline for a project scenario, broken down by calendar period and cascaded into groups by the requested dimensions
HTTP syntax
GET /API/V3/FCO/ScenarioCosts/:projectScenarioId/CostsTimeline?start=...&end=...&zoom=...&grouping=...&targetCurrencyId=...&flowFilter=...&costsTypeFilter=...&costsTypeGroupFilter=...&costsContainerFilter=...&costsPositionFilter=...&managementPhaseFilter=...
<- application/json : CostsMatrix JavaScript syntax
Pqf.fco.getProjectScenarioCostsTimeline(projectScenarioId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter, costsContainerFilter, costsPositionFilter, managementPhaseFilter) // returns CostsMatrix
// Overloads for optional parameters
Pqf.fco.getProjectScenarioCostsTimeline(projectScenarioId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter, costsContainerFilter, costsPositionFilter) // returns CostsMatrix
Pqf.fco.getProjectScenarioCostsTimeline(projectScenarioId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter, costsContainerFilter) // returns CostsMatrix
Pqf.fco.getProjectScenarioCostsTimeline(projectScenarioId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter, costsTypeGroupFilter) // returns CostsMatrix
Pqf.fco.getProjectScenarioCostsTimeline(projectScenarioId, start, end, zoom, grouping, targetCurrencyId, flowFilter, costsTypeFilter) // returns CostsMatrix
Pqf.fco.getProjectScenarioCostsTimeline(projectScenarioId, start, end, zoom, grouping, targetCurrencyId, flowFilter) // returns CostsMatrix
Pqf.fco.getProjectScenarioCostsTimeline(projectScenarioId, start, end, zoom, grouping, targetCurrencyId) // returns CostsMatrix
Pqf.fco.getProjectScenarioCostsTimeline(projectScenarioId, start, end, zoom, grouping) // returns CostsMatrix
Pqf.fco.getProjectScenarioCostsTimeline(projectScenarioId, start, end, zoom) // returns CostsMatrix
Pqf.fco.getProjectScenarioCostsTimeline(projectScenarioId, start, end) // returns CostsMatrix
Pqf.fco.getProjectScenarioCostsTimeline(projectScenarioId, start) // returns CostsMatrix
Pqf.fco.getProjectScenarioCostsTimeline(projectScenarioId) // returns CostsMatrix Required license
This endpoint requires the following licenses:
- costtimeline
Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
||
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
||
zoom |
array of PF.CalendarGranularity | The calendar granularities to break the timeline into, from coarsest to finest layer; no calendar layers if omitted | |||
grouping |
array of CostsDimension | The dimensions to cascade the grouping by, outermost first; grouped by container then flow if omitted | Container, Flow |
||
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
flowFilter |
array of CostsFlow | Filter by costs flow; all flows if omitted | |||
costsTypeFilter |
array of UUID | Filter by costs type; a null element matches costs without a costs type; all costs types if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
costsTypeGroupFilter |
array of UUID | Filter by costs type group; a null element matches costs without a costs type group; all costs type groups if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
costsContainerFilter |
array of UUID | Filter by costs container; a null element matches costs without a costs container; all costs containers if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
costsPositionFilter |
array of UUID | Filter by project costs position; a null element matches costs without a costs position; all costs positions if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
managementPhaseFilter |
array of UUID | Filter by project management phase; a null element matches costs without a management phase; all management phases if omitted | null;matches '[ (The array is optional. Each element, if not null, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsMatrix
GET /API/V3/FCO/ScenarioCosts/:projectScenarioId/Overview
Calculates a costs overview for a project scenario, optionally as seen from an enclosing project portfolio
HTTP syntax
GET /API/V3/FCO/ScenarioCosts/:projectScenarioId/Overview?referencePortfolioId=...&start=...&end=...&targetCurrencyId=...
<- application/json : CostsOverview JavaScript syntax
Pqf.fco.getProjectScenarioCostsOverview(projectScenarioId, referencePortfolioId, start, end, targetCurrencyId) // returns CostsOverview
// Overloads for optional parameters
Pqf.fco.getProjectScenarioCostsOverview(projectScenarioId, referencePortfolioId, start, end) // returns CostsOverview
Pqf.fco.getProjectScenarioCostsOverview(projectScenarioId, referencePortfolioId, start) // returns CostsOverview
Pqf.fco.getProjectScenarioCostsOverview(projectScenarioId, referencePortfolioId) // returns CostsOverview
Pqf.fco.getProjectScenarioCostsOverview(projectScenarioId) // returns CostsOverview Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
referencePortfolioId |
UUID | The portfolio from which the costs should be seen (with respect to own / foreign budgets); no reference portfolio if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
start |
date | The first day of the time period (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time period (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: CostsOverview
Data types
FCO.BudgetAssignment
This is a structure data contract.
A share of a budget position granted to a project portfolio or to a project
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
holder |
PF.Reference | A reference to the project portfolio or project holding the assignment; read-only, it is set when the assignment is added | non-null (The value is required.) |
|
budgetPosition |
PF.Reference | The root budget position the assigned budget stems from, never an assignment it was passed on through; read-only, it is set when the assignment is added | non-null (The value is required.) |
|
sourcePortfolioId |
UUID | The ID of the project portfolio that grants the budget, which for a portfolio holder is its parent portfolio and for a project holder one of the project portfolios the project belongs to (read-only) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
amount |
PF.CurrencyAmount | The amount of the budget position that is assigned to the holder |
FCO.BudgetCalculated
This is a structure data contract.
A calculated budget like a sum
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
budgetAmount |
PF.CurrencyAmount | The amount of budget to spend | ||
assignedAmount |
PF.CurrencyAmount | The amount of budget that has been assigned to sub objects | ||
bufferAmount |
PF.CurrencyAmount | The amount of budget that has not yet been assigned to sub objects |
FCO.BudgetLine
This is a structure data contract.
A line of a project portfolio's or project's budget: a budget position the holder owns, or a share of one assigned to it, together with the calculated amounts.
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
holder |
PF.Reference | A reference to the project portfolio or project the line belongs to | non-null (The value is required.) |
|
budgetPosition |
PF.Reference | The root budget position the line stems from, never an assignment it was passed on through | non-null (The value is required.) |
|
assignment |
PF.Reference | A reference to the budget assignment the holder was granted, null when the holder owns the budget position | ||
sourcePortfolioId |
UUID | The ID of the project portfolio that grants the budget, which is the holder itself when it owns the budget position | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
costsType |
PF.Reference | The costs type that is assigned to the budget position | ||
sortIndex |
double | A value indicating the custom sort order of the budget position (the lowest first) | ||
periodStart |
date | Start (inclusive) of the budget period | ||
periodEnd |
date | End (exclusive) of the budget period | ||
budgetAmount |
PF.CurrencyAmount | The amount of budget to spend, which is the amount assigned to the holder when it does not own the budget position | ||
assignedAmount |
PF.CurrencyAmount | The amount of budget that has been assigned to sub objects | ||
bufferAmount |
PF.CurrencyAmount | The amount of budget that has not yet been assigned to sub objects |
FCO.BudgetPosition
This is a structure data contract.
A budget position
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
properties |
array of PF.Property | ✔️ | A collection of dynamic properties belonging to the object | non-null;non-null (The array is required. Each element must not be null.) |
periodStart |
date | Start (inclusive) of the budget period | ||
periodEnd |
date | End (exclusive) of the budget period | ||
budgetAmount |
PF.CurrencyAmount | The amount of budget to spend | ||
costsType |
PF.Reference | The costs type that is assigned to this budget | ||
sortIndex |
double | A value indicating the custom sort order (the lowest first) | ||
projectPortfolioId |
UUID | A reference to the project portfolio that provides the budget | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
FCO.ConvertedCurrencyAmount
This is a structure data contract.
An amount of money that might have been converted into another currency
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
original |
PF.CurrencyAmount | exact amount as it was entered | ||
converted |
PF.CurrencyAmount | amount converted into destination currency |
FCO.CostsActual
This is a structure data contract.
A disbursement that was made
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
properties |
array of PF.Property | ✔️ | A collection of dynamic properties belonging to the object | non-null;non-null (The array is required. Each element must not be null.) |
costsPositionId |
UUID | The ID of the costs position the actual belongs to, read-only (use fco.moveCostsPositionActual to move it) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
timeOfPayment |
date | The day when payment was done or will be done | ||
amount |
PF.CurrencyAmount | The amount that was paid or will be paid, as it was entered | ||
sortIndex |
double | The index that can be used to define the order of the costs actual (the lowest first) |
FCO.CostsActualConverted
This is a structure data contract.
The amount of a costs actual converted into a requested currency at its day of payment
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
costsActualId |
UUID | The ID of the costs actual | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
amount |
ConvertedCurrencyAmount | The amount as it was entered and converted into the requested currency |
FCO.CostsDimension
This is an enumeration data contract.
Different dimensions of costs into which costs might be grouped
Enum values
| ID | Description |
|---|---|
Flow |
The costs flow (budget, planned, actual, forecast, ...) |
Type |
The costs type |
TypeGroup |
The costs type group |
Container |
The container which is often a management unit of the company |
Project |
The project which is responsible for the costs |
Position |
The costs position of a project |
MgmtPhase |
The project management phase according to the methodology |
FCO.CostsFlow
This is an enumeration data contract.
Different kinds of costs flow that make up a costs timeline
Enum values
| ID | Description |
|---|---|
Budget |
Budget costs |
Planned |
Planned costs |
Actual |
Actual costs |
ExpectedPending |
Costs that are expected to be pending |
ActualPlusExpectedPending |
Actual costs including those that are expected to be pending |
Remaining |
The remaining costs of a project |
Forecast |
The costs forecast |
FCO.CostsForecast
This is a structure data contract.
A costs forecast for a given type of costs
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
planned |
PF.CurrencyAmount | ✔️ | The planned amount | |
actual |
PF.CurrencyAmount | ✔️ | The actual amount | |
expectedPending |
PF.CurrencyAmount | ✔️ | The expected pending amount | |
remaining |
PF.CurrencyAmount | ✔️ | The remaining amount | |
type |
PF.NamedReference | The costs type that applies to the forecast |
FCO.CostsForecastCalculated
This is a structure data contract.
A calculated costs forecast like a sum
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
planned |
PF.CurrencyAmount | The planned amount | ||
actual |
PF.CurrencyAmount | The actual amount | ||
expectedPending |
PF.CurrencyAmount | The expected pending amount | ||
remaining |
PF.CurrencyAmount | The remaining amount |
FCO.CostsForecastGroup
This is a structure data contract.
A costs forecast for a given type of costs
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
forecasts |
array of CostsForecast | ✔️ | The individual forecasts | |
forecastTotal |
CostsForecastCalculated | ✔️ | The total of all forecasts | |
forecast |
PF.CurrencyAmount | ✔️ | The effective forecast as single currency amount (actual + remaining) | |
typeGroup |
PF.NamedReference | The costs type group that applies to the forecast |
FCO.CostsForecasts
This is a structure data contract.
Summed costs forecasts
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
forecasts |
array of CostsForecast | The individual forecasts | ||
forecastTotal |
CostsForecastCalculated | The total of all forecasts | ||
forecast |
PF.CurrencyAmount | The effective forecast as single currency amount (actual + remaining) |
FCO.CostsForecastsGroups
This is a structure data contract.
Summed costs forecasts by costs type group
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
forecasts |
array of CostsForecastGroup | The forecasts of each costs type group, a group for costs types without a group having no type group | ||
forecastTotal |
CostsForecastCalculated | The total of all forecasts | ||
forecast |
PF.CurrencyAmount | The effective forecast as single currency amount |
FCO.CostsMatrix
This is a structure data contract.
A costs matrix with cascaded grouping of a costs timeline and a hierarchic calendar
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
layers |
array of CostsMatrixLayer | ✔️ | The timeline layers, one per calendar layer | |
groups |
array of CostsMatrixGroup | ✔️ | The subgroups of this group, cascaded by the next grouping dimension | |
total |
PF.CurrencyAmount | ✔️ | The total over the whole timeline | |
calendar |
PF.Calendar | The hierarchic calendar defining the periods of the timeline | ||
hierarchy |
array of CostsMatrixHierarchy | The grouping hierarchy, one entry per requested dimension |
FCO.CostsMatrixGroup
This is a structure data contract.
A group within the costs matrix with a timeline according to the matrix's calendar, and its total
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
layers |
array of CostsMatrixLayer | The timeline layers, one per calendar layer | ||
groups |
array of CostsMatrixGroup | The subgroups of this group, cascaded by the next grouping dimension | ||
total |
PF.CurrencyAmount | The total over the whole timeline |
FCO.CostsMatrixHierarchy
This is a structure data contract.
One level of the matrix's grouping hierarchy
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
dimension |
CostsDimension | The dimension that this hierarchy level groups by | ||
items |
array of PF.Identification | The distinct items that the costs are grouped into at this level, in the same order as the corresponding groups |
FCO.CostsMatrixLayer
This is a structure data contract.
A costs timeline corresponding to one calendar layer, with the range split into two parts by today
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
rangeToToday |
PF.CurrencyAmount | The amount from the start of the range until today | ||
rangeFromToday |
PF.CurrencyAmount | The amount from today until the end of the range | ||
ranges |
array of PF.CurrencyAmount | The amount for each individual range within the calendar layer |
FCO.CostsOverview
This is a structure data contract.
A costs overview providing the status of budget vs. forecast at a glance
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
reference |
PF.Reference | The reference to the object (for bulk requests) | ||
budgets |
array of BudgetLine | All budget lines providing budget to that object (some may be inherited from another object) | ||
budgetsInForeignObjs |
BudgetCalculated | Sum of all Budgets that are used in sub objects, but are managed in foreign objects (not in children) | ||
budgetsInSubObjs |
BudgetCalculated | Sum of all Budgets that are used in sub objects, but are managed in objects being a child of the current object | ||
managedBudgetTotal |
BudgetCalculated | Sum of all budgets being managed by this object | ||
budgetsInExternalObjsTotal |
BudgetCalculated | Sum of all Budgets that are used in sub objects, but are managed by another object (budgetsInForeignObjs + budgetsInSubObjs) | ||
managedBudgetWithSubObjsTotal |
BudgetCalculated | Sum of all budgets being managed by this object or any child | ||
budgetTotal |
BudgetCalculated | Sum of all budgets | ||
forecasts |
array of CostsForecastGroup | Costs forecasts by costs type | ||
forecastTotal |
CostsForecastCalculated | The sum of all forecasts | ||
forecast |
PF.CurrencyAmount | The foreseen total amount of costs of all sub objects | ||
plannedDiffBudget |
PF.CurrencyAmount | Planned costs versus budget | ||
plannedDiffAssignedBudget |
PF.CurrencyAmount | Planned costs versus assigned budget | ||
actualDiffPlanned |
PF.CurrencyAmount | Actual costs versus planned | ||
forecastDiffPlanned |
PF.CurrencyAmount | Foreseen costs versus planned costs | ||
forecastDiffBudget |
PF.CurrencyAmount | Foreseen costs versus budget | ||
forecastDiffAssignedBudget |
PF.CurrencyAmount | Foreseen costs versus assigned budget |
FCO.CostsPosition
This is a structure data contract.
A costs position of a project or similar object
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
properties |
array of PF.Property | ✔️ | A collection of dynamic properties belonging to the object | non-null;non-null (The array is required. Each element must not be null.) |
costsTypeId |
UUID | The ID of the type of costs that this position belongs to | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
costsCenterId |
UUID | The ID of the costs center which is responsible for payment and budget | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
payPlanId |
UUID | The ID of the pay plan that defines how payment has to be done (in advance, continuous, ...) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
plannedAmount |
PF.CurrencyAmount | The amount that is planned to spend | ||
supplementaryAmount |
PF.CurrencyAmount | Additional amount that has not initially been planned but is now planned | ||
remainingAmount |
PF.CurrencyAmount | The amount that still needs to be paid | ||
obligo |
boolean | true, if this is an obligo costs position (meaning fixed by contract) | ||
sortIndex |
double | The index that can be used to define the order of the costs positions (the lowest first) | ||
forecastScheme |
ForecastSchema | Defines whether remaining or supplementary was provided. Forecast = actual + remaining or forecast = planned + supplementary |
FCO.CostsPositionConverted
This is a structure data contract.
The money values of a costs position converted into a requested currency, including the calculated amounts
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
costsPositionId |
UUID | The ID of the costs position | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
plannedAmount |
ConvertedCurrencyAmount | The amount that is planned to spend | ||
supplementaryAmount |
ConvertedCurrencyAmount | Additional amount that has not initially been planned but is now planned | ||
remainingAmount |
ConvertedCurrencyAmount | The amount that still needs to be paid | ||
provisionalAmount |
PF.CurrencyAmount | The amount that must, but still needs to be paid | ||
actualAmount |
PF.CurrencyAmount | The amount that has been paid (calculated, read-only) | ||
availableAmount |
PF.CurrencyAmount | The amount that is available (initial plan - actual) |
FCO.CostsType
This is a structure data contract.
Type of costs (personnel costs, material costs, ...)
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
groupId |
UUID | The group this costs type belongs to | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
payPlanId |
UUID | This defines how payment has to be done (in advance, continuous, ...) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
sortIndex |
double | The index that defines default sorting of objects, lowest first |
FCO.CostsTypeGroup
This is a structure data contract.
Group for types of costs (personnel costs, material costs, ...)
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
sortIndex |
double | The index that defines default sorting of objects, lowest first |
FCO.CostsTypeGroupTranslated
This is a structure data contract.
Group for types of costs (personnel costs, material costs, ...)
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
sortIndex |
double | The index that defines default sorting of objects, lowest first |
FCO.CostsTypeTranslated
This is a structure data contract.
Type of costs (personnel costs, material costs, ...)
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
groupId |
UUID | The group this costs type belongs to | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
payPlanId |
UUID | This defines how payment has to be done (in advance, continuous, ...) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
sortIndex |
double | The index that defines default sorting of objects, lowest first |
FCO.Currency
This is a structure data contract.
Information about a currency
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
sortIndex |
double | An index value that indicates the correct order (higher after lower) |
FCO.CurrencyExchangeRate
This is a structure data contract.
Defines the exchange rate between a currency and a (virtual) currency starting from a given date
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
validityStart |
date | The first date this rate applies | ||
rate |
double | The rate that applies starting from the given date |
FCO.CurrencyExchangeRates
This is a structure data contract.
Defines the exchange rate between a currency and a (virtual) currency over time
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
rates |
array of CurrencyExchangeRate | The different rates, ordered by starting date |
FCO.CurrencyTranslated
This is a structure data contract.
Information about a currency with translations
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
sortIndex |
double | An index value that indicates the correct order (higher after lower) |
FCO.ExternalBudget
This is a structure data contract.
A budget used in sub objects but managed in another project portfolio
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
budgetPosition |
PF.NamedReference | The root budget position the budget stems from, null if the user is not permitted to read it | ||
projectPortfolio |
PF.NamedReference | The project portfolio the budget lies in, null if the user is not permitted to identify it | ||
amount |
PF.CurrencyAmount | The amount of budget that was granted |
FCO.ForecastSchema
This is an enumeration data contract.
Defines whether remaining or supplementary was provided
Enum values
| ID | Description |
|---|---|
ActualPlusRemaining |
Forecast = actual + remaining |
PlannedPlusSupplementary |
Forecast = planned + supplementary |
FCO.PortfolioBudgetLine
This is a structure data contract.
A budget line of a project portfolio, with the assigned amount split by the kind of sub object
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
holder |
PF.Reference | ✔️ | A reference to the project portfolio or project the line belongs to | non-null (The value is required.) |
budgetPosition |
PF.Reference | ✔️ | The root budget position the line stems from, never an assignment it was passed on through | non-null (The value is required.) |
assignment |
PF.Reference | ✔️ | A reference to the budget assignment the holder was granted, null when the holder owns the budget position | |
sourcePortfolioId |
UUID | ✔️ | The ID of the project portfolio that grants the budget, which is the holder itself when it owns the budget position | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
costsType |
PF.Reference | ✔️ | The costs type that is assigned to the budget position | |
sortIndex |
double | ✔️ | A value indicating the custom sort order of the budget position (the lowest first) | |
periodStart |
date | ✔️ | Start (inclusive) of the budget period | |
periodEnd |
date | ✔️ | End (exclusive) of the budget period | |
budgetAmount |
PF.CurrencyAmount | ✔️ | The amount of budget to spend, which is the amount assigned to the holder when it does not own the budget position | |
assignedAmount |
PF.CurrencyAmount | ✔️ | The amount of budget that has been assigned to sub objects | |
bufferAmount |
PF.CurrencyAmount | ✔️ | The amount of budget that has not yet been assigned to sub objects | |
assignedAmountOnPortfolios |
PF.CurrencyAmount | The share of the assigned amount that has been assigned to sub portfolios | ||
assignedAmountOnProjects |
PF.CurrencyAmount | The share of the assigned amount that has been assigned to projects |
FCO.ProjectCostsPosition
This is a structure data contract.
A costs position of a project
Based on
- PF.Reference
- PF.VersionReference
- PF.VersionedReference
- PF.BasicObject
- PF.CustomizedObject
- CostsPosition
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
properties |
array of PF.Property | ✔️ | A collection of dynamic properties belonging to the object | non-null;non-null (The array is required. Each element must not be null.) |
costsTypeId |
UUID | ✔️ | The ID of the type of costs that this position belongs to | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
costsCenterId |
UUID | ✔️ | The ID of the costs center which is responsible for payment and budget | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
payPlanId |
UUID | ✔️ | The ID of the pay plan that defines how payment has to be done (in advance, continuous, ...) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
plannedAmount |
PF.CurrencyAmount | ✔️ | The amount that is planned to spend | |
supplementaryAmount |
PF.CurrencyAmount | ✔️ | Additional amount that has not initially been planned but is now planned | |
remainingAmount |
PF.CurrencyAmount | ✔️ | The amount that still needs to be paid | |
obligo |
boolean | ✔️ | true, if this is an obligo costs position (meaning fixed by contract) | |
sortIndex |
double | ✔️ | The index that can be used to define the order of the costs positions (the lowest first) | |
forecastScheme |
ForecastSchema | ✔️ | Defines whether remaining or supplementary was provided. Forecast = actual + remaining or forecast = planned + supplementary | |
projectId |
UUID | The project ID this costs position belongs to | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
assignedWorkItems |
array of PF.Identification | The work items that refer to this costs position, read-only |