GET
/
api
/
hris
/
v1
/
employee-payroll-runs
/
{id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Path Parameters

id
string
required

Query Parameters

include_raw_data
boolean
default: false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Response

200 - application/json

The EmployeePayrollRun object is used to represent an employee's pay statement for a specific payroll run.

id
string
required
remote_id
string | null
required

The third-party API ID of the matching object.

modified_at
string
required

This is the datetime that this object was last updated by Bindbee

employee
string | null
required

The employee whose payroll is being run.

payroll_run
string | null
required

The payroll being run.

gross_pay
required

The total earnings throughout a given period for an employee before any deductions are made.

net_pay
required

The take-home pay throughout a given period for an employee after deductions are made.

start_date
string | null
required

The day and time the benefit started.

end_date
string | null
required

The day and time the benefit ended.

check_date
string | null
required

The day and time the payroll run was checked.

earnings
object[] | null
required

The earnings of the Employee

deductions
object[] | null
required

The deductions of the Employee

taxes
object[] | null
required

The taxes of the Employee

raw_data
object | null

This is the Raw data