Skip to main content
GET
/
api
/
hris
/
v1
/
employee-payroll-runs
/
{id}
Get Employee Payroll Runs By Id
curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/employee-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"
  },
  "employee": "018b168d-70f9-7043-a796-56d66a4f8f07",
  "payroll_run": "018b709e-b6ef-7db4-902a-a064157bdba2",
  "gross_pay": 772277.77,
  "net_pay": 577221.27,
  "start_date": "2023-07-01T00:00:00Z",
  "end_date": "2023-07-31T00:00:00Z",
  "check_date": "2023-08-31T00:00:00Z",
  "earnings": {
    "amount": "27151",
    "name": "SALARY"
  },
  "deductions": {
    "company_deduction": "77.57",
    "employee_deduction": "27.22",
    "name": "Social Security"
  },
  "taxes": {
    "amount": "175.22",
    "name": "California State Income Tax"
  },
  "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 EmployeePayrollRun object is used to represent an employee's pay statement for a specific payroll run.

​
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"
}
​
employee
any | null
required

The employee whose payroll is being run.

Example:

"018b168d-70f9-7043-a796-56d66a4f8f07"

​
payroll_run
any | null
required

The payroll being run.

Example:

"018b709e-b6ef-7db4-902a-a064157bdba2"

​
gross_pay
required

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

Example:

772277.77

​
net_pay
required

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

Example:

577221.27

​
start_date
string | null
required

The day and time the benefit started.

Example:

"2023-07-01T00:00:00Z"

​
end_date
string | null
required

The day and time the benefit ended.

Example:

"2023-07-31T00:00:00Z"

​
check_date
string | null
required

The day and time the payroll run was checked.

Example:

"2023-08-31T00:00:00Z"

​
earnings
Earning · object[] | null
required

The earnings of the Employee

Example:
{ "amount": "27151", "name": "SALARY" }
​
deductions
Deduction · object[] | null
required

The deductions of the Employee

Example:
{
  "company_deduction": "77.57",
  "employee_deduction": "27.22",
  "name": "Social Security"
}
​
taxes
Tax · object[] | null
required

The taxes of the Employee

Example:
{
  "amount": "175.22",
  "name": "California State Income Tax"
}
​
raw_data
Raw Data · object

This is the Raw data

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