Sign in
latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Employee

wages

This endpoint can be used to create or update a wage for an employee. Start dates and categories must be unique per employee.<p>Scopes: update_employee</p>

post/v{version}/employees/{employee_id}/wages

Path parameters

employee_idstring required

The employee id that the wage is for.

versionstring required

Request body

type'Salary' | 'Hourly' required

The type that matches the amount for the wage.

amountnumber double required

The amount that matches the type for the wage.

start_datestring required

The start date of the wage, inclusive.

end_datestring

The end date of the wage, inclusive.

reasonstring

An optional reason or comment for the wage.

category'Compensation' | 'Base + Bonus' | 'Base + Commission' | 'Base + Bonus + Commission' | 'Annual Contract' | 'W2 1 Year Average' | 'W2 2 Year Average' | 'W2 3 Year Average' | 'Custom'

Category for the wage.

Example request

{
  "start_date": "yyyy-MM-dd",
  "end_date": "yyyy-MM-dd"
}

Response

No Content