GET
/
api
/
hris
/
v1
/
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.

expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Response

200 - application/json

The PayrollRun object is used to represent a group of pay statements for a specific pay schedule.

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

pay_group
any | null
required

The paygroup to which this pay cycle belongs to

run_state
string | null
required

The state of the payroll run Possible values include: PAID, DRAFT, APPROVED, FAILED, CLOSED. In cases where there is no clear mapping, the original value passed through will be returned.

run_type
string | null
required

The type of the payroll run Possible values include: REGULAR, OFF_CYCLE, CORRECTION, TERMINATION, SIGN_ON_BONUS. In cases where there is no clear mapping, the original value passed through will be returned.

start_date
string | null
required

The day and time the payroll run started.

end_date
string | null
required

The day and time the payroll run ended.

check_date
string | null
required

The day and time the payroll run was checked.

payroll_run_calendar
any | null
required

The payroll run calendar to which which the payroll run belongs

raw_data
object | null

This is the Raw data