v1.2.5

API v1.2.5 New features

Every compensation version now returns lines - the regular amounts of the package: base salary, allowances, deductions, and employer contributions.
Each line carries compensation_type (id, title, is_archived), amount_gross, amount_net, currency, per_type, description, kind, is_included_in_gross, is_payable_to_employee, is_included_in_total_cost, rate_type, and percent. Amounts are strings.
compensation_type.id is the same component id as in compensation_type.id of additional compensations.
Use lines together with date_effective_from / date_effective_to of the version to get the period of a regular allowance.
lines is null without the employee_compensation_lines field permission. Off-payroll payments are not returned.
The field is additive: the existing fields of the response are unchanged.

GET /api/v1/employees/{employee_id}/additional-compensations returns one-time payments only: bonuses, premiums, expense reimbursements. A payment has date_effective_from and no end date.
Recurring additional compensations were moved into the compensation package and are returned as lines of POST /api/v1/employees/{employee_id}/compensations/search.
type, frequency_type, and date_effective_to in the create and update body are ignored.

GET /api/v1/calendar-holidays - holiday calendars of the company: id, title, country.
POST /api/v1/calendar-holidays/dates/search - dates of the calendars between date_from and date_to (at most 366 days), each with type: non_working, working or compensated.
POST /api/v1/calendar-holidays/employees/search - the current calendar of each employee, resolved from the location, department and division of the current position.
Requires permission manage_holidays=edit. See Public holidays.

GET /api/v1/custom-fields/fields - employee custom fields the token owner can view, with slug, types, flags and options. See Custom fields.

A historical table (is_historical: true) now returns only the current row of each employee by default.
Pass with_history: true to get every row, as before. Tables that are not historical are unaffected.
For employees whose table history the token is not allowed to view, only the current row is returned even with with_history: true.
Integrations that export a historical table for a period must add with_history: true to the request.