Skip to main content
GET
/
api
/
hris
/
v1
/
payroll-runs
/
{id}
Get Payroll Run By Id
curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/payroll-runs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_id": "123321",
  "modified_at": "<string>",
  "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",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-connector-token
string
required

Path Parameters

​
id
string<uuid>
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.

Example:

false

​
include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

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

Example:

"manager[first_name,last_name]"

Response

Successful Response

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

​
id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

​
remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

​
modified_at
string
required

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

Example:

"2021-10-16T00:00:00Z"

​
custom_fields
Custom Fields · object
required

The custom fields related to the model

Example:
{
  "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
any | null
required

The paygroup to which this pay cycle belongs to

Example:

"018af1fe-2fad-749e-a282-ea17ba4fc0c4"

​
run_state
enum<string>
required

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.

Available options:
PAID,
DRAFT,
APPROVED,
FAILED,
CLOSED,
NOT_STARTED
Example:

"PAID"

​
run_type
enum<string>
required

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.

Available options:
REGULAR,
OFF_CYCLE,
CORRECTION,
TERMINATION,
BONUS,
SIGN_ON_BONUS
Example:

"REGULAR"

​
start_date
string | null
required

The day and time the payroll run started.

Example:

"2020-11-08T00:00:00Z"

​
end_date
string | null
required

The day and time the payroll run ended.

Example:

"2020-11-15T00:00:00Z"

​
check_date
string | null
required

The day and time the payroll run was checked.

Example:

"2020-11-15T00:00:00Z"

​
payroll_run_calendar
any | null
required

The payroll run calendar to which which the payroll run belongs

Example:

"018af1fe-2fad-749e-a282-ea17ba4fc0c4"

​
raw_data
Raw Data · object

This is the Raw data

Example:
{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}