Calls: {root}/{version}/overtime


GET/v4/get-by-id
Route {root}/v4/overtime/get-by-id
Request type URL
User level STAFF
Requires authentication Yes
Response type Single
Sample call{root}/v0/overtime/get-by-id/12345678

Parameters

Sample cURL

curl --location --request GET "{{ROOT}}/v4/overtime/get-by-id/12345678-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \

Sample response

[
{
"object_name":"overtime_id",
"type":"[Int32]",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"user_id",
"type":"[Int32]",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"department_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"overtime_type_id",
"type":"[Int32]",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"overtime_type_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"colour",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"status_id",
"type":"custom",
"is_nullable":false,
"nest":null,
"custom":[
{
"name":"disabled",
"value":"0"
},
{
"name":"active",
"value":"1"
}]
"note":
},
{
"object_name":"start_date",
"type":"Date",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"end_date",
"type":"Date",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"allowance_type_id",
"type":"custom",
"is_nullable":false,
"nest":null,
"custom":[
{
"name":"days",
"value":"0"
},
{
"name":"hours",
"value":"1"
}]
"note":
},
{
"object_name":"duration",
"type":"minute(int32)",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"lieu_requested",
"type":"minute(int32)",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"requested_date",
"type":"DateTime",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_id",
"type":"[Int32]",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"lieu_approved",
"type":"minute(int32)",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_date",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_by_id",
"type":"[Int32]",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_by_first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_by_last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"request_note",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_note",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"requested_by_first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"requested_by_last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"lieu_time",
"type":"[Boolean]",
"is_nullable":false,
"nest":null,
"custom":null
"note":
}
]
POST/v4/my
Route {root}/v4/overtime/my
Request type BODY
User level STAFF
Requires authentication Yes
Response type Array()

Parameters

Nested object(s)[]

Sample cURL

curl --location --request POST "{{ROOT}}/v4/overtime/my/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"date_option": "0","status_id": "0","overtime_type_ids": [{"overtime_type_id":"234"},{"overtime_type_id":"234"}]}'

Sample response

[
{
"object_name":"overtime_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"overtime_type_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"code",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"colour",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"status_id",
"type":"custom",
"is_nullable":false,
"nest":null,
"custom":[
{
"name":"disabled",
"value":"0"
},
{
"name":"active",
"value":"1"
}]
"note":
},
{
"object_name":"start_date",
"type":"DateTime",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"end_date",
"type":"DateTime",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"allowance_type_id",
"type":"custom",
"is_nullable":false,
"nest":null,
"custom":[
{
"name":"days",
"value":"0"
},
{
"name":"hours",
"value":"1"
}]
"note":
},
{
"object_name":"duration",
"type":"minute(int32)",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"lieu_requested",
"type":"minute(int32)",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"lieu_approved",
"type":"minute(int32)",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_id",
"type":"[Int32]",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_by_id",
"type":"[Int32]",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_by_first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_by_last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"request_note",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_note",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"last_reminder_date",
"type":"DateTime",
"is_nullable":false,
"nest":null,
"custom":null
"note":
}
]
POST/v4/get
Route {root}/v4/overtime/get
Request type BODY
User level APPROVER
Requires authentication Yes
Response type Array()

Parameters

Nested object(s)[]

Sample cURL

curl --location --request POST "{{ROOT}}/v4/overtime/get/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"map_type_id": "0","map_id": "123456","user_status_id": "0","date_option": "0","status_id": "0","overtime_type_ids": [{"overtime_type_id":"234"},{"overtime_type_id":"234"}]}'

Sample response

[
{
"object_name":"overtime_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"user_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"department_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"overtime_type_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"code",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"colour",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"status_id",
"type":"custom",
"is_nullable":false,
"nest":null,
"custom":[
{
"name":"disabled",
"value":"0"
},
{
"name":"active",
"value":"1"
}]
"note":
},
{
"object_name":"start_date",
"type":"DateTime",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"end_date",
"type":"DateTime",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"allowance_type_id",
"type":"custom",
"is_nullable":false,
"nest":null,
"custom":[
{
"name":"days",
"value":"0"
},
{
"name":"hours",
"value":"1"
}]
"note":
},
{
"object_name":"duration",
"type":"minute(int32)",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"lieu_requested",
"type":"minute(int32)",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"lieu_approved",
"type":"minute(int32)",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"requested_date",
"type":"DateTime",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_by_id",
"type":"[Int32]",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_by_first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_by_last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"request_note",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_note",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"last_reminder_date",
"type":"DateTime",
"is_nullable":false,
"nest":null,
"custom":null
"note":
}
]
POST/v4.1/get
Route {root}/v4.1/overtime/get
Request type BODY
User level APPROVER
Requires authentication Yes
Response type Array()

Parameters

Nested object(s)[]

Sample cURL

curl --location --request POST "{{ROOT}}/v4.1/overtime/get/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"map_type_id": "0","map_id": "123456","user_status_id": "0","date_option": "0","status_id": "0","overtime_type_ids": [{"overtime_type_id":"234"},{"overtime_type_id":"234"}]}'

Sample response

[
{
"object_name":"overtime_type_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"lieu_time",
"type":"Boolean",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"notifier_2_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"notifier_2_first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"notifier_2_last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"notifier_3_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"notifier_3_first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"notifier_3_last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"overtime_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"user_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"department_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"overtime_type_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"code",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"colour",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"status_id",
"type":"custom",
"is_nullable":false,
"nest":null,
"custom":[
{
"name":"disabled",
"value":"0"
},
{
"name":"active",
"value":"1"
}]
"note":
},
{
"object_name":"start_date",
"type":"DateTime",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"end_date",
"type":"DateTime",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"allowance_type_id",
"type":"custom",
"is_nullable":false,
"nest":null,
"custom":[
{
"name":"days",
"value":"0"
},
{
"name":"hours",
"value":"1"
}]
"note":
},
{
"object_name":"duration",
"type":"minute(int32)",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"lieu_requested",
"type":"minute(int32)",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"lieu_approved",
"type":"minute(int32)",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"requested_date",
"type":"DateTime",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_by_id",
"type":"[Int32]",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_by_first_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approved_by_last_name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"request_note",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"approver_note",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"last_reminder_date",
"type":"DateTime",
"is_nullable":false,
"nest":null,
"custom":null
"note":
}
]
POST/v4/submit
Route {root}/v4/overtime/submit
Request type BODY
User level STAFF
Requires authentication Yes
Response type Single

Parameters

Sample cURL

curl --location --request POST "{{ROOT}}/v4/overtime/submit/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"user_id": "123456","overtime_type_id": "123456","start_date": "20230401T00:00","lieu_time_requested": "123456","note": "sample","admin": false}'

Sample response

[
{
"object_name":"overtime_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"status_id",
"type":"custom",
"is_nullable":false,
"nest":null,
"custom":[
{
"name":"pending",
"value":"1"
},
{
"name":"approved",
"value":"100"
},
{
"name":"auto approved",
"value":"110"
},
{
"name":"self approved",
"value":"120"
},
{
"name":"approved by approver",
"value":"130"
},
{
"name":"approved by super user",
"value":"140"
},
{
"name":"paid overtime only",
"value":"200"
},
{
"name":"cancelled by user pending",
"value":"900"
},
{
"name":"cancelled by user approved",
"value":"901"
},
{
"name":"cancelled by approver pending",
"value":"910"
},
{
"name":"cancelled by approved approved",
"value":"911"
},
{
"name":"cancelled by super user pending",
"value":"920"
},
{
"name":"cancelled by super user approved",
"value":"921"
},
{
"name":"declined by approved",
"value":"930"
},
{
"name":"declined by auper user",
"value":"940"
}]
"note":
},
{
"object_name":"message",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
}
]
POST/v4/approve-decline
Route {root}/v4/overtime/approve-decline
Request type BODY
User level APPROVER
Requires authentication Yes
Response type Single

Parameters

Sample cURL

curl --location --request POST "{{ROOT}}/v4/overtime/approve-decline/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"overtime_id": "123456","option_id": "1","approver_note": "sample","lieu_time_approved": "123456"}'

Sample response

[
{
"object_name":"message",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
}
]
POST/v4/cancel
Route {root}/v4/overtime/cancel
Request type BODY
User level STAFF
Requires authentication Yes
Response type Single

Parameters

Sample cURL

curl --location --request POST "{{ROOT}}/v4/overtime/cancel/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"overtime_id": "123456","cancellation_note": "sample","admin": false}'

Sample response

[
{
"object_name":"message",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
}
]


Don't have a WhosOff account yet?

Instantly reduce time spent on leave management with your FREE, no obligation trial today!
Sign up today and get until Sunday, 26th July 2026 to try the full service, for Free!

Get your instant FREE account today