Get payroll history

Get a company's payroll history status and files.

Use this endpoint to see where a company's payroll history stands, and every payroll history file Everee has for it, whether you uploaded it or the company's admin did in the upload component.

📘

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

Response

FieldNotes
statusNOT_RECEIVED, RECEIVED, CHANGES_REQUESTED, IN_PROGRESS, IMPORTED or NOT_NEEDED. See Where it stands.
statusChangedAtWhen the status last changed.
filesEach file's id, fileName, source (PARTNER or EMBEDDED), reviewStatus (PENDING, ACCEPTED or REJECTED), reviewNote, uploadedAt and reviewedAt.

The same object is payrollHistory on Get onboarding status.

Errors

StatusMeaning
401The API key is missing, malformed or expired.
404No company with this ID belongs to your partner account.
Path Params
integer
required

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

Responses

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