Get Payroll

GET

payroll

{user_id}

Authorizations

X-API-KEY

string

headerrequired

Path Parameters

user_id

string

required

ID of the user to get payroll for

Query Parameters

orederd_by

enum<string>

default: created_at

The field of the user to order by

Available options:

account_id,

entry_id,

created_at

offset

integer

default: 0

The offset to start at

Required range: x > 1

limit

integer

default: 20

The number of items to return

Required range: 1 < x < 100

account_id

string

The account_id to fileter on

entry_id

string

The account_id to fileter on

document_external_id

string

The document_external_id to fileter on

created_after

string

Filter out payroll dated before the given date

created_before

string

Filter out payroll dated after the given date

Response

200 - application/json

pagination

object

required

payroll_submissions

object[]

required

payroll_submissions.id

string

required

payroll_submissions.account_id

string

required

The id of the account

payroll_submissions.entry_id

string

required

The id of the entry

payroll_submissions.created_at

string

required

The date the payroll was submitted

payroll_submissions.document_id

string | null

The id of the document

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.identity_information

object

required

payroll_submissions.employment_information

object

required

payroll_submissions.income_information

object

required

Delete an entry Retrieve a specific document

API Documentation

Users

User Token

Accounts

Entries

Payroll

Documents

Webhooks

Members

Authorizations

Path Parameters

Query Parameters

Response