Upload a year-to-date payroll file

Upload a year-to-date payroll history file for a company.

Use this endpoint to send Everee a payroll history file for a company. Send the file as multipart/form-data in a part named file, and pass the company's ID in the companyId query parameter. It files the upload the same way as Upload a payroll history file, which takes the company in the path. To let the company's admin upload the files themselves, use the payroll history upload component.

📘

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

Everee needs the payroll a company has already run this year. Agree the files with your Everee contact: typically the company's quarterly payroll registers and year-to-date totals for each worker, from its previous provider. Files can be CSV, XLSX, XLS, PDF or ZIP, up to 25 MB each and 50 per company. Everee stores each file under its original name and doesn't read it when you upload it; Everee's team reviews it, and Get payroll history shows where it stands.

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.
Query Params
integer
required

The ID of the company the file belongs to.

Body Params
file
required

The year-to-date payroll history file.

Responses

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