Employees

Create employee additional compensation

Create additional compensations for an employee

post/employees/{employee_id}/additional_compensations

Request

Base URL
https://app.peopleforce.io/api/public/v3
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/peopleforce/apis/company-api/docs/employees/:employee_id/additional_compensations/post.ts
A function with typed inputs. Its response is checked against the schema.

compensation_type_idinteger required

amountnumber required

starts_onstring date required

ends_onstring date

Optional for only if additional compensation is reoccuring.

currency_codestring required

Currency code 3 character alphabetic and 3 digit numeric ISO 4217

descriptionstring

type'fixed' | 'reoccurring' required

frequency'daily' | 'monthly' | 'quarterly' | 'half_yearly' | 'yearly'

Required if type is reoccurring.

{
  "starts_on": "2024-01-01",
  "ends_on": "2024-01-01"
}

No recorded changes to this operation across all 1 revision of this API.