Tell Everee a company paid no one earlier in the year it goes live in.
Use this endpoint when a company has no payroll history to send: its first pay date of the year will be on Everee (a January 1 go-live, for example), or it's a new business that has never run payroll.
Part of Supporting documents. For how this fits into going live, see the guide: Payroll history and going live.
The payroll history status becomes NONE_DECLARED, and PAYROLL_HISTORY stays in goLive.outstanding until Everee confirms the declaration. Everee then moves the status to NOT_NEEDED, or opens a payroll history request and moves it to CHANGES_REQUESTED if it needs files after all.
Request
| Field | Notes |
|---|---|
reason | Required. FIRST_PAYROLL_OF_YEAR, NEW_BUSINESS or OTHER. |
note | Required for OTHER, up to 1,000 characters. Everee's team reads it. |
{ "reason": "FIRST_PAYROLL_OF_YEAR" }The declaration covers the year of the company's target go-live date, or the current year when there's no target. Sending it again replaces it.
Response
The company's payroll history, as Get payroll history returns it, with declaration.
Errors
| Status | Meaning |
|---|---|
401 | The API key is missing, malformed or expired. |
404 | No company with this ID belongs to your partner account. |
422 | The reason is missing, OTHER has no note, payroll history files are in (remove them first), or Everee has started importing. |