API ReferenceSalaries

Create a salary record

Creates a new salary record for an employee, effective from the given date. Salary records are immutable — to change an employee’s salary, create a new record with a later effective_from date rather than modifying an existing one.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

employee_idstringRequiredformat: "ee_.+"

Headers

Idempotency-KeystringOptional

Unique key to ensure idempotent requests. If the same key is used for multiple identical & successful requests, the same response will be returned. Read more here

X-Platform-IdstringOptional

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Request

This endpoint expects an object.
amountdoubleRequired
Salary amount, in the given currency and pay frequency. Must be greater than 0.
currencyenumRequired
ISO currency code the amount is denominated in
pay_frequencyenumRequired

The period this amount represents (e.g. annual, monthly)

effective_fromdateRequired
Date from which this salary is effective

Response

OK
idstringformat: "sal_.+"
Unique identifier for the salary record
employee_idstringformat: "ee_.+"
Unique identifier for the employee this salary belongs to
amountdouble
Salary amount, in the given currency and pay frequency
currencyenum
ISO currency code the amount is denominated in
pay_frequencyenum

The period this amount represents (e.g. annual, monthly)

effective_fromdate
Date from which this salary is effective
objectstringOptionalRead-only
The object type

Errors

400
Bad Request Error
404
Not Found Error