Sign in
latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Company

employee deductions

Returns a list of paginated employee deductions for the company.<p>Scopes: export_payroll</p>

get/v{version}/companies/{id}/deductions

Path parameters

idstring required

The id of the company.

versionstring required

Query parameters

pay_group_idstring

The pay group to filter by. Optional.

employee_idstring

Filters deductions to a specific employee. Optional.

employee_start_idstring

The employee id to start with. Optional.

employee_limitinteger

Limits the number of employees returned. Optional. The default is 50 and the maximum value is 250.

Response

OK

next_idstring

The id of the object next up after this set.

errorstring

Contains any error messages, if applicable.

Example response

{
  "data": [
    {
      "start_date": "yyyy-MM-dd",
      "end_date": "yyyy-MM-dd"
    }
  ]
}