v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Payroll Runs

Get Payroll Run By Id

Returns a PayrollRun object with the given id.

get/api/hris/v1/payroll-runs/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

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

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring

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.

Example:manager[first_name,last_name]

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.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required

remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring required

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

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

pay_groupstring nullable required

The paygroup to which this pay cycle belongs to

The state of the payroll run. If the value is not one of the defined enum values, the original value passed through will be returned.

The type of the payroll run. If the value is not one of the defined enum values, the original value passed through will be returned.

start_datestring nullable required

The day and time the payroll run started.

end_datestring nullable required

The day and time the payroll run ended.

check_datestring nullable required

The day and time the payroll run was checked.

payroll_run_calendarstring nullable required

The payroll run calendar to which which the payroll run belongs

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "pay_group": "018af1fe-2fad-749e-a282-ea17ba4fc0c4",
  "run_state": "PAID",
  "run_type": "REGULAR",
  "start_date": "2020-11-08T00:00:00Z",
  "end_date": "2020-11-15T00:00:00Z",
  "check_date": "2020-11-15T00:00:00Z",
  "payroll_run_calendar": "018af1fe-2fad-749e-a282-ea17ba4fc0c4"
}