Create a deduction entry for an employee

Creates a new deduction table entry for the employee. On success, returns the new entry id. The combination of effectiveDate and deduction must be unique per employee; duplicate pairs are rejected. Creating or updating entries may also sync current deduction amounts onto derived employee fields such as payroll.deduction.<Type>.amount (employee fields you can fetch with the People search endpoint).

To read deduction rows, use List deduction entries for a list of employees (there is no per-employee GET).

Required permissions: People's Data > Payroll > Manage selected employees' Payroll sections (or Deduction table Manage when field-level permissions are enabled).

Path Params
string
required

Employee ID.

Body Params

Values for the deduction entry you want to add.

Request body for creating or updating a deduction entry. Do not send id; the system assigns it on create. On update, identify the row with the path {entry_id}. The combination of effectiveDate and deduction must be unique per employee; duplicate pairs are rejected.

date
required

Start of this timeline step (ISO 8601 date). Together with deduction, forms a unique key per employee for each row.

string
required

Deduction type name from the company deduction type list (for example Childcare vouchers or Health insurance). To list available values, call the Get company list by name endpoint with list name deductionType.

amount
object
required
date

Optional explicit end date for this deduction period (ISO 8601 date).

Response

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json