Create a payroll calendar

post

https://api.everee.com/integration/v1/payroll-calendar

Create a payroll calendar that takes effect on a future date. The start day fields you need depend on the payPeriodType: weeklyStartDay for WEEKLY and BI_WEEKLY, and monthlyStartDay for SEMI_MONTHLY and MONTHLY. The effectiveDate must be tomorrow or later, and the displayName must not match another active calendar. See the Guide to the Payroll Calendar API for details.

Body Params

displayName

string

required

length ≤ 255

A name for the calendar. Must be unique among the company's active payroll calendars, ignoring case.

payPeriodType

string

enum

required

How often pay periods occur.

Allowed:

weeklyStartDay

string

enum

The day of the week pay periods start. Required for WEEKLY and BI_WEEKLY, and not allowed for other types.

Allowed:

monthlyStartDay

integer

1 to 28

The day of the month pay periods start. Required for SEMI_MONTHLY and MONTHLY, and not allowed for other types. From 1 to 13 for SEMI_MONTHLY (the second pay period of the month starts 15 days later), or 1 to 28 for MONTHLY.

effectiveDate

date

required

The date the calendar takes effect. Must be tomorrow or later.

Responses

201The new payroll calendar.

409An active payroll calendar with that name already exists.

422The request body was invalid. For example: a start day is missing, provided for a pay period type it doesn't apply to, or out of range; payPeriodType isn't one that can be created through the API; displayName is blank; or effectiveDate isn't tomorrow or later.