Creates or updates multiple benefit items in a single request. Each item is identified by its internal ID or external ID. If neither is provided a new benefit item is created. Returns validation errors for any items that failed processing.
funds-write-scopearray<BenefitItemRequest>
RequiredAll benefit 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
curl --request POST \
--url '/focus/v1/funds/benefit-item/bulk' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"items": [
{
"focusAreaId": "<string>",
"focusAreaExternalId": "<string>",
"benefitItemId": "<string>",
"benefitItemExternalId": "<string>",
"benefitTypeKey": "<string>",
"name": "<string>",
"benefitPeriodValues": [
{
"financialVersionType": "ACTUAL",
"timePeriodToAmount": {
"empty": true
}
}
]
}
]
}'Returns benefit item details by benefit item ID.
funds-read-scopestring
RequiredBenefit item returned successfully.
A benefit item.
1
2
3
4
curl --request GET \
--url '/focus/v1/funds/benefit-item/{id}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
{
"benefitItemId": "<string>",
"externalBenefitItemId": "<string>",
"focusAreaId": "<string>",
"name": "<string>"
}Deletes the specified benefit item. This action is irreversible.
funds-write-scopestring
RequiredBenefit item deleted successfully.
1
2
3
curl --request DELETE \
--url '/focus/v1/funds/benefit-item/{id}' \
--header 'Authorization: Bearer <access_token>'Updates the details of the specified benefit item. The updateMask query parameter specifies which fields to update; supported fields are externalId. 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
Requiredstring
Benefit item updated successfully.
A benefit item.
1
2
3
4
5
6
7
8
curl --request PATCH \
--url '/focus/v1/funds/benefit-item/{id}?updateMask={updateMask}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"externalId": "<string>"
}'1
2
3
4
5
6
{
"benefitItemId": "<string>",
"externalBenefitItemId": "<string>",
"focusAreaId": "<string>",
"name": "<string>"
}Returns a paginated list of benefit items with optional filtering.
funds-read-scopestring
Benefit items returned successfully.
Paginated REST response.
1
2
3
4
curl --request GET \
--url '/focus/v1/funds/benefit-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: