--- title: "The leave balanceworth for all employments" method: GET path: "/v2/providers/employers/{employerId}/leavebalances/worth" tags: ["Leave balance"] --- # The leave balanceworth for all employments `GET /v2/providers/employers/{employerId}/leavebalances/worth` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/{employerId}/leavebalances/worth` - Auth: none required __Activity name :__ GetLeaveBalanceWorthByEmployerId

Returns the yearly leave balances and their worth for all employments ## Path parameters - `employerId` string, uuid, required ## Query parameters - `referenceDate` string, date - `leaveType` integer[] - `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` LeaveBalanceEmployerWithWorth[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The date on which this employment starts. NL: DatumInDienst - `historicalStartDate` string, date, nullable: The historical date on which the employee was first employed. This field is used when an employee has multiple employments in time. In most cases this field should be used as the date on which the employee started working for the company. NL: HistorischeDatumInDienst - `endDate` string, date, nullable: The date on which the employment ends. NL: DatumUitDienst - `payrollAdministration` PayrollAdministration20191216, nullable: Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time) `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the payroll administration - `clientNumber` integer: The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling. - `description` string: Description of the administration - `nonPayrollAdministration` NonPayrollAdministration20191216, nullable: Id of the non-payroll administration. This field cannot simultaneously have a value with payrollAdministration (only one can have a value at a time) `nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the non payroll administration - `description` string: Description of the administration - `incomeRelationshipNumber` integer: The income relationship number that is required in the tax return. Together with the citizen service number (burgerservicenummer, BSN) and wage tax number, the income relationship number uniquely identifies an employment. NL: NummerInkomstenVerhouding - `employee` EmployeeBasic - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `employeeNumber` integer: The employee number to uniquely identify a employee within a employer. - `firstName` string, nullable: The first name of the employee - `initials` string: The initials of the employee - `prefix` string, nullable: The prefix of the employee - `lastName` string: The last name of the employee - `prefixPartner` string, nullable: The prefix of the partner of the employee - `lastNamePartner` string, nullable: The last name of the partner of the employee - `formattedName` string: Formatted name of the employee based on the value of `howToFormatLastName` - `dateOfBirth` string, date: The date of birth - `photo` string, url, nullable: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output. - `organizationalEntity` object - `startDate` string, date: The start date of the entity. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `department` Department: The department of the employment. `department` is a metadata field within the employer context. Possible values can be managed by the user. - `key` string, uuid: The unique identifier of an object (GUID/UUID) - `code` integer - `description` string - `function` Function2: The function of the employment. `function` is a metadata field within the employer context. Possible values can be managed by the user. - `key` string, uuid: The unique identifier of an object (GUID/UUID) - `description` string - `group` string, nullable - `standardFunction` StandardFunction, nullable: The standard (cao)function of the employment. `standardFunction` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `value` string - `code` string, nullable - `category` integer, nullable - `deviatingFunctionGroup` string, nullable: The deviating function group description of the employment. Only applies when a deviating function description is defined. - `deviatingFunctionDescription` string, nullable: The deviating function description of the employment. This description deviates from the value of the `function` field. - `placeOfEmployment` string, nullable: The standard working location (standplaats) for the employment. - `leaveBalance` object[] - `year` integer: The year to which the balance of the leave type applies. - `leaveType` LeaveType3: The type of leave requested by the employee `leaveType` is a metadata field within the employer context. Possible values can be managed by the user. - `key` integer: The key for the leave type. - `value` string: The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type. - `balanceExceedsYear` boolean: Indicates whether the balance at the end of the year for this leave type carries over to the next year. - `balancePreviousYear` number, double: The remaining leave balance from the previous year for the leave type - `accrual` number, double: The amount of leave units accrued for the leave type in the year - `usageTotal` number, double: The total amount of leave units used for the leave type in the year. - `usageThroughReferenceDate` number, double: The amount of leave units used for the leave type starting from the beginning of the year up to and `referenceDate` - `usageAfterReferenceDate` number, double: The amount of leave units used for the leave type in the year after `referenceDate` - `usageFirstHalfYear` number, double: The amount of leave units used for the leave type in the first half of the year - `balance` number, double: The remaining leave balance for the year and leave type. The balance takes into account the leave usage in the future. - `expires` number, double: - `worth` number, double: The worth of the leave balance in euros ## 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)