Skip to main content
GET
Get Payroll Code By Id

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

Path Parameters

id
string<uuid>
required

Query Parameters

include_raw_data
boolean
default:false

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

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

Response

Successful Response

The Payroll Code object represents a payroll code such as an earning, deduction, or tax used within the payroll system.

id
string<uuid>
required
Example:

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

remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

modified_at
string<date-time>
required

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

Example:

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

custom_fields
Custom Fields · object | null
required

The custom fields related to the model

Example:
name
string | null
required

Human-readable name of the payroll code.

Example:

"Regular Earnings"

code
string | null
required

Short code identifying the payroll code within the source system.

Example:

"REG"

type
enum<string>
required

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

Available options:
EARNING,
DEDUCTION,
TAX
Example:

"EARNING"

sub_type
required

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

Available options:
REGULAR,
OVERTIME,
BONUS,
ALLOWANCE,
TIME_OFF,
SEVERANCE,
EQUITY,
REIMBURSEMENT,
RETRO
Example:

"OVERTIME"

raw_data
Raw Data · object | null

This is the Raw data

Example: