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_id
Headers
Idempotency-Key
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
Request
This endpoint expects an object.
amount
Salary amount, in the given currency and pay frequency. Must be greater than 0.
currency
ISO currency code the amount is denominated in
pay_frequency
The period this amount represents (e.g. annual, monthly)
effective_from
Date from which this salary is effective
Response
OK
id
Unique identifier for the salary record
employee_id
Unique identifier for the employee this salary belongs to
amount
Salary amount, in the given currency and pay frequency
currency
ISO currency code the amount is denominated in
pay_frequency
The period this amount represents (e.g. annual, monthly)
effective_from
Date from which this salary is effective
object
The object type
Errors
400
Bad Request Error
404
Not Found Error