--- title: "Details of an employment fund" method: GET path: "/v2/providers/employers/employees/employments/employmentfunds/{employmentFundId}" tags: ["Employment funds"] --- # Details of an employment fund `GET /v2/providers/employers/employees/employments/employmentfunds/{employmentFundId}` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/employees/employments/employmentfunds/{employmentFundId}` - Auth: none required __Activity name :__ GetEmploymentFundByEmploymentFundId Get the details of an employment fund ## Path parameters - `employmentFundId` string, uuid, required ## Query parameters - `filter` string - `orderBy` string - `pageNumber` integer - `pageSize` integer ## Headers - `Authorization` string, required - `Accept` string, required ## Response `200` OK - object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour. - `totalSize` integer: Total number of records, taking into account the given filter. - `pageSize` integer: Number of records in the response - `totalPages` integer: Number of pages available - `currentPage` integer: Current page returned in the response - `version` Version - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available - `resourceVersion` string, date: The resource version of the object in the response - `messages` object[] - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages) - `description` string: Describes the message - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity - `code` integer: Identifying code for the message - `properties` string[]: An array that can contain additional information - `_embedded` Fundtotal20230526[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The date on which this fund starts. A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `fund` Fund - `key` integer: The key for the fund - `description` string: The description of the fund - `deviations` Deviations, nullable: Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`. Deviating is done on either all the fields or none. __Note:__ `deviations` and `fixedContribution` are mutually exclusive. - `employmentContributionPercentage` number, double: Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution. __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4). - `totalContributionPercentage` number, double: Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer. __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4). - `fixedContribution` FixedContribution, nullable: With the underlying elements fixed values (money) can be set as the result of the Fund calculation. In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated. In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution. In those cases do not use this option as the calculation is disabled. Setting a fixed contribution is done on either all the fields or none. __Note:__ `deviations` and `fixedContribution` are mutually exclusive. - `employmentContribution` number, double: The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates. __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99 - `totalContribution` number, double: The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates. __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99 - `vitalityScheme` VitalityScheme, nullable - `key` integer: The key for the vitality scheme - `value` string: The description of the Vitaliteitsregeling ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)