Skip to main content
POST
Record an (immutable) salary revision

Authorizations

Authorization
string
header
required

Issue keys in Settings → API. Send them as Authorization: Bearer ont_… (an X-Api-Key: ont_… header is also accepted). Session-cookie routes are used by the OnTime web apps and are shown for completeness.

Path Parameters

employeeId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
effectiveDate
string
required
Pattern: ^\d{4}-\d{2}-\d{2}$
ctcAnnual
integer
required
Required range: x <= 9007199254740991
reason
string
required
Required string length: 2 - 160

Response

200 - application/json

Success

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
effectiveDate
string
required
ctcAnnual
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
deltaPercent
number | null
required
reason
string
required
approverName
string
required
createdAt
string
required