API Reference
  1. Leave Accrual API

Create a leave type

post
https://api.everee.com/integration/v1/leave/types

Create a leave type, like "Jury Duty" or "Bereavement". A pay code is created for the type at the same time, and returned as payCode, so you can use it to pay leave hours of this type. The name must be unique, ignoring case, and can't match a system default type. Pass state to create a leave type that accrues only on wages in that state, like "Sick (WI)". See the Guide to the Leave Accrual API.

Body Params
string
required
length between 3 and 100

A name for the leave type. Leading and trailing spaces are removed and runs of spaces are collapsed to one. Must be from 3 to 100 characters after that (at most 95 when state is set, since the state suffix counts toward the limit), and unique among the company's leave types, ignoring case.

boolean
required

Whether to show the leave type on pay stubs even when the worker has no leave hours of this type on the stub.

string

Optional two-letter state code. When set, the leave type accrues only on wages in that state and is named <leaveTypeName> (<state>), so "Sick" with WI becomes "Sick (WI)". Omit it for a leave type that applies to all states. Not available to every company yet.

Responses

Updated 13 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 13 days ago

Did this page help you?