Core API Documentation Help

Create Benefit Year

View request in Postman

/benefits/{tenantId}/years

Creates a new benefit year.

Request parameters

{ "year": 2026 }

Responses

{ "id": "019f156c-44a6-724d-99c3-38d2aff62ac5", "status": "INVISIBLE", "tenantId": "637a2315-8bfc-49ce-bb0d-691faabbbc76", "year": 2026, "isReady": false, "contentZoneId": "019f2238-4473-7172-9d90-1bf283b2c7bc", "createdAt": "2026-07-08T11:31:17+00:00", "updatedAt": null }
{ "error": "Request body is empty or contains malformed JSON." }
{ "errors": { "year": [ "Only the current or next calendar year is permitted." ] } }
01 September 2026