Upload payslips

Authorizations

Authorization

string

header

required

Bearer token for authentication. The token should be the one returned by the /user-tokens endpoint.

Body

multipart/form-data

payslip

file

File to upload

Response

201 - application/json

account_id

string

required

The id of the account

entry_id

string

required

The id of the entry

payroll_submissions

object[]

required

payroll_submissions.account_id

string

required

The id of the account

payroll_submissions.created_at

string

required

The date the payroll was submitted

payroll_submissions.employment_information

object

required

payroll_submissions.entry_id

string

required

The id of the entry

payroll_submissions.id

string

required

payroll_submissions.identity_information

object

required

payroll_submissions.income_information

object

required

payroll_submissions.document_external_id

string | null

A string coming from the parameters of the uploaded payslip1.pdf either the form field name or external_document_id header for the file part. It might not be unique and depends on what's passed when uploading. If the payroll submission doesn't originate from a payslip this will be null.

payroll_submissions.document_filename

string | null

If the payroll submission originates from a payslip this will be the file name of the uploaded payslip. It will be duplicate if same file names are uploaded If the payroll submission doesn't originate from a payslip this will be null.

payroll_submissions.document_id

string | null

The id of the document

payslip_errors

object[]

List of errors for payslips that passed valdiation but failed to upload

API Documentation

Users

User Token

Accounts

Entries

Payroll

Documents

Webhooks

Members

Authorizations

Body

Response