get
https://api.everee.com/integration/v1/partner/companies//go-live
See whether a company is live, its go-live dates, and what's outstanding.
Use this endpoint to see when a company can run payroll on Everee. The same object is goLive on Get onboarding status and Get a company.
Part of Submission and status. For how this fits into going live, see the guide: Payroll history and going live.
Response
| Field | Notes |
|---|---|
live | true once the company is live and can run payroll. |
targetGoLiveDate | The go-live date you asked for. Absent when you haven't set one. |
targetPayrollCalendarId | The payroll calendar the target was checked against, when you named one. |
targetGoLiveDateValid | Whether the target is still tomorrow or later and still the first day of a pay period. Absent when there's no target. |
goLiveDate | The first day of the first pay period Everee pays, once Everee has set it. |
outstanding | What still stands between the company and going live: ONBOARDING_APPROVAL, PAYROLL_HISTORY, TARGET_GO_LIVE_DATE or EVEREE_SETUP. Empty once the company is live. See What you see. |
Errors
| Status | Meaning |
|---|---|
401 | The API key is missing, malformed or expired. |
404 | No company with this ID belongs to your partner account. |