BIbindbee
Payroll Codes

Get Payroll Code By Id

Changed on

Returns a Payroll Code object with the given id.

get/api/hris/v1/payroll-codes/{id}

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

Path parameters

idstring uuid required

Query parameters

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.

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

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

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

namestring nullable required

Human-readable name of the payroll code.

codestring nullable required

Short code identifying the payroll code within the source system.

typestring nullable required

Category of the payroll code, such as Earning, Deduction, or Tax.

sub_type'REGULAR' | 'OVERTIME' | 'BONUS' | 'ALLOWANCE' | 'TIME_OFF' | 'SEVERANCE' | 'EQUITY' | 'REIMBURSEMENT' | 'RETRO' | 'HEALTH' | 'DENTAL' | 'VISION' | 'HEALTH_SAVINGS' | 'FLEXIBLE_SPENDING' | 'RETIREMENT' | 'LIFE_INSURANCE' | 'SUPPLEMENTAL_INSURANCE' | 'DISABILITY' | 'GARNISHMENT' | 'FUTA' | 'SUTA' | 'FICA' | 'MEDICARE' | 'FIT' | 'SIT' | 'INCOME_TAX' | 'UNEMPLOYMENT' | 'LEVY' | 'SOCIAL_SECURITY' nullable required

Optional finer-grained classification of the payroll code, drawn from the set allowed for its type. Null when no unified sub-type applies.

Example response

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

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API