Upload a payroll history file

Upload one of a company's payroll history files.

Use this endpoint to send Everee one payroll history file for a company, when you collect the files in your own product. Send the file as multipart/form-data in a part named file, one file per call. To let the company's admin upload the files themselves, use the payroll history upload component instead.

📘

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

Files can be CSV, XLSX, XLS, PDF or ZIP, up to 25 MB each, and a company can have up to 50. Everee stores the file under its original name and doesn't read it when you upload it; Everee's team reviews it. The first file moves the payroll history status to RECEIVED, and an upload also answers an open payroll history request.

Errors

StatusMeaning
401The API key is missing, malformed or expired.
404No company with this ID belongs to your partner account.
422The file is empty, larger than 25 MB, or not a CSV, XLSX, XLS, PDF or ZIP file, or the company already has 50 payroll history files.
Path Params
integer
required

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

Body Params
file
required

A CSV, XLSX, XLS, PDF or ZIP file, up to 25 MB.

Responses

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