REST DocumentationChangelog

Changelog

The REST API specification is generated from the source code and published with every ZEP release. Since the switch to the generated specification the version number describes the API contract (1.x.y), not the product release: a breaking change bumps the major version and lands in a new /api/v2, additive changes keep v1. Releases after the switch are written by the release pipeline from the diff of the specification and only appear when the API changed; the switch release and everything before it were written by hand.

v8.0.169 · OpenAPI 1.6.0 → 1.7.0 · 16.11.2026

Absence cursor: id_after on GET /absences

Together with modified_after, id_after also returns the absences modified exactly at modified_after whose id is greater, so a client can page through absences that share one timestamp, as on GET /attendances. Without id_after nothing changes: modified_after stays strict. On its own id_after has no effect; a non-integer answers 422.

All single changes (1)
  • NEW GET /absences: added the new optional query request parameter id_after

v8.0.158 · OpenAPI 1.5.0 → 1.6.0 · 12.11.2026

No more 500 on an invalid project date, a null department or a customer price table: POST, PUT/PATCH /projects/{project}, POST, PUT/PATCH /employees/{employee}, GET /customers/{customer}/price-tables/{price_table}

An invalid start_date or end_date (2026-13-45, an array) on a project answered 500; it now answers 422 with a validation error on the field. Only YYYY-MM-DD and the ISO 8601 timestamp the API itself returns (2026-03-15T00:00:00.000000Z) are accepted, stored as a day: a date that does not exist (2026-02-30), a number or a phrase (next monday) is rejected, and a missing start_date on POST is rejected instead of defaulting to today. On update, start_date and end_date are checked against the stored other date when the request carries none. A travel_flat_rate sent on a project is now stored; when it is missing, the stored value is kept. department_id: null on an employee answered 500; an update now keeps the employee’s department, as if the field were left out, and a create assigns the default department. An array as department_id answered 500 as well; it now answers 422. GET /customers/{customer}/price-tables/{price_table} answered 500 for every price table; it now returns the price table, or 404 when it belongs to another customer. No contract change.

All single changes (1)
  • INFO PATCH /employees/{username}, PUT /employees/{username}: the price_group request property’s maxLength was set to 32

v8.0.147 · OpenAPI 1.4.0 → 1.5.0 · 11.11.2026

Error answers: one shape with code, message and status

Every error answer of the customer API (400, 401, 403, 404, 405, 409, 422, 429, 500, 502) now carries code (a fixed string: bad_request, unauthenticated, forbidden, not_found, method_not_allowed, conflict, validation_failed, rate_limited, server_error, bad_gateway), message and status (the HTTP status). A 422 keeps errors per field. The 401 of a request without a token and the 404 of an unknown path now use it as well. The ticket and receipt endpoints no longer answer success: false on a 500; read code instead. POST /absences answers a validation failure with validation_failed (a rejection by ZEP: see the next entry).

Business rule rejections: business_rule_violation, and zep_code on POST /absences

A request the API refuses because of data already stored (an absence on a non-workday, a project, task, contact or employee that is still in use, a booking for an employee not assigned to the task, a closed month) now answers 422 with code business_rule_violation; a missing or malformed field keeps validation_failed, and a format error next to a rule violation answers validation_failed. errors stay as they were. On POST /absences the ZEP rejection (ZEP code 104) moves its number from code to zep_code (an integer) and code is now business_rule_violation; announced to Inovex on 2026-10-30, check your status handling.

Invoices: customer_address_id, contact_id, billing_address and debtor: GET /invoices, GET /invoices/{invoice}

Every invoice names the customer address and the contact it was written to (null when none is stored), the address in its current state as billing_address, and the debtor zepmaster stored with it under the Inovex licence module (null without one). address still returns the text as printed. GET /customers and GET /customers/{customer} add debtor_number, and every address (addresses, billing_address) adds debtor and name_additional.

Invoices: net_amount, tax_amount and tax_breakdown: GET /invoices, GET /invoices/{invoice}

Every invoice states its net and tax amount in the invoice currency (net_amount + tax_amount = amount) and, in tax_breakdown, the net and tax amount per VAT rate (one entry for a single rate). The amounts follow the invoice document, including down payment and final invoices. Where the split cannot be reproduced from the stored positions, all three are null and amount stays as stored.

All single changes (54)
  • FIX POST /absences: the code response’s property type changed from integer to string for status 422
  • FIX DELETE /attendances/{id}: the message response property const value Attendance could not be deleted. was removed for the status 500
  • FIX DELETE /customers/{customer_number}: the message response property const value Customer could not be deleted. was removed for the status 500
  • FIX DELETE /projects/{id}: the message response property const value Project could not be deleted was removed for the status 500
  • FIX DELETE /projects/{id}/tasks/{task_id}: the message response property const value Task could not be deleted was removed for the status 500
  • FIX POST /receipts, DELETE /receipts/{id}, PATCH /receipts/{id}, PUT /receipts/{id}, DELETE /receipts/{id}/attachments, PUT /receipts/{id}/attachments, POST /tickets, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/attachments, POST /tickets/{id}/subtasks, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}: removed the required property success from the response with the 500 status
  • NEW POST /absences: added the new business_rule_violation enum value to the code response property for the response status 422
  • NEW POST /absences: added the new validation_failed enum value to the code response property for the response status 422
  • INFO a breaking change was detected but the major version did not increase, from 1.4.0 to 1.5.0
  • INFO removed the schema AbsenceGatewayError
  • NEW GET /absence-reasons, GET /absences, GET /activities, GET /articles, GET /attendances, POST /attendances, DELETE /attendances/{id}, PATCH /attendances/{id}, PUT /attendances/{id}, GET /categories, GET /customers, POST /customers, PATCH /customers/{customer_number}, PUT /customers/{customer_number}, GET /customers/{customer_number}/contacts, POST /customers/{customer_number}/contacts, PATCH /customers/{customer_number}/contacts/{id}, PUT /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/price-tables, GET /departments, POST /departments, PATCH /departments/{id}, GET /departments/{id}/children, GET /departments/{id}/employees, POST /departments/{id}/managers, GET /devices, GET /dynamic-attributes, GET /employees, POST /employees, GET /employees/{username}, PATCH /employees/{username}, PUT /employees/{username}, GET /employees/{username}/absences, GET /employees/{username}/employment-periods, POST /employees/{username}/employment-periods, PATCH /employees/{username}/employment-periods/{id}, PUT /employees/{username}/employment-periods/{id}, GET /employees/{username}/internal-rates, GET /employees/{username}/meals, GET /employees/{username}/projects, GET /employees/{username}/regular-working-times, POST /employees/{username}/regular-working-times, DELETE /employees/{username}/regular-working-times/{id}, PATCH /employees/{username}/regular-working-times/{id}, PUT /employees/{username}/regular-working-times/{id}, GET /employees/{username}/transponders, GET /employees/{username}/travel-data, POST /employees/{username}/travel-data, PATCH /employees/{username}/travel-data/{id}, GET /folders, GET /folders/{id}/documents, GET /holiday-calendars, GET /invoice-items, GET /invoices, GET /invoices/{invoice_number}/items, GET /location-lists, GET /location-lists/{id}/locations, GET /locations, GET /offers, GET /offers/{id}/items, GET /plannings, GET /price-groups, GET /project-employees, GET /projects, POST /projects, PATCH /projects/{id}, PUT /projects/{id}, GET /projects/{id}/activities, GET /projects/{id}/employees, GET /projects/{id}/invoice-items, GET /projects/{id}/locations, GET /projects/{id}/tasks, POST /projects/{id}/tasks, PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}/employees, GET /receipts, POST /receipts, GET /receipts-amounts, PATCH /receipts/{id}, PUT /receipts/{id}, GET /receipts/{id}/amounts, GET /resource-plannings, GET /tickets, POST /tickets, PATCH /tickets/{id}, PUT /tickets/{id}, GET /tickets/{id}/subtasks, POST /tickets/{id}/subtasks, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}, GET /travel-data, GET /vehicles, GET /workhour-balances: added #/components/schemas/ApiError to the response body allOf list for the response status 422
  • NEW GET /absence-reasons, GET /absence-reasons/{name}, GET /absences, POST /absences, GET /absences/{id}, GET /activities, GET /activities/{activity}, GET /articles, GET /articles/{id}, GET /attendances, POST /attendances, DELETE /attendances/{id}, GET /attendances/{id}, PATCH /attendances/{id}, PUT /attendances/{id}, GET /categories, GET /categories/{name}, GET /customers, POST /customers, DELETE /customers/{customer_number}, GET /customers/{customer_number}, PATCH /customers/{customer_number}, PUT /customers/{customer_number}, GET /customers/{customer_number}/contacts, POST /customers/{customer_number}/contacts, DELETE /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/contacts/{id}, PATCH /customers/{customer_number}/contacts/{id}, PUT /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/price-tables, GET /customers/{customer_number}/price-tables/{id}, GET /departments, POST /departments, GET /departments/{id}, PATCH /departments/{id}, GET /departments/{id}/children, GET /departments/{id}/employees, GET /departments/{id}/managers, POST /departments/{id}/managers, DELETE /departments/{id}/managers/{username}, GET /devices, GET /devices/{id}, GET /dynamic-attributes, GET /dynamic-attributes/{id}, GET /employees, POST /employees, GET /employees/{username}, PATCH /employees/{username}, PUT /employees/{username}, GET /employees/{username}/absences, GET /employees/{username}/employment-periods, POST /employees/{username}/employment-periods, GET /employees/{username}/employment-periods/{id}, PATCH /employees/{username}/employment-periods/{id}, PUT /employees/{username}/employment-periods/{id}, GET /employees/{username}/internal-rates, GET /employees/{username}/internal-rates/{id}, GET /employees/{username}/meals, GET /employees/{username}/meals/{id}, GET /employees/{username}/projects, GET /employees/{username}/regular-working-times, POST /employees/{username}/regular-working-times, DELETE /employees/{username}/regular-working-times/{id}, GET /employees/{username}/regular-working-times/{id}, PATCH /employees/{username}/regular-working-times/{id}, PUT /employees/{username}/regular-working-times/{id}, GET /employees/{username}/transponders, GET /employees/{username}/travel-data, POST /employees/{username}/travel-data, PATCH /employees/{username}/travel-data/{id}, GET /folders, GET /folders/{id}, GET /folders/{id}/documents, GET /folders/{id}/documents/{document_id}, GET /holiday-calendars, GET /holiday-calendars/{id}, GET /invoice-items, GET /invoice-items/{id}, GET /invoices, GET /invoices/{invoice_number}, GET /invoices/{invoice_number}/attachments, GET /invoices/{invoice_number}/items, GET /location-lists, GET /location-lists/{id}, GET /location-lists/{id}/locations, GET /locations, GET /locations/{name}, GET /offers, GET /offers/{id}, GET /offers/{id}/items, GET /offers/{id}/items/{item_id}, GET /planning, GET /plannings, GET /price-groups, GET /price-groups/{id}, GET /project-employees, GET /projects, POST /projects, DELETE /projects/{id}, GET /projects/{id}, PATCH /projects/{id}, PUT /projects/{id}, GET /projects/{id}/activities, GET /projects/{id}/employees, GET /projects/{id}/invoice-items, GET /projects/{id}/locations, GET /projects/{id}/price-tables, GET /projects/{id}/price-tables/{price_table_id}, GET /projects/{id}/tasks, POST /projects/{id}/tasks, DELETE /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}, PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}/employees, GET /projects/{id}/tasks/{task_id}/employees/{project_task_employee_id}, GET /receipts, POST /receipts, GET /receipts-amounts, DELETE /receipts/{id}, GET /receipts/{id}, PATCH /receipts/{id}, PUT /receipts/{id}, GET /receipts/{id}/amounts, GET /receipts/{id}/amounts/{amount_id}, DELETE /receipts/{id}/attachments, GET /receipts/{id}/attachments, PUT /receipts/{id}/attachments, GET /resource-plannings, GET /tickets, POST /tickets, DELETE /tickets/{id}, GET /tickets/{id}, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/attachments, GET /tickets/{id}/subtasks, POST /tickets/{id}/subtasks, DELETE /tickets/{id}/subtasks/{subtask_id}, GET /tickets/{id}/subtasks/{subtask_id}, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}, GET /travel-data, GET /vehicles, GET /workhour-balances, GET /workhour-balances/{id}: added #/components/schemas/ApiError to the response body allOf list for the response status 429
  • NEW GET /absence-reasons, GET /absence-reasons/{name}, GET /absences, POST /absences, GET /absences/{id}, GET /activities, GET /activities/{activity}, GET /articles, GET /articles/{id}, GET /attendances, POST /attendances, DELETE /attendances/{id}, GET /attendances/{id}, PATCH /attendances/{id}, PUT /attendances/{id}, GET /categories, GET /categories/{name}, GET /customers, POST /customers, DELETE /customers/{customer_number}, GET /customers/{customer_number}, PATCH /customers/{customer_number}, PUT /customers/{customer_number}, GET /customers/{customer_number}/contacts, POST /customers/{customer_number}/contacts, DELETE /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/contacts/{id}, PATCH /customers/{customer_number}/contacts/{id}, PUT /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/price-tables, GET /customers/{customer_number}/price-tables/{id}, GET /departments, POST /departments, GET /departments/{id}, PATCH /departments/{id}, GET /departments/{id}/children, GET /departments/{id}/employees, GET /departments/{id}/managers, POST /departments/{id}/managers, DELETE /departments/{id}/managers/{username}, GET /devices, GET /devices/{id}, GET /dynamic-attributes, GET /dynamic-attributes/{id}, GET /employees, POST /employees, GET /employees/{username}, PATCH /employees/{username}, PUT /employees/{username}, GET /employees/{username}/absences, GET /employees/{username}/employment-periods, POST /employees/{username}/employment-periods, GET /employees/{username}/employment-periods/{id}, PATCH /employees/{username}/employment-periods/{id}, PUT /employees/{username}/employment-periods/{id}, GET /employees/{username}/internal-rates, GET /employees/{username}/internal-rates/{id}, GET /employees/{username}/meals, GET /employees/{username}/meals/{id}, GET /employees/{username}/projects, GET /employees/{username}/regular-working-times, POST /employees/{username}/regular-working-times, DELETE /employees/{username}/regular-working-times/{id}, GET /employees/{username}/regular-working-times/{id}, PATCH /employees/{username}/regular-working-times/{id}, PUT /employees/{username}/regular-working-times/{id}, GET /employees/{username}/transponders, GET /employees/{username}/travel-data, POST /employees/{username}/travel-data, PATCH /employees/{username}/travel-data/{id}, GET /folders, GET /folders/{id}, GET /folders/{id}/documents, GET /folders/{id}/documents/{document_id}, GET /holiday-calendars, GET /holiday-calendars/{id}, GET /invoice-items, GET /invoice-items/{id}, GET /invoices, GET /invoices/{invoice_number}, GET /invoices/{invoice_number}/attachments, GET /invoices/{invoice_number}/items, GET /location-lists, GET /location-lists/{id}, GET /location-lists/{id}/locations, GET /locations, GET /locations/{name}, GET /offers, GET /offers/{id}, GET /offers/{id}/items, GET /offers/{id}/items/{item_id}, GET /planning, GET /plannings, GET /price-groups, GET /price-groups/{id}, GET /project-employees, GET /projects, POST /projects, DELETE /projects/{id}, GET /projects/{id}, PATCH /projects/{id}, PUT /projects/{id}, GET /projects/{id}/activities, GET /projects/{id}/employees, GET /projects/{id}/invoice-items, GET /projects/{id}/locations, GET /projects/{id}/price-tables, GET /projects/{id}/price-tables/{price_table_id}, GET /projects/{id}/tasks, POST /projects/{id}/tasks, DELETE /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}, PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}/employees, GET /projects/{id}/tasks/{task_id}/employees/{project_task_employee_id}, GET /receipts, POST /receipts, GET /receipts-amounts, DELETE /receipts/{id}, GET /receipts/{id}, PATCH /receipts/{id}, PUT /receipts/{id}, GET /receipts/{id}/amounts, GET /receipts/{id}/amounts/{amount_id}, DELETE /receipts/{id}/attachments, GET /receipts/{id}/attachments, PUT /receipts/{id}/attachments, GET /resource-plannings, GET /tickets, POST /tickets, DELETE /tickets/{id}, GET /tickets/{id}, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/attachments, GET /tickets/{id}/subtasks, POST /tickets/{id}/subtasks, DELETE /tickets/{id}/subtasks/{subtask_id}, GET /tickets/{id}/subtasks/{subtask_id}, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}, GET /travel-data, GET /vehicles, GET /workhour-balances, GET /workhour-balances/{id}: added the required property code to the response with the 401 status
  • NEW GET /absence-reasons, GET /absence-reasons/{name}, GET /absences, POST /absences, GET /absences/{id}, GET /activities, GET /activities/{activity}, GET /articles, GET /articles/{id}, GET /attendances, POST /attendances, DELETE /attendances/{id}, GET /attendances/{id}, PATCH /attendances/{id}, PUT /attendances/{id}, GET /categories, GET /categories/{name}, GET /customers, POST /customers, DELETE /customers/{customer_number}, GET /customers/{customer_number}, PATCH /customers/{customer_number}, PUT /customers/{customer_number}, GET /customers/{customer_number}/contacts, POST /customers/{customer_number}/contacts, DELETE /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/contacts/{id}, PATCH /customers/{customer_number}/contacts/{id}, PUT /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/price-tables, GET /customers/{customer_number}/price-tables/{id}, GET /departments, POST /departments, GET /departments/{id}, PATCH /departments/{id}, GET /departments/{id}/children, GET /departments/{id}/employees, GET /departments/{id}/managers, POST /departments/{id}/managers, DELETE /departments/{id}/managers/{username}, GET /devices, GET /devices/{id}, GET /dynamic-attributes, GET /dynamic-attributes/{id}, GET /employees, POST /employees, GET /employees/{username}, PATCH /employees/{username}, PUT /employees/{username}, GET /employees/{username}/absences, GET /employees/{username}/employment-periods, POST /employees/{username}/employment-periods, GET /employees/{username}/employment-periods/{id}, PATCH /employees/{username}/employment-periods/{id}, PUT /employees/{username}/employment-periods/{id}, GET /employees/{username}/internal-rates, GET /employees/{username}/internal-rates/{id}, GET /employees/{username}/meals, GET /employees/{username}/meals/{id}, GET /employees/{username}/projects, GET /employees/{username}/regular-working-times, POST /employees/{username}/regular-working-times, DELETE /employees/{username}/regular-working-times/{id}, GET /employees/{username}/regular-working-times/{id}, PATCH /employees/{username}/regular-working-times/{id}, PUT /employees/{username}/regular-working-times/{id}, GET /employees/{username}/transponders, GET /employees/{username}/travel-data, POST /employees/{username}/travel-data, PATCH /employees/{username}/travel-data/{id}, GET /folders, GET /folders/{id}, GET /folders/{id}/documents, GET /folders/{id}/documents/{document_id}, GET /holiday-calendars, GET /holiday-calendars/{id}, GET /invoice-items, GET /invoice-items/{id}, GET /invoices, GET /invoices/{invoice_number}, GET /invoices/{invoice_number}/attachments, GET /invoices/{invoice_number}/items, GET /location-lists, GET /location-lists/{id}, GET /location-lists/{id}/locations, GET /locations, GET /locations/{name}, GET /offers, GET /offers/{id}, GET /offers/{id}/items, GET /offers/{id}/items/{item_id}, GET /planning, GET /plannings, GET /price-groups, GET /price-groups/{id}, GET /project-employees, GET /projects, POST /projects, DELETE /projects/{id}, GET /projects/{id}, PATCH /projects/{id}, PUT /projects/{id}, GET /projects/{id}/activities, GET /projects/{id}/employees, GET /projects/{id}/invoice-items, GET /projects/{id}/locations, GET /projects/{id}/price-tables, GET /projects/{id}/price-tables/{price_table_id}, GET /projects/{id}/tasks, POST /projects/{id}/tasks, DELETE /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}, PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}/employees, GET /projects/{id}/tasks/{task_id}/employees/{project_task_employee_id}, GET /receipts, POST /receipts, GET /receipts-amounts, DELETE /receipts/{id}, GET /receipts/{id}, PATCH /receipts/{id}, PUT /receipts/{id}, GET /receipts/{id}/amounts, GET /receipts/{id}/amounts/{amount_id}, DELETE /receipts/{id}/attachments, GET /receipts/{id}/attachments, PUT /receipts/{id}/attachments, GET /resource-plannings, GET /tickets, POST /tickets, DELETE /tickets/{id}, GET /tickets/{id}, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/attachments, GET /tickets/{id}/subtasks, POST /tickets/{id}/subtasks, DELETE /tickets/{id}/subtasks/{subtask_id}, GET /tickets/{id}/subtasks/{subtask_id}, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}, GET /travel-data, GET /vehicles, GET /workhour-balances, GET /workhour-balances/{id}: added the required property status to the response with the 401 status
  • NEW GET /absence-reasons/{name}, GET /absences/{id}, GET /activities/{activity}, GET /articles/{id}, DELETE /attendances/{id}, GET /attendances/{id}, PATCH /attendances/{id}, PUT /attendances/{id}, GET /categories/{name}, DELETE /customers/{customer_number}, GET /customers/{customer_number}, PATCH /customers/{customer_number}, PUT /customers/{customer_number}, GET /customers/{customer_number}/contacts, POST /customers/{customer_number}/contacts, DELETE /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/contacts/{id}, PATCH /customers/{customer_number}/contacts/{id}, PUT /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/price-tables, GET /customers/{customer_number}/price-tables/{id}, POST /departments, GET /departments/{id}, PATCH /departments/{id}, GET /departments/{id}/children, GET /departments/{id}/employees, GET /departments/{id}/managers, POST /departments/{id}/managers, DELETE /departments/{id}/managers/{username}, GET /devices/{id}, GET /dynamic-attributes/{id}, GET /employees/{username}, PATCH /employees/{username}, PUT /employees/{username}, GET /employees/{username}/absences, GET /employees/{username}/employment-periods, POST /employees/{username}/employment-periods, GET /employees/{username}/employment-periods/{id}, PATCH /employees/{username}/employment-periods/{id}, PUT /employees/{username}/employment-periods/{id}, GET /employees/{username}/internal-rates, GET /employees/{username}/internal-rates/{id}, GET /employees/{username}/meals, GET /employees/{username}/meals/{id}, GET /employees/{username}/projects, GET /employees/{username}/regular-working-times, POST /employees/{username}/regular-working-times, DELETE /employees/{username}/regular-working-times/{id}, GET /employees/{username}/regular-working-times/{id}, PATCH /employees/{username}/regular-working-times/{id}, PUT /employees/{username}/regular-working-times/{id}, GET /employees/{username}/transponders, GET /employees/{username}/travel-data, POST /employees/{username}/travel-data, PATCH /employees/{username}/travel-data/{id}, GET /folders/{id}, GET /folders/{id}/documents, GET /folders/{id}/documents/{document_id}, GET /holiday-calendars/{id}, GET /invoice-items, GET /invoice-items/{id}, GET /invoices/{invoice_number}, GET /invoices/{invoice_number}/attachments, GET /invoices/{invoice_number}/items, GET /location-lists/{id}, GET /location-lists/{id}/locations, GET /locations/{name}, GET /offers/{id}, GET /offers/{id}/items, GET /offers/{id}/items/{item_id}, GET /price-groups/{id}, DELETE /projects/{id}, GET /projects/{id}, PATCH /projects/{id}, PUT /projects/{id}, GET /projects/{id}/activities, GET /projects/{id}/employees, GET /projects/{id}/invoice-items, GET /projects/{id}/locations, GET /projects/{id}/price-tables, GET /projects/{id}/price-tables/{price_table_id}, GET /projects/{id}/tasks, DELETE /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}, PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}/employees, GET /projects/{id}/tasks/{task_id}/employees/{project_task_employee_id}, DELETE /receipts/{id}, GET /receipts/{id}, PATCH /receipts/{id}, PUT /receipts/{id}, GET /receipts/{id}/amounts, GET /receipts/{id}/amounts/{amount_id}, DELETE /receipts/{id}/attachments, GET /receipts/{id}/attachments, PUT /receipts/{id}/attachments, DELETE /tickets/{id}, GET /tickets/{id}, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/attachments, GET /tickets/{id}/subtasks, POST /tickets/{id}/subtasks, DELETE /tickets/{id}/subtasks/{subtask_id}, GET /tickets/{id}/subtasks/{subtask_id}, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}, GET /travel-data, GET /workhour-balances/{id}: added the required property code to the response with the 404 status
  • NEW GET /absence-reasons/{name}, GET /absences/{id}, GET /activities/{activity}, GET /articles/{id}, DELETE /attendances/{id}, GET /attendances/{id}, PATCH /attendances/{id}, PUT /attendances/{id}, GET /categories/{name}, DELETE /customers/{customer_number}, GET /customers/{customer_number}, PATCH /customers/{customer_number}, PUT /customers/{customer_number}, GET /customers/{customer_number}/contacts, POST /customers/{customer_number}/contacts, DELETE /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/contacts/{id}, PATCH /customers/{customer_number}/contacts/{id}, PUT /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/price-tables, GET /customers/{customer_number}/price-tables/{id}, POST /departments, GET /departments/{id}, PATCH /departments/{id}, GET /departments/{id}/children, GET /departments/{id}/employees, GET /departments/{id}/managers, POST /departments/{id}/managers, DELETE /departments/{id}/managers/{username}, GET /devices/{id}, GET /dynamic-attributes/{id}, GET /employees/{username}, PATCH /employees/{username}, PUT /employees/{username}, GET /employees/{username}/absences, GET /employees/{username}/employment-periods, POST /employees/{username}/employment-periods, GET /employees/{username}/employment-periods/{id}, PATCH /employees/{username}/employment-periods/{id}, PUT /employees/{username}/employment-periods/{id}, GET /employees/{username}/internal-rates, GET /employees/{username}/internal-rates/{id}, GET /employees/{username}/meals, GET /employees/{username}/meals/{id}, GET /employees/{username}/projects, GET /employees/{username}/regular-working-times, POST /employees/{username}/regular-working-times, DELETE /employees/{username}/regular-working-times/{id}, GET /employees/{username}/regular-working-times/{id}, PATCH /employees/{username}/regular-working-times/{id}, PUT /employees/{username}/regular-working-times/{id}, GET /employees/{username}/transponders, GET /employees/{username}/travel-data, POST /employees/{username}/travel-data, PATCH /employees/{username}/travel-data/{id}, GET /folders/{id}, GET /folders/{id}/documents, GET /folders/{id}/documents/{document_id}, GET /holiday-calendars/{id}, GET /invoice-items, GET /invoice-items/{id}, GET /invoices/{invoice_number}, GET /invoices/{invoice_number}/attachments, GET /invoices/{invoice_number}/items, GET /location-lists/{id}, GET /location-lists/{id}/locations, GET /locations/{name}, GET /offers/{id}, GET /offers/{id}/items, GET /offers/{id}/items/{item_id}, GET /price-groups/{id}, DELETE /projects/{id}, GET /projects/{id}, PATCH /projects/{id}, PUT /projects/{id}, GET /projects/{id}/activities, GET /projects/{id}/employees, GET /projects/{id}/invoice-items, GET /projects/{id}/locations, GET /projects/{id}/price-tables, GET /projects/{id}/price-tables/{price_table_id}, GET /projects/{id}/tasks, DELETE /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}, PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}/employees, GET /projects/{id}/tasks/{task_id}/employees/{project_task_employee_id}, DELETE /receipts/{id}, GET /receipts/{id}, PATCH /receipts/{id}, PUT /receipts/{id}, GET /receipts/{id}/amounts, GET /receipts/{id}/amounts/{amount_id}, DELETE /receipts/{id}/attachments, GET /receipts/{id}/attachments, PUT /receipts/{id}/attachments, DELETE /tickets/{id}, GET /tickets/{id}, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/attachments, GET /tickets/{id}/subtasks, POST /tickets/{id}/subtasks, DELETE /tickets/{id}/subtasks/{subtask_id}, GET /tickets/{id}/subtasks/{subtask_id}, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}, GET /travel-data, GET /workhour-balances/{id}: added the required property status to the response with the 404 status
  • NEW POST /absences: added the optional property zep_code to the response with the 422 status
  • INFO POST /absences: the response property code became required for the status 422
  • INFO POST /absences: the response property status became required for the status 422
  • NEW POST /absences: added the required property code to the response with the 502 status
  • NEW POST /absences: added the required property status to the response with the 502 status
  • NEW DELETE /attendances/{id}, DELETE /customers/{customer_number}, DELETE /projects/{id}, DELETE /projects/{id}/tasks/{task_id}, POST /receipts, DELETE /receipts/{id}, PATCH /receipts/{id}, PUT /receipts/{id}, DELETE /receipts/{id}/attachments, PUT /receipts/{id}/attachments, POST /tickets, DELETE /tickets/{id}, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/attachments, POST /tickets/{id}/subtasks, DELETE /tickets/{id}/subtasks/{subtask_id}, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}: added the required property code to the response with the 500 status
  • NEW DELETE /attendances/{id}, DELETE /customers/{customer_number}, DELETE /projects/{id}, DELETE /projects/{id}/tasks/{task_id}, POST /receipts, DELETE /receipts/{id}, PATCH /receipts/{id}, PUT /receipts/{id}, DELETE /receipts/{id}/attachments, PUT /receipts/{id}/attachments, POST /tickets, DELETE /tickets/{id}, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/attachments, POST /tickets/{id}/subtasks, DELETE /tickets/{id}/subtasks/{subtask_id}, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}: added the required property status to the response with the 500 status
  • NEW GET /customers: added the required property data/items/addresses/items/debtor to the response with the 200 status
  • NEW GET /customers: added the required property data/items/addresses/items/name_additional to the response with the 200 status
  • NEW GET /customers: added the required property data/items/debtor_number to the response with the 200 status
  • NEW POST /customers: added the required property data/allOf[subschema #1: CustomerResource]/addresses/items/debtor to the response with the 201 status
  • NEW POST /customers: added the required property data/allOf[subschema #1: CustomerResource]/addresses/items/name_additional to the response with the 201 status
  • NEW POST /customers: added the required property data/allOf[subschema #1: CustomerResource]/debtor_number to the response with the 201 status
  • NEW GET /customers/{customer_number}: added the required property data/addresses/items/debtor to the response with the 200 status
  • NEW GET /customers/{customer_number}: added the required property data/addresses/items/name_additional to the response with the 200 status
  • NEW GET /customers/{customer_number}: added the required property data/debtor_number to the response with the 200 status
  • NEW PATCH /customers/{customer_number}, PUT /customers/{customer_number}: added the required property data/allOf[subschema #1: CustomerResource]/addresses/items/debtor to the response with the 200 status
  • NEW PATCH /customers/{customer_number}, PUT /customers/{customer_number}: added the required property data/allOf[subschema #1: CustomerResource]/addresses/items/name_additional to the response with the 200 status
  • NEW PATCH /customers/{customer_number}, PUT /customers/{customer_number}: added the required property data/allOf[subschema #1: CustomerResource]/debtor_number to the response with the 200 status
  • NEW GET /invoices: added the required property data/items/billing_address to the response with the 200 status
  • NEW GET /invoices: added the required property data/items/contact_id to the response with the 200 status
  • NEW GET /invoices: added the required property data/items/customer_address_id to the response with the 200 status
  • NEW GET /invoices: added the required property data/items/debtor to the response with the 200 status
  • NEW GET /invoices: added the required property data/items/net_amount to the response with the 200 status
  • NEW GET /invoices: added the required property data/items/tax_amount to the response with the 200 status
  • NEW GET /invoices: added the required property data/items/tax_breakdown to the response with the 200 status
  • NEW GET /invoices/{invoice_number}: added the required property data/billing_address to the response with the 200 status
  • NEW GET /invoices/{invoice_number}: added the required property data/contact_id to the response with the 200 status
  • NEW GET /invoices/{invoice_number}: added the required property data/customer_address_id to the response with the 200 status
  • NEW GET /invoices/{invoice_number}: added the required property data/debtor to the response with the 200 status
  • NEW GET /invoices/{invoice_number}: added the required property data/net_amount to the response with the 200 status
  • NEW GET /invoices/{invoice_number}: added the required property data/tax_amount to the response with the 200 status
  • NEW GET /invoices/{invoice_number}: added the required property data/tax_breakdown to the response with the 200 status
  • NEW DELETE /receipts/{id}, DELETE /receipts/{id}/attachments, PUT /receipts/{id}/attachments, DELETE /tickets/{id}, POST /tickets/{id}/attachments, DELETE /tickets/{id}/subtasks/{subtask_id}: added the required property message to the response with the 500 status
  • NEW POST /tickets, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/subtasks, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}: added the required property code to the response with the 403 status
  • NEW POST /tickets, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/subtasks, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}: added the required property status to the response with the 403 status
  • INFO DELETE /tickets/{id}, DELETE /tickets/{id}/subtasks/{subtask_id}: removed subschema #1, subschema #2 from the response body anyOf list for the response status 500
  • INFO DELETE /tickets/{id}, DELETE /tickets/{id}/subtasks/{subtask_id}: the response’s body type was narrowed from any to object for status 500

v8.0.132 · OpenAPI 1.3.0 → 1.4.0 · 09.11.2026

Department managers: GET, POST /departments/{id}/managers and DELETE /departments/{id}/managers/{username}

List, assign and remove the managers of a department. POST takes username and answers 201 with the manager entry; an employee without a current employment can be assigned. Assigning and removing also set and remove the department lead role of Roles & Permissions for that department, as the web interface does. An unknown username or an employee who already manages the department answers 422 on username; removing an employee who does not manage it answers 404. manager of GET /departments/{id} and the new list return is_deputy per manager; sending is_deputy needs the licence module Inovex and answers 422 without it. Writing needs the module “Standorte & Abteilungen” and answers 404 without it; reading is unchanged.

Task activities: activities and default_activity on /projects/{project}/tasks

Every task now returns activities (the short names of its own activities, an empty list when it has none) and default_activity (a short name or null). POST and PATCH accept both: activities replaces the list, [] removes all own activities (the project’s, else all activities apply again, and the default is reset), an omitted field leaves it unchanged. PATCH now also works with only the changed fields. 422 on an unknown activity or one not allowed on the project (the message names it, keyed activities.<n>), on a default_activity outside the list (default_activity) and on a grouping task, one with subtasks (activities). A default the new list drops becomes null. The rules are those of the web interface.

Delete a regular working time: DELETE /employees/{username}/regular-working-times/{id}

Deletes a regular working time with the checks of the web interface; answers 204. A schedule that applies since the start of employment (no start_date), one starting before the first day after the last monthly closing, a monthly schedule starting before the current month, and one whose removal would change the break regulation while time is booked in its period answer 422 with the reason, keyed by the rule (start_date, NotEditable, MonthlyInPast, BreakRegulationConflict); with the licence module BruggCable a closed or locked period answers 422 on PeriodClosedForBruggCable. Availability and break compliance are recalculated afterwards; a failing recalculation does not undo the delete. An id of another employee or an unknown id answers 404.

Travel data (module Inovex): GET, POST /employees/{username}/travel-data, PATCH /employees/{username}/travel-data/{id} and GET /travel-data

Read, create and change the distance (distance, km) and travel time (travel_time, hours) of an employee from a day on (valid_from); 0 is a valid value. An employee has one entry per valid_from: a second one for the same day answers 422 on valid_from. GET /travel-data lists the entries of all employees with their username, filterable by username (several allowed), valid_from_after (exclusive) and valid_from_before (inclusive), up to 200 per page. All four operations need the licence module Inovex and answer 404 without it. They are marked x-zep-customer-specific in the specification.

Departments: create and change: POST /departments and PATCH /departments/{id}

Create a department and change the fields you send (name, description, parent_id, status, where status=true means inactive as when reading). The answer is the department as GET /departments/{id} returns it. The rules are those of the user interface: the name is unique and free of unsafe characters, parent_id must exist and must not be the department itself or one of its descendants, a department with an active sub-department and the last active department cannot be set inactive, and an active department cannot sit under an inactive one. A broken rule answers 422 on the field concerned. Both operations need the module “Standorte & Abteilungen” and answer 404 without it; reading is unchanged.

All single changes (13)
  • NEW GET /departments, GET /departments/{id}/children: added the required property data/items/manager/items/is_deputy to the response with the 200 status
  • NEW POST /departments, PATCH /departments/{id}, GET /departments/{id}/managers, POST /departments/{id}/managers, DELETE /departments/{id}/managers/{username}, DELETE /employees/{username}/regular-working-times/{id}, GET /employees/{username}/travel-data, POST /employees/{username}/travel-data, PATCH /employees/{username}/travel-data/{id}, GET /travel-data: endpoint added
  • NEW GET /departments/{id}: added the required property data/manager/items/is_deputy to the response with the 200 status
  • NEW GET /projects/{id}/tasks: added the required property data/items/activities to the response with the 200 status
  • NEW GET /projects/{id}/tasks: added the required property data/items/default_activity to the response with the 200 status
  • NEW POST /projects/{id}/tasks, PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}: added the new optional request property activities
  • NEW POST /projects/{id}/tasks, PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}: added the new optional request property default_activity
  • NEW POST /projects/{id}/tasks: added the required property data/allOf[subschema #1: ProjectTaskResource]/activities to the response with the 201 status
  • NEW POST /projects/{id}/tasks: added the required property data/allOf[subschema #1: ProjectTaskResource]/default_activity to the response with the 201 status
  • NEW GET /projects/{id}/tasks/{task_id}: added the required property data/activities to the response with the 200 status
  • NEW GET /projects/{id}/tasks/{task_id}: added the required property data/default_activity to the response with the 200 status
  • NEW PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}: added the required property data/allOf[subschema #1: ProjectTaskResource]/activities to the response with the 200 status
  • NEW PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}: added the required property data/allOf[subschema #1: ProjectTaskResource]/default_activity to the response with the 200 status

v8.0.105 · OpenAPI 1.3.0 · 06.11.2026

Invoices: description of type

Documentation only. type is ZA, SR or TSR; the old text promised a correction or cancellation credit note, which the field never delivered.

Departments: description of status and manager_count

Documentation only. status is the stored inactive flag: 1 means inactive, 0 or null means active; the type and values are unchanged. manager_count is a number of managers, not a yes/no.

Projects and tasks: cost_object_identifier is a string and survives an update

PATCH /projects/{id} without cost_object_identifier no longer resets the cost carrier. The field is string|null in POST /projects, PUT/PATCH /projects/{id} and PUT/PATCH on a task, like the response; a JSON number is still accepted and stored as a string. With a numeric cost center format only digits are accepted and leading zeros are kept ("0815").

Regular working times: holiday calendar check on POST /employees/{id}/regular-working-times

Creating a regular working time with a different holiday calendar now rejects the request with 422 (MonthlyClosingConflict, AbsenceOnHolidayConflict) when the period is closed or an absence falls on a holiday of the new calendar. The check read no calendar before and never fired.

Employees: categories replaces the list, unknown names are rejected: POST, PUT and PATCH /employees

categories is a list of {"name": "..."} entries and replaces the employee’s categories completely: [] removes all of them, a missing or null field leaves them unchanged. A name that is not an employee category (unknown, or a project-only category) answers 422 with the name in errors, and nothing is saved; before, [] was ignored and an unknown name was skipped silently. The spec now describes the entries as objects with a name, as they always were.

Regular working times: calendar change on PUT and PATCH /employees/{id}/regular-working-times/{id}

Changing holiday_calendar_id runs the same check as on create and answers 422 with the reason; the regular working time stays unchanged. An update with the same or no calendar is not checked.

Employees: filters employed and employed_on: GET /employees

employed=true returns only employees with an employment period on the reference day, employed=false all others, including employees without a period. employed_on (Y-m-d) sets the reference day, today by default; a period that starts or ends on that day counts, and the value is ignored without employed. Other values answer 422 on the parameter. The filters combine with personal_number, modified_after and paging.

Holiday calendars: GET /holiday-calendars and GET /holiday-calendars/{id}

Lists the holiday calendars (sorted by id, page and limit up to 200) and returns a single one. The id is the holiday_calendar_id a regular working time carries, so the calendar of a regular working time can be looked up. Available on every licence, Clock included.

Invoice positions: cancellation_credit_invoice_number

Every invoice position endpoint now delivers the number of the cancelled invoice a credit position refers to; null for all other positions.

v8.0.90.2 · OpenAPI 1.2.0 · 05.11.2026

PUT/PATCH /employees/{employee}/regular-working-times/{id} keeps the holiday calendar

An update without holiday_calendar_id reset the schedule’s holiday calendar to the default calendar. It now stays as it is; only an explicit holiday_calendar_id changes it. POST without it still sets the default calendar.

v8.0.84 · OpenAPI 1.2.0 · 02.11.2026

limit is honoured: GET /projects/{id}/tasks

The task list ignored limit and always returned 15 tasks per page; perPage accepted only 5, 10 or 15. limit now sets the page size, 1 to 200, and a value outside that range answers 422, as on every other list. perPage is ignored on this endpoint, the same as elsewhere (the published specification still lists 5, 10, 15 for it), and limit is declared in the published specification.

v8.0.75 · OpenAPI 1.0.0 → 1.1.0 · 30.10.2026

Billing lock covers stored bookings: PUT, PATCH and DELETE /attendances/{id}

A booking inside an invoiced period (approved or billed invoice item) or attached to an invoice item can no longer be changed or deleted: the request answers 422 Billing is blocked. and nothing is saved. Before, only the new state of a PUT was checked, so a locked booking could be moved out, made non-billable or deleted. The lock on these three requests can be switched off per tenant; switched off, they behave as before this change.

Nested lists honour limit: GET /customers/{customer}/price-tables, /customers/{customer}/contacts, /departments/{department}/children, /departments/{department}/employees, /employees/{employee}/absences, /employees/{employee}/meals, /employees/{employee}/transponders, /offers/{offer}/items, /projects/{project}/activities, /projects/{project}/locations, /receipts/{receipt}/amounts, /tickets/{ticket}/subtasks, /devices

These lists ignored limit and always answered 15 entries per page. They now take limit (1 to 200, 422 outside it, default 15) and page, in a stable order, and the page links keep limit. Besides limit and page they accept no parameters, except GET /departments, which keeps its start_date and end_date filters and its orderBy and order sorting and now honours limit as well.

Pagination links keep the query: GET /plannings

links.first, prev, next and last of GET /plannings dropped the query string, so following next returned unfiltered data, 15 per page, instead of the page of the request’s modified_after, limit, include_defaults and other filters. They now carry every parameter of the request, with and without include_defaults. The other paginated lists (for example GET /customers/{customer_number}/contacts) pass the query string through in their links as well, which changes nothing in what they return; the nested ones also take limit.

Billing lock for bookings: POST /attendances, PUT /attendances/{id}

A billable booking into a period that an approved or billed invoice item of the project covers is now rejected with 422 and the message “Billing is blocked.”, as in the web UI. Moving an existing booking into such a period is rejected the same way, and a booking already attached to an invoice item stays locked. Needs the invoicing module; the Jira worklog import skips such bookings with the same reason.

All single changes (2)
  • NEW GET /customers/{customer_number}/contacts, GET /customers/{customer_number}/price-tables, GET /departments/{id}/children, GET /departments/{id}/employees, GET /devices, GET /employees/{username}/absences, GET /employees/{username}/meals, GET /employees/{username}/transponders, GET /offers/{id}/items, GET /projects/{id}/activities, GET /projects/{id}/locations, GET /receipts/{id}/amounts, GET /tickets/{id}/subtasks: added the new optional query request parameter limit
  • NEW GET /customers/{customer_number}/contacts, GET /customers/{customer_number}/price-tables, GET /departments/{id}/children, GET /departments/{id}/employees, GET /devices, GET /employees/{username}/absences, GET /employees/{username}/meals, GET /employees/{username}/transponders, GET /offers/{id}/items, GET /projects/{id}/activities, GET /projects/{id}/locations, GET /receipts/{id}/amounts, GET /tickets/{id}/subtasks: added the non-success response with the status 422

v8.0.59 · OpenAPI 1.0.0 · 28.10.2026

Rate limit: all customer operations

The specification now documents the limit the API has enforced: 1000 requests per 5 minutes per tenant, plus at most 25 concurrent requests per tenant. Every operation lists the 429 answer ({"message": "Too Many Attempts."} with Retry-After, X-RateLimit-Reset, X-RateLimit-Limit, X-RateLimit-Remaining), and every success response lists X-RateLimit-Limit and X-RateLimit-Remaining. Documentation only, no behaviour change.

Tasks: all_project_employees on GET /projects/{id}/tasks

Every task now reports all_project_employees: true when all project employees may book on it, false when only the employees listed under GET /projects/{id}/tasks/{task_id}/employees may. The employee list of a task with all_project_employees: true is empty on purpose.

Employees: cost_center, note, overtime_ads and project_number

GET/POST/PUT /employees and GET /departments/{id}/employees now return cost_center (Kostenstelle, separate from cost_bearer), note and overtime_ads (boolean, null when never set). Project assignments on /employees/{employee}/projects and /projects/{project}/employees carry project_number. Licence: as before.

Employees: include for employment periods, regular working times and internal rates

GET /employees and GET /employees/{employee} accept include=employment_periods,regular_working_times,internal_rates (any subset, comma-separated) and embed those lists in each employee under the same key, in the shape of the per-employee endpoints; the lists are complete, not paged, and empty ones are []. An unknown value answers 422; on a Clock licence internal_rates is unknown, as the internal-rates endpoint is not offered there either. With include=internal_rates, modified_after also finds an employee whose internal rate changed, and modified_before leaves out one whose internal rate changed after the bound; a deleted internal rate leaves no timestamp and is not detected. Employment period and working time changes already move the employee’s modified. Without include nothing changes. Licence: as before.

Project assignments: GET /project-employees

Lists the project assignments of all projects in one paginated call, ordered by id. Filter by project_id and employee_id (a single value or a list), project_status, project_start_date and project_end_date. Not available on ZEP Clock.

Project assignments of a project: GET /projects/{project}/employees

project_status, project_start_date and project_end_date were accepted but ignored; they now narrow the list like they do on GET /employees/{employee}/projects.

Invoice filters and positions: GET /invoices

New query parameters modified_after (exclusive) and modified_before (inclusive) restrict the list to invoices changed in a time window; the modified value of a response works as the next modified_after. start_date and end_date (YYYY-MM-DD, both inclusive, either one alone is allowed) filter by the invoice date. include=items embeds each invoice’s positions as items, in the form of GET /invoices/{invoice}/items, so no call per invoice is needed; without include the key is absent. An unknown include value answers 422. A position change does not necessarily move the invoice’s modified.

A client generated from the specification compiles: GET /plannings, GET /employees, GET /folders/{id}/documents, GET /folders/{id}/documents/{document_id}, GET /projects/{id}/employees, GET /employees/{id}/projects

The specification described planning_details.type and unit as always null and listed an empty value for salutation.name; both now match the answers (type is percentage, hours, time_range, days or null, unit is %, hours, time, days or null; salutation.name is a plain string). Document and ProjectEmployee are documented as the object they return, without the empty-array alternative. A document in a folder without a file system answers file_contents: null with filename and type, no longer an empty array, and the planning times from, to, from_time and to_time are documented as HH:MM:SS strings, not date-times. The values themselves do not change.

Task employees: no stored assignments while the task is open to all project employees

The list is now empty while the task has all_project_employees: true, even if assignments from an earlier explicit setup are still stored, and GET /projects/{id}/tasks/{task_id}/employees/{id} returns 404 for such an assignment. Booking already ignored them.

Employee sub-lists honour limit and page: GET /employees/{employee}/employment-periods, /regular-working-times, /internal-rates

These three lists ignored limit and always answered 15 entries per page. They now page like every other list: limit 1 to 200 (422 outside it), default 15, plus page. A client that sent limit and relied on it being ignored gets the requested page size.

Absence creation answers with the real outcome: POST /absences

A created absence now answers 201 instead of 200. A request ZEP rejects on business grounds (for example an absence before the introduction date of the absence module) answers 422 with ZEP’s code, message and the message again under errors.absence, and any other failure on the ZEP side answers 502; both used to come back as 200. Only ZEP code 104 counts as a rejection (ZEP also answers a storage error with it); every other ZEP error code answers 502. A half-day (type 1) or hourly (type 2) absence is now stored with that type; it used to be stored as a full day. timezone is optional for every absence type and defaults to the server’s timezone.

Absences return created and modified: GET /absences, GET /absences/{id}

created and modified were always null on absences, on the embedded absenceReason and on GET /absence-reasons and GET /articles; they now carry the stored timestamps, in UTC. Legacy rows with a zero-date (0000-00-00 00:00:00) still answer null.

The specification matches the responses: types, nullable fields, date formats, cursor

Documentation only, no response changes. ProjectStatus.id is a string (the short name, e.g. Aktiv), Department.id is an integer, Project.keywords is a list of strings. CustomerContact.primary, Invoice.correction_date, Invoice.email_sent_at, Invoice.email_recipient, Invoice.note, Price.price and Project.project_status_id can be null. start_date of a price table, end_date of an attendance and from/to of a project task employee carry format: date. Invoice.correction_date is documented as local time Y-m-d H:i:s without a zone. On GET /attendances, modified_after is an inclusive cursor paired with id_after (default 0, effective only together with modified_after). oasdiff rates the type and nullability corrections as breaking; the release changelog marks them as fixes, because the frozen contract already says the same. The narrowed formats and Department.id, Project.keywords stay as oasdiff rates them.

All single changes (144)
  • FIX GET /customers, GET /projects: the response property data/items/priceTables/items/prices/items/price became nullable for the status 200
  • FIX GET /customers, GET /projects: the data/items/priceTables/items/start_date response’s property format changed from date-time to date for status 200
  • FIX POST /customers: the response property data/allOf[subschema #1: CustomerResource]/priceTables/items/prices/items/price became nullable for the status 201
  • FIX POST /customers: the data/allOf[subschema #1: CustomerResource]/priceTables/items/start_date response’s property format changed from date-time to date for status 201
  • FIX GET /customers/{customer_number}, GET /projects/{id}: the response property data/priceTables/items/prices/items/price became nullable for the status 200
  • FIX GET /customers/{customer_number}, GET /projects/{id}: the data/priceTables/items/start_date response’s property format changed from date-time to date for status 200
  • FIX PATCH /customers/{customer_number}, PUT /customers/{customer_number}: the response property data/allOf[subschema #1: CustomerResource]/priceTables/items/prices/items/price became nullable for the status 200
  • FIX PATCH /customers/{customer_number}, PUT /customers/{customer_number}: the data/allOf[subschema #1: CustomerResource]/priceTables/items/start_date response’s property format changed from date-time to date for status 200
  • FIX GET /customers/{customer_number}/contacts: the response property data/items/primary became nullable for the status 200
  • FIX POST /customers/{customer_number}/contacts: the response property data/allOf[subschema #1: CustomerContactResource]/primary became nullable for the status 201
  • FIX GET /customers/{customer_number}/contacts/{id}: the response property data/primary became nullable for the status 200
  • FIX PATCH /customers/{customer_number}/contacts/{id}, PUT /customers/{customer_number}/contacts/{id}: the response property data/allOf[subschema #1: CustomerContactResource]/primary became nullable for the status 200
  • FIX GET /customers/{customer_number}/price-tables, GET /projects/{id}/price-tables: the response property data/items/prices/items/price became nullable for the status 200
  • FIX GET /customers/{customer_number}/price-tables, GET /projects/{id}/price-tables: the data/items/start_date response’s property format changed from date-time to date for status 200
  • FIX GET /customers/{customer_number}/price-tables/{id}, GET /projects/{id}/price-tables/{price_table_id}: the response property data/prices/items/price became nullable for the status 200
  • FIX GET /customers/{customer_number}/price-tables/{id}, GET /projects/{id}/price-tables/{price_table_id}: the data/start_date response’s property format changed from date-time to date for status 200
  • FIX GET /invoices: the response property data/items/correction_date became nullable for the status 200
  • FIX GET /invoices: the response property data/items/email_recipient became nullable for the status 200
  • FIX GET /invoices: the response property data/items/email_sent_at became nullable for the status 200
  • FIX GET /invoices: the response property data/items/note became nullable for the status 200
  • FIX GET /invoices/{invoice_number}: the response property data/correction_date became nullable for the status 200
  • FIX GET /invoices/{invoice_number}: the response property data/email_recipient became nullable for the status 200
  • FIX GET /invoices/{invoice_number}: the response property data/email_sent_at became nullable for the status 200
  • FIX GET /invoices/{invoice_number}: the response property data/note became nullable for the status 200
  • FIX GET /plannings: the data/items/from response’s property format changed from date-time to none for status 200
  • FIX GET /plannings: the data/items/to response’s property format changed from date-time to none for status 200
  • FIX GET /projects: the response property data/items/project_status_id became nullable for the status 200
  • FIX GET /projects: the data/items/status/allOf[subschema #1: ProjectStatusResource]/id response’s property type changed from integer to string for status 200
  • FIX POST /projects: the response property data/allOf[subschema #1: ProjectResource]/priceTables/items/prices/items/price became nullable for the status 201
  • FIX POST /projects: the response property data/allOf[subschema #1: ProjectResource]/project_status_id became nullable for the status 201
  • FIX POST /projects: the data/allOf[subschema #1: ProjectResource]/priceTables/items/start_date response’s property format changed from date-time to date for status 201
  • FIX POST /projects: the data/allOf[subschema #1: ProjectResource]/status/allOf[subschema #1: ProjectStatusResource]/id response’s property type changed from integer to string for status 201
  • FIX GET /projects/{id}: the response property data/project_status_id became nullable for the status 200
  • FIX GET /projects/{id}: the data/status/allOf[subschema #1: ProjectStatusResource]/id response’s property type changed from integer to string for status 200
  • FIX PATCH /projects/{id}, PUT /projects/{id}: the response property data/allOf[subschema #1: ProjectResource]/priceTables/items/prices/items/price became nullable for the status 200
  • FIX PATCH /projects/{id}, PUT /projects/{id}: the response property data/allOf[subschema #1: ProjectResource]/project_status_id became nullable for the status 200
  • FIX PATCH /projects/{id}, PUT /projects/{id}: the data/allOf[subschema #1: ProjectResource]/priceTables/items/start_date response’s property format changed from date-time to date for status 200
  • FIX PATCH /projects/{id}, PUT /projects/{id}: the data/allOf[subschema #1: ProjectResource]/status/allOf[subschema #1: ProjectStatusResource]/id response’s property type changed from integer to string for status 200
  • INFO removed the schema Json
  • INFO a breaking change was detected but the version is still 1.0.0
  • NEW GET /absence-reasons, GET /absence-reasons/{name}, GET /absences, GET /absences/{id}, GET /activities, GET /activities/{activity}, GET /articles, GET /articles/{id}, GET /attendances, DELETE /attendances/{id}, GET /attendances/{id}, PATCH /attendances/{id}, PUT /attendances/{id}, GET /categories, GET /categories/{name}, GET /customers, DELETE /customers/{customer_number}, GET /customers/{customer_number}, PATCH /customers/{customer_number}, PUT /customers/{customer_number}, GET /customers/{customer_number}/contacts, DELETE /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/contacts/{id}, PATCH /customers/{customer_number}/contacts/{id}, PUT /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/price-tables, GET /customers/{customer_number}/price-tables/{id}, GET /departments, GET /departments/{id}, GET /departments/{id}/children, GET /departments/{id}/employees, GET /devices, GET /devices/{id}, GET /dynamic-attributes, GET /dynamic-attributes/{id}, GET /employees, GET /employees/{username}, PATCH /employees/{username}, PUT /employees/{username}, GET /employees/{username}/absences, GET /employees/{username}/employment-periods, GET /employees/{username}/employment-periods/{id}, PATCH /employees/{username}/employment-periods/{id}, PUT /employees/{username}/employment-periods/{id}, GET /employees/{username}/internal-rates, GET /employees/{username}/internal-rates/{id}, GET /employees/{username}/meals, GET /employees/{username}/meals/{id}, GET /employees/{username}/projects, GET /employees/{username}/regular-working-times, GET /employees/{username}/regular-working-times/{id}, PATCH /employees/{username}/regular-working-times/{id}, PUT /employees/{username}/regular-working-times/{id}, GET /employees/{username}/transponders, GET /folders, GET /folders/{id}, GET /folders/{id}/documents, GET /folders/{id}/documents/{document_id}, GET /invoice-items, GET /invoice-items/{id}, GET /invoices, GET /invoices/{invoice_number}, GET /invoices/{invoice_number}/attachments, GET /invoices/{invoice_number}/items, GET /location-lists, GET /location-lists/{id}, GET /location-lists/{id}/locations, GET /locations, GET /locations/{name}, GET /offers, GET /offers/{id}, GET /offers/{id}/items, GET /offers/{id}/items/{item_id}, GET /planning, GET /plannings, GET /price-groups, GET /price-groups/{id}, GET /projects, DELETE /projects/{id}, GET /projects/{id}, PATCH /projects/{id}, PUT /projects/{id}, GET /projects/{id}/activities, GET /projects/{id}/employees, GET /projects/{id}/invoice-items, GET /projects/{id}/locations, GET /projects/{id}/price-tables, GET /projects/{id}/price-tables/{price_table_id}, GET /projects/{id}/tasks, DELETE /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}, PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}/employees, GET /projects/{id}/tasks/{task_id}/employees/{project_task_employee_id}, GET /receipts, POST /receipts, GET /receipts-amounts, DELETE /receipts/{id}, GET /receipts/{id}, PATCH /receipts/{id}, PUT /receipts/{id}, GET /receipts/{id}/amounts, GET /receipts/{id}/amounts/{amount_id}, DELETE /receipts/{id}/attachments, GET /receipts/{id}/attachments, PUT /receipts/{id}/attachments, GET /resource-plannings, GET /tickets, POST /tickets, DELETE /tickets/{id}, GET /tickets/{id}, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/attachments, GET /tickets/{id}/subtasks, POST /tickets/{id}/subtasks, DELETE /tickets/{id}/subtasks/{subtask_id}, GET /tickets/{id}/subtasks/{subtask_id}, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}, GET /vehicles, GET /workhour-balances, GET /workhour-balances/{id}: the response header x-ratelimit-limit was added for the status 200
  • NEW GET /absence-reasons, GET /absence-reasons/{name}, GET /absences, GET /absences/{id}, GET /activities, GET /activities/{activity}, GET /articles, GET /articles/{id}, GET /attendances, DELETE /attendances/{id}, GET /attendances/{id}, PATCH /attendances/{id}, PUT /attendances/{id}, GET /categories, GET /categories/{name}, GET /customers, DELETE /customers/{customer_number}, GET /customers/{customer_number}, PATCH /customers/{customer_number}, PUT /customers/{customer_number}, GET /customers/{customer_number}/contacts, DELETE /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/contacts/{id}, PATCH /customers/{customer_number}/contacts/{id}, PUT /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/price-tables, GET /customers/{customer_number}/price-tables/{id}, GET /departments, GET /departments/{id}, GET /departments/{id}/children, GET /departments/{id}/employees, GET /devices, GET /devices/{id}, GET /dynamic-attributes, GET /dynamic-attributes/{id}, GET /employees, GET /employees/{username}, PATCH /employees/{username}, PUT /employees/{username}, GET /employees/{username}/absences, GET /employees/{username}/employment-periods, GET /employees/{username}/employment-periods/{id}, PATCH /employees/{username}/employment-periods/{id}, PUT /employees/{username}/employment-periods/{id}, GET /employees/{username}/internal-rates, GET /employees/{username}/internal-rates/{id}, GET /employees/{username}/meals, GET /employees/{username}/meals/{id}, GET /employees/{username}/projects, GET /employees/{username}/regular-working-times, GET /employees/{username}/regular-working-times/{id}, PATCH /employees/{username}/regular-working-times/{id}, PUT /employees/{username}/regular-working-times/{id}, GET /employees/{username}/transponders, GET /folders, GET /folders/{id}, GET /folders/{id}/documents, GET /folders/{id}/documents/{document_id}, GET /invoice-items, GET /invoice-items/{id}, GET /invoices, GET /invoices/{invoice_number}, GET /invoices/{invoice_number}/attachments, GET /invoices/{invoice_number}/items, GET /location-lists, GET /location-lists/{id}, GET /location-lists/{id}/locations, GET /locations, GET /locations/{name}, GET /offers, GET /offers/{id}, GET /offers/{id}/items, GET /offers/{id}/items/{item_id}, GET /planning, GET /plannings, GET /price-groups, GET /price-groups/{id}, GET /projects, DELETE /projects/{id}, GET /projects/{id}, PATCH /projects/{id}, PUT /projects/{id}, GET /projects/{id}/activities, GET /projects/{id}/employees, GET /projects/{id}/invoice-items, GET /projects/{id}/locations, GET /projects/{id}/price-tables, GET /projects/{id}/price-tables/{price_table_id}, GET /projects/{id}/tasks, DELETE /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}, PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}/employees, GET /projects/{id}/tasks/{task_id}/employees/{project_task_employee_id}, GET /receipts, POST /receipts, GET /receipts-amounts, DELETE /receipts/{id}, GET /receipts/{id}, PATCH /receipts/{id}, PUT /receipts/{id}, GET /receipts/{id}/amounts, GET /receipts/{id}/amounts/{amount_id}, DELETE /receipts/{id}/attachments, GET /receipts/{id}/attachments, PUT /receipts/{id}/attachments, GET /resource-plannings, GET /tickets, POST /tickets, DELETE /tickets/{id}, GET /tickets/{id}, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/attachments, GET /tickets/{id}/subtasks, POST /tickets/{id}/subtasks, DELETE /tickets/{id}/subtasks/{subtask_id}, GET /tickets/{id}/subtasks/{subtask_id}, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}, GET /vehicles, GET /workhour-balances, GET /workhour-balances/{id}: the response header x-ratelimit-remaining was added for the status 200
  • NEW GET /absence-reasons, GET /absence-reasons/{name}, GET /absences, POST /absences, GET /absences/{id}, GET /activities, GET /activities/{activity}, GET /articles, GET /articles/{id}, GET /attendances, POST /attendances, DELETE /attendances/{id}, GET /attendances/{id}, PATCH /attendances/{id}, PUT /attendances/{id}, GET /categories, GET /categories/{name}, GET /customers, POST /customers, DELETE /customers/{customer_number}, GET /customers/{customer_number}, PATCH /customers/{customer_number}, PUT /customers/{customer_number}, GET /customers/{customer_number}/contacts, POST /customers/{customer_number}/contacts, DELETE /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/contacts/{id}, PATCH /customers/{customer_number}/contacts/{id}, PUT /customers/{customer_number}/contacts/{id}, GET /customers/{customer_number}/price-tables, GET /customers/{customer_number}/price-tables/{id}, GET /departments, GET /departments/{id}, GET /departments/{id}/children, GET /departments/{id}/employees, GET /devices, GET /devices/{id}, GET /dynamic-attributes, GET /dynamic-attributes/{id}, GET /employees, POST /employees, GET /employees/{username}, PATCH /employees/{username}, PUT /employees/{username}, GET /employees/{username}/absences, GET /employees/{username}/employment-periods, POST /employees/{username}/employment-periods, GET /employees/{username}/employment-periods/{id}, PATCH /employees/{username}/employment-periods/{id}, PUT /employees/{username}/employment-periods/{id}, GET /employees/{username}/internal-rates, GET /employees/{username}/internal-rates/{id}, GET /employees/{username}/meals, GET /employees/{username}/meals/{id}, GET /employees/{username}/projects, GET /employees/{username}/regular-working-times, POST /employees/{username}/regular-working-times, GET /employees/{username}/regular-working-times/{id}, PATCH /employees/{username}/regular-working-times/{id}, PUT /employees/{username}/regular-working-times/{id}, GET /employees/{username}/transponders, GET /folders, GET /folders/{id}, GET /folders/{id}/documents, GET /folders/{id}/documents/{document_id}, GET /invoice-items, GET /invoice-items/{id}, GET /invoices, GET /invoices/{invoice_number}, GET /invoices/{invoice_number}/attachments, GET /invoices/{invoice_number}/items, GET /location-lists, GET /location-lists/{id}, GET /location-lists/{id}/locations, GET /locations, GET /locations/{name}, GET /offers, GET /offers/{id}, GET /offers/{id}/items, GET /offers/{id}/items/{item_id}, GET /planning, GET /plannings, GET /price-groups, GET /price-groups/{id}, GET /projects, POST /projects, DELETE /projects/{id}, GET /projects/{id}, PATCH /projects/{id}, PUT /projects/{id}, GET /projects/{id}/activities, GET /projects/{id}/employees, GET /projects/{id}/invoice-items, GET /projects/{id}/locations, GET /projects/{id}/price-tables, GET /projects/{id}/price-tables/{price_table_id}, GET /projects/{id}/tasks, POST /projects/{id}/tasks, DELETE /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}, PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}, GET /projects/{id}/tasks/{task_id}/employees, GET /projects/{id}/tasks/{task_id}/employees/{project_task_employee_id}, GET /receipts, POST /receipts, GET /receipts-amounts, DELETE /receipts/{id}, GET /receipts/{id}, PATCH /receipts/{id}, PUT /receipts/{id}, GET /receipts/{id}/amounts, GET /receipts/{id}/amounts/{amount_id}, DELETE /receipts/{id}/attachments, GET /receipts/{id}/attachments, PUT /receipts/{id}/attachments, GET /resource-plannings, GET /tickets, POST /tickets, DELETE /tickets/{id}, GET /tickets/{id}, PATCH /tickets/{id}, PUT /tickets/{id}, POST /tickets/{id}/attachments, GET /tickets/{id}/subtasks, POST /tickets/{id}/subtasks, DELETE /tickets/{id}/subtasks/{subtask_id}, GET /tickets/{id}/subtasks/{subtask_id}, PATCH /tickets/{id}/subtasks/{subtask_id}, PUT /tickets/{id}/subtasks/{subtask_id}, GET /vehicles, GET /workhour-balances, GET /workhour-balances/{id}: added the non-success response with the status 429
  • INFO POST /absences: removed subschema #1, subschema #2 from the response body anyOf list for the response status 201
  • INFO POST /absences: the response’s body type was narrowed from any to object for status 201
  • NEW POST /absences, POST /attendances, POST /customers, POST /customers/{customer_number}/contacts, POST /employees, POST /employees/{username}/employment-periods, POST /employees/{username}/regular-working-times, POST /projects, POST /projects/{id}/tasks: the response header x-ratelimit-limit was added for the status 201
  • NEW POST /absences, POST /attendances, POST /customers, POST /customers/{customer_number}/contacts, POST /employees, POST /employees/{username}/employment-periods, POST /employees/{username}/regular-working-times, POST /projects, POST /projects/{id}/tasks: the response header x-ratelimit-remaining was added for the status 201
  • NEW POST /absences: added the non-success response with the status 502
  • NEW POST /absences: added the optional property code to the response with the 422 status
  • NEW POST /absences: added the optional property status to the response with the 422 status
  • NEW POST /absences: added the required property data to the response with the 201 status
  • INFO GET /attendances: the data/items/end_date response’s property format was narrowed from none to date for status 200
  • INFO POST /attendances: the data/end_date response’s property format was narrowed from none to date for status 201
  • INFO GET /attendances/{id}, PATCH /attendances/{id}, PUT /attendances/{id}: the data/end_date response’s property format was narrowed from none to date for status 200
  • INFO GET /departments, GET /departments/{id}/children: the data/items/id response’s property type was narrowed from any to integer for status 200
  • INFO GET /departments/{id}: the data/id response’s property type was narrowed from any to integer for status 200
  • NEW GET /departments/{id}/employees, GET /employees: added the optional property data/items/employment_periods to the response with the 200 status
  • NEW GET /departments/{id}/employees, GET /employees: added the optional property data/items/internal_rates to the response with the 200 status
  • NEW GET /departments/{id}/employees, GET /employees: added the optional property data/items/regular_working_times to the response with the 200 status
  • INFO GET /departments/{id}/employees, GET /employees: removed the “ enum value from the data/items/salutation/name response property for the response status 200
  • INFO GET /departments/{id}/employees, GET /employees: removed the Frau enum value from the data/items/salutation/name response property for the response status 200
  • INFO GET /departments/{id}/employees, GET /employees: removed the Herr enum value from the data/items/salutation/name response property for the response status 200
  • NEW GET /departments/{id}/employees, GET /employees: added the required property data/items/cost_center to the response with the 200 status
  • NEW GET /departments/{id}/employees, GET /employees, GET /employees/{username}/projects, GET /projects/{id}/employees: added the required property data/items/note to the response with the 200 status
  • NEW GET /departments/{id}/employees, GET /employees: added the required property data/items/overtime_ads to the response with the 200 status
  • NEW GET /employees, GET /employees/{username}, GET /invoices: added the new optional query request parameter include
  • NEW POST /employees: added the optional property data/allOf[subschema #1: EmployeeResource]/employment_periods to the response with the 201 status
  • NEW POST /employees: added the optional property data/allOf[subschema #1: EmployeeResource]/internal_rates to the response with the 201 status
  • NEW POST /employees: added the optional property data/allOf[subschema #1: EmployeeResource]/regular_working_times to the response with the 201 status
  • INFO POST /employees: removed the “ enum value from the data/allOf[subschema #1: EmployeeResource]/salutation/name response property for the response status 201
  • INFO POST /employees: removed the Frau enum value from the data/allOf[subschema #1: EmployeeResource]/salutation/name response property for the response status 201
  • INFO POST /employees: removed the Herr enum value from the data/allOf[subschema #1: EmployeeResource]/salutation/name response property for the response status 201
  • NEW POST /employees: added the required property data/allOf[subschema #1: EmployeeResource]/cost_center to the response with the 201 status
  • NEW POST /employees: added the required property data/allOf[subschema #1: EmployeeResource]/note to the response with the 201 status
  • NEW POST /employees: added the required property data/allOf[subschema #1: EmployeeResource]/overtime_ads to the response with the 201 status
  • NEW GET /employees/{username}, GET /employees/{username}/employment-periods, GET /employees/{username}/internal-rates, GET /employees/{username}/regular-working-times: added the non-success response with the status 422
  • NEW GET /employees/{username}: added the optional property data/employment_periods to the response with the 200 status
  • NEW GET /employees/{username}: added the optional property data/internal_rates to the response with the 200 status
  • NEW GET /employees/{username}: added the optional property data/regular_working_times to the response with the 200 status
  • INFO GET /employees/{username}: removed the “ enum value from the data/salutation/name response property for the response status 200
  • INFO GET /employees/{username}: removed the Frau enum value from the data/salutation/name response property for the response status 200
  • INFO GET /employees/{username}: removed the Herr enum value from the data/salutation/name response property for the response status 200
  • NEW GET /employees/{username}: added the required property data/cost_center to the response with the 200 status
  • NEW GET /employees/{username}: added the required property data/note to the response with the 200 status
  • NEW GET /employees/{username}: added the required property data/overtime_ads to the response with the 200 status
  • NEW PATCH /employees/{username}, PUT /employees/{username}: added the optional property data/allOf[subschema #1: EmployeeResource]/employment_periods to the response with the 200 status
  • NEW PATCH /employees/{username}, PUT /employees/{username}: added the optional property data/allOf[subschema #1: EmployeeResource]/internal_rates to the response with the 200 status
  • NEW PATCH /employees/{username}, PUT /employees/{username}: added the optional property data/allOf[subschema #1: EmployeeResource]/regular_working_times to the response with the 200 status
  • INFO PATCH /employees/{username}, PUT /employees/{username}: removed the “ enum value from the data/allOf[subschema #1: EmployeeResource]/salutation/name response property for the response status 200
  • INFO PATCH /employees/{username}, PUT /employees/{username}: removed the Frau enum value from the data/allOf[subschema #1: EmployeeResource]/salutation/name response property for the response status 200
  • INFO PATCH /employees/{username}, PUT /employees/{username}: removed the Herr enum value from the data/allOf[subschema #1: EmployeeResource]/salutation/name response property for the response status 200
  • NEW PATCH /employees/{username}, PUT /employees/{username}: added the required property data/allOf[subschema #1: EmployeeResource]/cost_center to the response with the 200 status
  • NEW PATCH /employees/{username}, PUT /employees/{username}: added the required property data/allOf[subschema #1: EmployeeResource]/note to the response with the 200 status
  • NEW PATCH /employees/{username}, PUT /employees/{username}: added the required property data/allOf[subschema #1: EmployeeResource]/overtime_ads to the response with the 200 status
  • NEW GET /employees/{username}/employment-periods, GET /employees/{username}/internal-rates, GET /employees/{username}/regular-working-times: added the new optional query request parameter limit
  • INFO GET /employees/{username}/projects, GET /folders/{id}/documents, GET /projects/{id}/employees: removed subschema #1, subschema #2 from the data/items/ response property anyOf list for the response status 200
  • INFO GET /employees/{username}/projects, GET /folders/{id}/documents, GET /projects/{id}/employees: the data/items/ response’s property type was narrowed from any to object for status 200
  • NEW GET /employees/{username}/projects, GET /projects/{id}/employees: added the required property data/items/availability to the response with the 200 status
  • NEW GET /employees/{username}/projects, GET /projects/{id}/employees: added the required property data/items/employee_id to the response with the 200 status
  • NEW GET /employees/{username}/projects, GET /projects/{id}/employees: added the required property data/items/from to the response with the 200 status
  • NEW GET /employees/{username}/projects, GET /folders/{id}/documents, GET /projects/{id}/employees: added the required property data/items/id to the response with the 200 status
  • NEW GET /employees/{username}/projects, GET /projects/{id}/employees: added the required property data/items/internal_rate to the response with the 200 status
  • NEW GET /employees/{username}/projects, GET /projects/{id}/employees: added the required property data/items/priceGroup to the response with the 200 status
  • NEW GET /employees/{username}/projects, GET /projects/{id}/employees: added the required property data/items/project_id to the response with the 200 status
  • NEW GET /employees/{username}/projects, GET /projects/{id}/employees: added the required property data/items/project_number to the response with the 200 status
  • NEW GET /employees/{username}/projects, GET /projects/{id}/employees: added the required property data/items/rate_type to the response with the 200 status
  • NEW GET /employees/{username}/projects, GET /projects/{id}/employees: added the required property data/items/to to the response with the 200 status
  • NEW GET /employees/{username}/projects, GET /projects/{id}/employees: added the required property data/items/type to the response with the 200 status
  • NEW GET /folders/{id}/documents: added the required property data/items/file_contents to the response with the 200 status
  • NEW GET /folders/{id}/documents: added the required property data/items/file_type to the response with the 200 status
  • NEW GET /folders/{id}/documents: added the required property data/items/filename to the response with the 200 status
  • INFO GET /folders/{id}/documents/{document_id}: removed subschema #1, subschema #2 from the data response property anyOf list for the response status 200
  • INFO GET /folders/{id}/documents/{document_id}: the data response’s property type was narrowed from any to object for status 200
  • NEW GET /folders/{id}/documents/{document_id}: added the required property data/file_contents to the response with the 200 status
  • NEW GET /folders/{id}/documents/{document_id}: added the required property data/file_type to the response with the 200 status
  • NEW GET /folders/{id}/documents/{document_id}: added the required property data/filename to the response with the 200 status
  • NEW GET /folders/{id}/documents/{document_id}: added the required property data/id to the response with the 200 status
  • NEW GET /invoices: added the new optional query request parameter end_date
  • NEW GET /invoices: added the new optional query request parameter modified_after
  • NEW GET /invoices: added the new optional query request parameter modified_before
  • NEW GET /invoices: added the new optional query request parameter start_date
  • NEW GET /invoices: added the optional property data/items/items to the response with the 200 status
  • NEW GET /invoices/{invoice_number}: added the optional property data/items to the response with the 200 status
  • NEW GET /plannings: added the optional property data/items/planning_details/effective_hours to the response with the 200 status
  • NEW GET /plannings: added the optional property data/items/planning_details/from_time to the response with the 200 status
  • NEW GET /plannings: added the optional property data/items/planning_details/to_time to the response with the 200 status
  • INFO GET /plannings: removed subschema #1, subschema #2 from the data/items/planning_details response property anyOf list for the response status 200
  • INFO GET /plannings: the data/items/planning_details response’s property type was narrowed from any to object for status 200
  • NEW GET /plannings: added the required property data/items/planning_details/type to the response with the 200 status
  • NEW GET /plannings: added the required property data/items/planning_details/unit to the response with the 200 status
  • NEW GET /plannings: added the required property data/items/planning_details/value to the response with the 200 status
  • NEW GET /project-employees: endpoint added
  • INFO GET /projects: the data/items/keywords/items/ response’s property type was narrowed from any to string for status 200
  • INFO POST /projects: the data/allOf[subschema #1: ProjectResource]/keywords/items/ response’s property type was narrowed from any to string for status 201
  • INFO GET /projects/{id}: the data/keywords/items/ response’s property type was narrowed from any to string for status 200
  • INFO PATCH /projects/{id}, PUT /projects/{id}: the data/allOf[subschema #1: ProjectResource]/keywords/items/ response’s property type was narrowed from any to string for status 200
  • NEW GET /projects/{id}/tasks: added the required property data/items/all_project_employees to the response with the 200 status
  • NEW POST /projects/{id}/tasks: added the required property data/allOf[subschema #1: ProjectTaskResource]/all_project_employees to the response with the 201 status
  • NEW GET /projects/{id}/tasks/{task_id}: added the required property data/all_project_employees to the response with the 200 status
  • NEW PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}: added the required property data/allOf[subschema #1: ProjectTaskResource]/all_project_employees to the response with the 200 status
  • INFO GET /projects/{id}/tasks/{task_id}/employees: the data/items/from response’s property format was narrowed from none to date for status 200
  • INFO GET /projects/{id}/tasks/{task_id}/employees: the data/items/to response’s property format was narrowed from none to date for status 200
  • INFO GET /projects/{id}/tasks/{task_id}/employees/{project_task_employee_id}: the data/from response’s property format was narrowed from none to date for status 200
  • INFO GET /projects/{id}/tasks/{task_id}/employees/{project_task_employee_id}: the data/to response’s property format was narrowed from none to date for status 200

v8.0.27 · OpenAPI 1.0.0 · 22.10.2026

Search combines with the other filters: GET /projects, GET /projects/{id}/tasks

search matches the name or the description, and both now apply together with the other filters (project, status, …). Before, a match on the description or name bypassed them, so GET /projects/12/tasks?search=meeting also returned tasks of other projects. No contract change.

v8.0.24 · OpenAPI 1.0.0 · 22.10.2026

Contacts without primary: POST /customers/{customer_number}/contacts, PUT/PATCH /customers/{customer_number}/contacts/{id}

Creating a contact with primary set to null answered 500. A contact created without primary — null or left out — now becomes the customer’s primary contact when the customer has none yet, and a secondary one otherwise, as in ZEP; before, a left-out primary was stored empty and read back as null. Updating with primary: null keeps the contact’s current value instead of clearing it. No contract change.

Error body when ZEP rejects a write: POST /receipts, PUT/PATCH /receipts/{id}, POST /tickets, PUT/PATCH /tickets/{id}, POST /tickets/{id}/subtasks, PUT/PATCH /tickets/{id}/subtasks/{subtask_id}

When ZEP rejected the write without an error text, these endpoints answered a bare 500 instead of the documented {"success": false, "message": …}. They now always answer with that body: message is ZEP’s text, or “The request could not be processed.” when ZEP sent none. The status stays 500. No contract change.

Project billability and billing type on update: PUT/PATCH /projects/{project}

default_billability: null answered 500. It now keeps the project’s current default billability, the same as leaving the field out. An unknown value (99, "foo", {"id": 99}) for default_billability also answered 500; for billing_type and receipts_billability it was accepted and cleared the field. All three now reject it with 422 and a validation error on the field. No contract change.

v8.0.17 · OpenAPI 1.0.0 · 13.10.2026

Vehicles: GET /vehicles

Lists the vehicles of one vehicle list; the id is the short name that attendances carry as vehicle_id. Vehicles live in dated lists; the list valid on date (YYYY-MM-DD, default today) is the one with the latest start date on or before it. Before the first list the answer is empty. Paginated with limit, read-only. Not available on ZEP Clock.

Invoice creator: GET /invoices, GET /invoices/{invoice}

Each invoice now carries creator_username, the username of the employee who created the invoice document — the employee ZEP shows on the invoice. After a correction it is the employee who corrected the invoice; null when no invoice document is stored.

Attendances accept the vehicle short name: POST /attendances, PATCH /attendances/{id}

vehicle_id is the vehicle’s short name (as GET already returned it, e.g. PKW), a string of at most 32 characters. Requests rejected it as “must be a number”; a number only ever worked for numeric short names and still does (it is read as the short name), send the short name as a string.

The vehicle_id type change is listed as a fix, not as a breaking change: the request never accepted a vehicle before (every value was rejected), so no working integration depends on the old type. A number that matches a numeric short name is still accepted.

All single changes (5)
  • FIX POST /attendances, PATCH /attendances/{id}, PUT /attendances/{id}: the vehicle_id request property type changed from number, null to string, null
  • INFO POST /attendances, PATCH /attendances/{id}, PUT /attendances/{id}: the vehicle_id request property’s maxLength was set to 32
  • NEW GET /invoices: added the required property data/items/creator_username to the response with the 200 status
  • NEW GET /invoices/{invoice_number}: added the required property data/creator_username to the response with the 200 status
  • NEW GET /vehicles: endpoint added

v8.0.15 · OpenAPI 1.0.0 · 12.10.2026

Task description limited to 255 characters: POST /projects/{id}/tasks, PUT/PATCH /projects/{id}/tasks/{task_id}

A description longer than 255 characters answered 500, because the task’s description holds at most 255. It is now rejected with 422 and a validation error on description, and the request schema declares maxLength: 255.

All single changes (1)
  • INFO POST /projects/{id}/tasks, PATCH /projects/{id}/tasks/{task_id}, PUT /projects/{id}/tasks/{task_id}: the description request property’s maxLength was set to 255

v8.0.11 · OpenAPI 1.0.0 · 10.10.2026

List endpoints sort by orderBy and order

Most list endpoints accepted both parameters and ignored them, so GET /offers?orderBy=status came back in id order. Every list endpoint that documents them now sorts by the record’s key, its writable fields or created/modified, named as in the response (status, name, valid_until, …), order asc or desc. Records with the same value follow in key order (resource plannings: start date, employee, id), so paging stays stable, and links keep the sort. Any other orderBy value sorts by the default, the key (name for locations, the start date for resource plannings); before, it answered 500 on the location, location list and dynamic attribute definition lists. GET /plannings keeps its date order, and GET /projects/{project}/employees its own. No contract change.

v8.0.10 · OpenAPI 1.0.0 · 06.10.2026

GET /resource-plannings lists the plannings of the resource planning: date range, unit (percent or hours per day) and value, plus the planned hours per calendar month and in total. Filterable by date_from/date_to, employee_ids[], project_ids[], customer_numbers[] and modified_after/modified_before. Only with the resource planning module (MOD_PLANNING_NEXT, or product line 4 without MOD_RESSOURCENPLANUNG); other tenants get 404. GET /plannings is unchanged.

All single changes (1)
  • NEW GET /resource-plannings: endpoint added

v8.0.9 · OpenAPI 1.0.0 · 06.10.2026

The REST API is available on every ZEP product line (Produktwelt 2026) without the separate MOD_SOAP module; tenants on a product line received 404 before. Legacy licences still need MOD_SOAP. The contract itself did not change.

v8.0.7 · OpenAPI 1.0.0 · 25.09.2026 — the generated specification becomes authoritative

  • INFO The OpenAPI document is now generated from the code (controllers, form requests, resources) on every release and published here unchanged — the same file the interactive reference renders. Descriptions live next to the field they describe and cannot drift any more.
  • INFO Version scheme: info.version is 1.0.0 and follows the contract from now on. The previous numbers (7.12.49 and earlier) mirrored the ZEP product version.
  • INFO Every reference page in this documentation (and this navigation) is generated from the specification, in English and German. The response examples are the field examples of the specification.
  • INFO A separate specification for ZEP Clock is published alongside the full version; the reference page offers a switch, and every endpoint page states whether it is available on a Clock instance.
  • NEW All resource update operations accept PUT as an alias of PATCH — the router always did, the documentation now says so.
  • DEPRECATED GET Planning (legacy alias): GET /planning redirects to GET /plannings and answers with Deprecation, Sunset (2027-08-31) and Link headers. It will be removed on or after 2027-08-31.
  • DEPRECATED Customers: the status object carries deprecated: true and x-sunset: 2027-08-31 in the specification. Read inactive instead; status is not part of API v2.
  • FIX Stricter input validation, for requests that did not return a usable result before: POST /attendances, PATCH /attendances/{id} and PUT /attendances/{id} take date as YYYY-MM-DD only (a time component ended in a server error, 500); GET /departments rejects an empty start_date or end_date (it never produced a correct filter). Both now answer 422; clients that already send plain dates are not affected.
  • FIX Path parameters are named after the key the API resolves by: /absence-reasons/{name}, /activities/{activity}, /categories/{name}, /customers/{customer_number}/contacts/{id}, /invoices/{invoice_number}. Numeric ids never worked there; the documentation used to say otherwise.
  • FIX created and modified are documented on every resource instead of created_at / updated_at, which the API never returned.
  • FIX Regular working times expose holidayCalendar and breakRegulationType with the English field names the API always returned (name, note, country, region), not the German column names the old document listed.
  • FIX Nullability and required-ness of every response field match the real responses (measured against a running instance), and the status[] filter of the invoice item endpoints declares its values as integers.

v7.12.49 (24.07.2026)

Covers everything since v7.12 (22.06.2026).

  • FIX POST Create attendance: The booking rules are now checked before writing, and violations come back as 422 with per-field messages — closed month, past the approval date, recording period, non-working day or holiday, employment period, runtime of the project, task or ticket, planned hours exceeded. The API was the only entry point that accepted such bookings; the web interface, SOAP and Clock have always refused them. If you book validly, nothing changes for you.
  • FIX Attendances: A booking ending at 00:00 belongs to the following day. That rollover is now part of the overlap check, so double bookings across the day boundary are detected and refused.
  • FIX GET Customers: status stays and now reports the actual state. Previously an inactive customer came back as { "value": 1, "label": "Active" }, although the documentation always said 1 = active. Nothing changes for active customers; if your client compensated for the inversion, drop that compensation.
  • DEPRECATED Customers: inactive (boolean) supersedes status. status is still emitted and still accepted on POST and PATCH; if both are sent, inactive wins. The ?status= filter is deprecated as well, replaced by ?inactive=. A sunset date will be announced separately.
  • NEW PATCH Update attendance
  • NEW DELETE Delete attendance: Validates the lock periods — closed month, approval date, recording period
  • NEW POST Create customer contact
  • NEW GET Get customer contact
  • NEW PATCH Update customer contact
  • NEW DELETE Delete customer contact
  • NEW PATCH Update project task
  • NEW Attendances: end_date on every response — the calendar day the booking ends on. to alone is ambiguous for a day-end booking, which is stored as to = 00:00:00 on the start date.
  • NEW Customer contacts: department and categories on the response
  • NEW The modified_after and modified_before filters on several list endpoints
  • NEW Languages sk (Slovak) and tr (Turkish)
  • FIX An empty date filter returns 422 instead of 500 — on Absences and five further endpoints
  • FIX Employees whose employment period has no start or end date are no longer rejected as “outside the employment period”. An absent bound now means open-ended.
  • FIX default_billability and receipts_billability are no longer ignored on POST and PATCH
  • FIX Planning: The configured defaults are returned
  • INFO Nine operations that already existed are now documented — among them POST /absences, GET /attendances/:id and PATCH /employees/:username. Plus 66 response fields the endpoints always returned, and two relation keys on regular working times that never matched their documented names.

v7.12 (22.06.2026)

v7.8.74 (09.01.2026)

v7.8.64 (2026-01-07)

v7.7.0 (2025-10-07)

  • NEW GET Articles: Added endpoint for retrieving articles
  • NEW GET Article details: Added endpoint for single article
  • NEW GET Planning: Added endpoint for retrieving planning entries
  • NEW GET Project locations: Added endpoint for project locations
  • NEW PUT Update employee: Added endpoint for updating employees
  • NEW PUT Update employment period: Added endpoint for updating employment periods
  • FIX Corrected plan_can_exceed data type from boolean to enum (0-4) in all project endpoints
  • FIX Added missing filter parameters (project_status, project_start_date, project_end_date) for Employee projects
  • FIX Added missing id field in ProjectEmployee response examples

v7.6.1 (2025-09-22)

v7.4.2 (2025-06-24)

  • NEW GET Attendances: Added new fields project_release, project_released_at and project_released_by for project time approval
  • NEW GET Attendance details: Added new fields for project time approval

v7.4.1 (2025-06-18)

  • INFO OpenAPI specification updated to include all documented endpoints
  • NEW POST Create employee
  • FIX GET Absences: Updated response examples to match current API structure, including new fields absence_reason_id, absenceReason object, and corrected date formats
  • FIX GET Attendances: Updated response examples to match current API structure and date/time formats
  • NEW GET Attendance details: Added documentation for single attendance endpoint
  • FIX GET Departments: Updated response examples with new fields parent_id, manager_count, children_count
  • FIX GET Department details: Updated response structure with manager array instead of manager_count
  • FIX GET Department employees: Updated response examples with new field approval_date and language object structure
  • FIX GET Employees: Added new fields categories and dynamicAttributes arrays, changed release_date to approval_date
  • NEW GET Employee transponders: Added documentation for retrieving RFID transponders assigned to an employee
  • FIX GET Devices: Updated response examples to match current API structure with device types and status codes
  • FIX GET Device details: Updated response structure showing employees and categories arrays
  • FIX GET Customers: Updated response structure with new fields vat (replacing tax), status as object, department_id, categories and dynamicAttributes arrays
  • FIX GET Customer details: Updated response with new address fields, removed employees array, added complete priceTables structure
  • FIX GET Offers: Updated response examples and added missing field order_probability_percent
  • NEW GET Offer items: Added documentation for retrieving offer items/positions
  • FIX GET Receipts: Updated response structure with simplified receipt_type_id as string instead of object, changed field names is_amount_gross_or_net to is_amount_net and is_invoice_amount_gross_or_net to is_invoice_amount_net
  • FIX GET Receipt details: Updated response structure to match list endpoint with same field changes
  • FIX GET Receipt amounts: Updated response examples with realistic data and added new fields is_amount_net and is_invoice_amount_net
  • FIX GET Receipt attachments: Added response example with Base64-encoded file contents
  • FIX GET Tickets: Fixed response examples - incorrectly contained receipt data instead of ticket data, added categories array
  • FIX GET Ticket details: Updated response example with current data
  • FIX GET Ticket subtasks: Updated response example with realistic data
  • FIX GET Ticket subtask details: Updated response example with anonymized data
  • NEW GET Folders: Added new endpoint for retrieving folders
  • NEW GET Folder documents: Added new endpoint for retrieving documents within a folder
  • NEW GET Price groups: Added new endpoint for retrieving price groups
  • NEW GET Activities: Added new endpoint for retrieving activities
  • NEW GET Absence reasons: Added new endpoint for retrieving absence reasons
  • NEW GET Categories: Added new endpoint for retrieving categories

v7.4.0 (2025-06-17)

  • NEW Major version update with enhanced API capabilities
  • INFO Updated API documentation and improved endpoint descriptions

v6.13.17 (2024-09-16)

v6.13.16 (2024-08-27)

v6.12.5 (2024-03-06)

  • The rate limiting has been increased to 12000 requests per hour. A maximum of 1000 requests are allowed per 5 minutes
  • Added name parameter to project filter for Projects
  • Bugfix for Projects: The plan_hours value did not show planned hours if they were defined in subtasks. The value plan_hours_children has been added for this purpose
  • Bugfix for Projects: The project does not have to be completely within a filtered period. It is sufficient if it was active within the period
  • Bugfix for Employees: Under certain circumstances, a server error occurred. This error has been fixed

v6.12.4 (2024-03-01)

  • Some performance improvements

v6.12.3 (2024-02-16)

v6.12.2 (2024-02-02)

v6.12.1 (2024-01-14)