BIbindbee
Employee Payroll Runs

Get Employee Payroll Runs

Changed on

Returns a list of EmployeePayrollRun objects.

get/api/hris/v1/employee-payroll-runs

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Query parameters

idsstring nullable

The ID of the employee payroll runs to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a
employee_idstring nullable

The ID of the employees to fetch employee payroll run for

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a
payroll_run_idstring nullable

The IDs of the payroll runs to fetch employee payroll run for

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a
payroll_code_idstring nullable

The IDs of the payroll codes to fetch employee payroll runs for. A run matches when any of its earnings, deductions or taxes carries one of these codes.

Example:019fbd01-e900-7418-a54c-3fcba1299e88,019fbd01-e394-76ed-93fb-b9eda49a3b41
remote_idstring nullable

The third-party API ID of the matching object.

Example:3235005483341316245
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.

page_sizeinteger

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

cursorstring nullable

The pagination cursor value.

modified_afterstring nullable

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z
start_date_fromstring nullable

If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z
start_date_tostring nullable

If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z
end_date_fromstring nullable

If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z
end_date_tostring nullable

If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z
check_date_fromstring nullable

If provided, only objects with check_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z
check_date_tostring nullable

If provided, only objects with check_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z
expandstring nullable

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. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

The page size the request was served with (0 on an empty page). items can be shorter on the last page; cursor says whether another page exists.

Example response

{
  "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": "018b168d-70f9-7043-a796-56d66a4f8f07",
      "payroll_run": "018b709e-b6ef-7db4-902a-a064157bdba2",
      "start_date": "2023-07-01T00:00:00Z",
      "end_date": "2023-07-31T00:00:00Z",
      "check_date": "2023-08-31T00:00:00Z",
      "earnings": [
        {
          "name": "SALARY",
          "currency": "USD",
          "payroll_code": "019fbd01-e900-7418-a54c-3fcba1299e88"
        }
      ],
      "deductions": [
        {
          "name": "Social Security",
          "currency": "USD",
          "payroll_code": "019fbd01-e394-76ed-93fb-b9eda49a3b41"
        }
      ],
      "taxes": [
        {
          "name": "California State Income Tax",
          "currency": "USD",
          "payroll_code": "019fbd01-e5ea-7d5a-a602-bd9016a271cc"
        }
      ]
    }
  ]
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the BONUS enum value from the ///// response property for the response status

    • info

      removed the HOURLY enum value from the ///// response property for the response status

    • info

      removed the OVERTIME enum value from the ///// response property for the response status

    • info

      removed the REIMBURSEMENT enum value from the ///// response property for the response status

    • info

      removed the SALARY enum value from the ///// response property for the response status

  • 4695175eeff0Revision changes
    • info

      added the new optional query request parameter payroll_code_id