GET
/
api
/
hris
/
v1
/
payroll-run-calendars
/
{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 PayrollRunCalendar 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

payroll_run_calendar_name
string | null
required

The name of the payroll run calendar

pay_group
any | null
required

The paygroup to which this pay cycle belongs to

pay_period_start_date
string | null
required

The day and time the payroll run is supposed to start.

pay_period_end_date
string | null
required

The day and time the payroll run is supposed to end.

pay_date
string | null
required

The day and time the by which payment is to be made.

calendar_type
string | null
required

The type of the payroll run calendar

raw_data
object | null

This is the Raw data