BIbindbee
Payroll Codes

Get Payroll Codes

Changed on

Returns a list of Payroll Code objects.

get/api/hris/v1/payroll-codes

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 payroll codes to fetch

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

The type of payroll code to filter by (e.g., Earning, Deduction, Tax). Pass several values, comma-separated, to match any of them.

Example:EARNING
codestring nullable

The payroll code as the third-party system names it, matched exactly.

Example:401K
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.

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
page_sizeinteger

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

cursorstring nullable

The pagination cursor value.

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"
      },
      "name": "Dental Insurance",
      "code": "DENTAL",
      "type": "DEDUCTION",
      "sub_type": "DENTAL"
    }
  ]
}

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 DEDUCTION enum value from the // response property for the response status

    • info

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

    • info

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

  • 4695175eeff0Revision changes
    • info

      added the new optional query request parameter code