---
title: "Get Payroll Code By Id"
method: GET
path: "/api/hris/v1/payroll-codes/{id}"
tags: ["Payroll Codes"]
---

# Get Payroll Code By Id

`GET /api/hris/v1/payroll-codes/{id}`

Returns a Payroll Code object with the given id.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `include_raw_data` boolean — Whether to include the original data Bindbee fetched from the third-party to produce these models.
- `include_custom_fields` boolean — Whether to include custom fields in the response.

## Headers

- `x-connector-token` string, required

## Response `200`

Successful Response

- HrisPayrollCode — The Payroll Code object represents a payroll code such as an earning, deduction, or tax used within the payroll system.
  - `id` string, uuid, required
  - `remote_id` string, nullable, required — The third-party API ID of the matching object.
  - `modified_at` string, date-time, required — This is the datetime that this object was last updated by Bindbee
  - `raw_data` object, nullable — This is the Raw data
  - `custom_fields` object, nullable, required — The custom fields related to the model
  - `name` string, nullable, required — Human-readable name of the payroll code.
  - `code` string, nullable, required — Short code identifying the payroll code within the source system.
  - `type` 'EARNING' | 'DEDUCTION' | 'TAX', nullable, required — Category of the payroll code, such as Earning, Deduction, or Tax.
  - `sub_type` union, required — Optional finer-grained classification of the payroll code, drawn from the set allowed for its type. Null when no unified sub-type applies.
    - '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'

## Other responses

- `401` — Missing or invalid bearer authentication credentials.
- `403` — The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
- `404` — The requested resource was not found.
- `422` — Validation Error
- `429` — Rate limit exceeded.

---

[API](https://skmtc.net/bindbee/apis/bindbee-apis.md) · [All operations](https://skmtc.net/bindbee/apis/bindbee-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bindbee/bindbee-apis/revisions/6f24c7fcb3f8/schema)