Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
timeoff

Validate a time off request

post/v1/org/{orgId}/timeoff/request/validate

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

ignoreRequestIdstring

Request ID to ignore during validation (for editing)

Request body

startDatestring date required
startDatePartialDaynumber
startDatePartialDayPeriod'AM' | 'PM'
endDatestring date required
endDatePartialDaynumber
endDatePartialDayPeriod'AM' | 'PM'
personIdstring
typeDescriptionstring
timeOffPolicyIdstring
notestring

Example request

{
  "personId": "588f7ee98f138b19220041a7",
  "timeOffPolicyId": "588f7ee98f138b19220041a7"
}

Response

time off validated

daysTakennumber required
hoursTakennumber required
balanceBeforeRequestnumber
carryOverBeforeRequestnumber
balanceAfterRequestnumber
carryOverAfterRequestnumber
approverJobIdstring
errorMessagestring

Example response

{
  "approverJobId": "588f7ee98f138b19220041a7"
}