Set a worker's leave balance

Set a worker's balance for one leave type to the number of hours you send, like when you're loading balances from another system. The difference from the current balance is recorded as a manual adjustment. The response is 404 if the worker isn't enrolled in a policy, or their policy doesn't have a leave type with that pay code. Unlimited leave types have no balance and return 422. See the Guide to the Leave Accrual API.

Path Params
string
required

The externalWorkerId you assigned to the worker, or Everee's generated workerId if you don't use your own IDs.

string
required

The pay code apiKey of the leave type, like TIME_OFF_TYPE_VACATION.

Body Params
number
required

The balance the worker should have, in hours, with at most 2 decimal places.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json