Set the target go-live date

Set, move or clear the date you want a company to go live.

Use this endpoint to tell Everee the date you want a company to go live: the first day of the first pay period you want Everee to pay. Everee plans the company's setup around it and sets the real go-live date. Send null to clear it. While the company is a draft you can also send it with Update payroll profile.

📘

Part of Submission and status. For how this fits into going live, see the guide: Payroll history and going live.

Request

FieldNotes
targetGoLiveDateThe date, or null to clear it. It must be tomorrow or later and the first day of a pay period. See Which dates are accepted.
payrollCalendarIdOptional. The payroll calendar to check the date against. Required when the company has more than one payroll calendar and no default.

The response is the company's go-live status, with the new target.

Errors

StatusMeaning
401The API key is missing, malformed or expired.
404No company with this ID belongs to your partner account, or the payroll calendar isn't one of its active calendars.
409The company is already live, or Everee has set its go-live date. Ask your Everee contact to move it.
422The date isn't tomorrow or later and the first day of a pay period (the message names the nearest valid dates), or the company has no pay frequency or payroll calendar to check it against, or several payroll calendars and no default.
Path Params
integer
required

The company's ID, as returned when the company was created.

Body Params
date | null

The first day of the first pay period you want Everee to pay. Send null to clear the target.

int64

The payroll calendar to check the date against. Required when the company has more than one payroll calendar and no default.

Responses

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