Get Employee Payroll Runs

GET

api

hris

employee-payroll-runs

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/employee-payroll-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "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"
      },
      "employee": "<any>",
      "payroll_run": "<any>",
      "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"
        }
      ]
    }
  ]
}

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

Query Parameters

employee_id

string

The ID of the employee.

payroll_run_id

string

The payroll being run.

remote_id

string

The third-party API ID of the matching object.

include_raw_data

boolean

default:false

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

include_custom_fields

boolean

default:false

Whether to include custom fields in the response.

page_size

integer

default:50

Number of results to return per page. Maximum size is 100.

Required range: 1 <= x <= 1000

cursor

string

The pagination cursor value.

modified_after

string

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

start_date_from

string

If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601)

start_date_to

string

If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601)

end_date_from

string

If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601)

end_date_to

string

If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601)

check_date_from

string

If provided, only objects with check_date same or after this date time will be returned. Format: DateTime (ISO 8601)

check_date_to

string

If provided, only objects with check_date same or before this date time will be returned. Format: DateTime (ISO 8601)

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

Successful Response

cursor

string | null

required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

page_size

integer

required

Indicates the count of items in the response

Example:

50

items

object[]

required

The EmployeePayrollRun object is used to represent an employee's pay statement for a specific payroll run.

items.id

string

required

Example:

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

items.remote_id

string | null

required

The third-party API ID of the matching object.

Example:

"123321"

items.modified_at

string

required

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

Example:

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

items.custom_fields

object | null

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"
}

items.employee

any | null

required

The employee whose payroll is being run.

items.payroll_run

any | null

required

The payroll being run.

items.gross_pay

required

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

Example:

772277.77

items.net_pay

required

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

Example:

577221.27

items.start_date

string | null

required

The day and time the benefit started.

Example:

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

items.end_date

string | null

required

The day and time the benefit ended.

Example:

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

items.check_date

string | null

required

The day and time the payroll run was checked.

Example:

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

items.earnings

object[] | null

required

The earnings of the Employee

Example:

[{ "amount": "27151", "name": "SALARY" }]

items.deductions

object[] | null

required

The deductions of the Employee

Example:

[
  {
    "company_deduction": "77.57",
    "employee_deduction": "27.22",
    "name": "Social Security"
  }
]

items.taxes

object[] | null

required

The taxes of the Employee

Example:

[
  {
    "amount": "175.22",
    "name": "California State Income Tax"
  }
]

items.raw_data

object | null

This is the Raw data

Example:

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

Get Payroll Calendar Run By Id Create Employee Payroll Run

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/employee-payroll-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "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"
      },
      "employee": "<any>",
      "payroll_run": "<any>",
      "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"
        }
      ]
    }
  ]
}

Unified Models

Authorizations

Headers

Query Parameters

Response