Skip to main content
POST
Payroll cycle stage: approve

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

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)$

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)$
period
string
required
periodLabel
string
required
status
enum<string>
required
Available options:
InProgress,
Disbursed
employeeCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
grossTotal
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
netTotal
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
disbursedAt
string | null
required
stages
object[]
required
locksAt
string
required
deductionTotal
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
lopCases
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
lopImpactTotal
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
otHoursTotal
number
required
otPayoutTotal
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
anomalyCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991