Creates or updates multiple cost items in a single request. Each item is identified by its internal ID or external ID. If neither is provided a new cost item is created. Returns validation errors for any items that failed processing.
funds-write-scopearray<CostItemRequest>
RequiredAll cost items imported successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
curl --request POST \
--url '/focus/v1/funds/cost-item/bulk' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"items": [
{
"focusAreaId": "<string>",
"focusAreaExternalId": "<string>",
"costItemId": "<string>",
"costItemExternalId": "<string>",
"name": "<string>",
"costType": "<string>",
"costSubtypeKey": "<string>",
"expenditureType": {
"id": "<string>",
"order": 2154,
"key": "<string>",
"name": "<string>",
"displayName": "<string>"
},
"investmentCategoryKey": "<string>",
"costPeriodValues": [
{
"financialVersionType": "ACTUAL",
"timePeriodToAmount": {
"empty": true
}
}
]
}
]
}'Returns cost item details by cost item ID.
funds-read-scopestring
RequiredCost item returned successfully.
A cost item.
1
2
3
4
curl --request GET \
--url '/focus/v1/funds/cost-item/{id}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"costItemId": "<string>",
"externalCostItemId": "<string>",
"focusAreaId": "<string>",
"costType": "<string>",
"costSubtypeId": "<string>",
"expenditureType": "<string>",
"investmentCategoryId": "<string>",
"name": "<string>"
}Deletes the specified cost item. This action is irreversible.
funds-write-scopestring
RequiredCost item deleted successfully.
1
2
3
curl --request DELETE \
--url '/focus/v1/funds/cost-item/{id}' \
--header 'Authorization: Bearer <access_token>'Updates the details of the specified cost item. The updateMask query parameter specifies which fields to update; supported fields are externalCostItemId. Fields not listed in updateMask are not modified. Fields listed in updateMask but omitted from the request body or set to null are cleared.
funds-write-scopestring
Requiredstring
RequiredUpdateCostItemRequest
Cost item updated successfully.
A cost item.
1
2
3
4
5
6
curl --request PATCH \
--url '/focus/v1/funds/cost-item/{id}?updateMask={updateMask}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'1
2
3
4
5
6
7
8
9
10
{
"costItemId": "<string>",
"externalCostItemId": "<string>",
"focusAreaId": "<string>",
"costType": "<string>",
"costSubtypeId": "<string>",
"expenditureType": "<string>",
"investmentCategoryId": "<string>",
"name": "<string>"
}Returns a paginated list of cost items with optional filtering.
funds-read-scopestring
Cost items returned successfully.
Paginated REST response.
1
2
3
4
curl --request GET \
--url '/focus/v1/funds/cost-item' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
{
"values": [
{}
],
"cursor": "<string>",
"last": true,
"totalCount": 21,
"nextPageCursor": "<string>"
}Rate this page: