Skip to main content
POST
Create Employee Compensation Details

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization_id
required
employee_id
required

Body

application/json

GB compensation details - standing/recurring pay data.

employment_country
string
default:GB
Allowed value: "GB"
earnings
AmountEarnings · object[] | null
benefits
Benefits · object[] | null
deductions
Deductions · object[] | null
reimbursements
Reimbursement · object[] | null
valid_from
string<date>

Effective date

valid_to
string<date> | null

End date (None = current)

Response

Successful Response

Response model for GB compensation details.

employee_id
string
required
created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
id
required
employment_country
string
default:GB
Allowed value: "GB"
earnings
AmountEarnings · object[] | null
benefits
Benefits · object[] | null
deductions
Deductions · object[] | null
reimbursements
Reimbursement · object[] | null
valid_from
string<date>

Effective date

valid_to
string<date> | null

End date (None = current)