Home Features Pricing
Case studies Blog Support Contact us Refer a Business
Call us today on +44 (0)1227 812932 Get your FREE Trial

Controller : Reporting

DEPRECATED: NO

work last-login restricted-user staff staff-directory yearly whosoff leave-summary overtime Return to API overview

Calls: {root}/{version}/reporting


POST/v4/work
Route {root}/v4/reporting/work
Request type BODY
User level APPROVER
Requires authentication Yes
Response type Array()

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
start_date DATE OPTIONAL - -
map_type_id CUSTOM ✓ OPTIONAL - company (0)
department (1)
tag (2)
staff (3)
my staff (4)
region (7)
map_id [INT32] ✓ OPTIONAL 0 2147483647 - -
user_status_id CUSTOM ✓ OPTIONAL - disabled (0)
active (1)
both (99)

Sample cURL

curl --location --request POST "{{ROOT}}/v4/reporting/work/" \
-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"}'

Sample response

[
    {
      "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":"allowance_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"days",
                "value":"0"
            },
            {
                "name":"hours",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"monday",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"tuesday",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"wednesday",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"thursday",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"friday",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"saturday",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"sunday",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"total",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"monday_label",
      "type":"[Byte]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"tuesday_label",
      "type":"[Byte]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"wednesday_label",
      "type":"[Byte]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"thursday_label",
      "type":"[Byte]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"friday_label",
      "type":"[Byte]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"saturday_label",
      "type":"[Byte]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"sunday_label",
      "type":"[Byte]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]
POST/v4/last-login
Route {root}/v4/reporting/last-login
Request type BODY
User level APPROVER
Requires authentication Yes
Response type Array()

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
map_type_id CUSTOM ✓ OPTIONAL - company (0)
department (1)
tag (2)
staff (3)
my staff (4)
region (7)
map_id [INT32] ✓ OPTIONAL 0 2147483647 - -

Sample cURL

curl --location --request POST "{{ROOT}}/v4/reporting/last-login/" \
-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"}'

Sample response

[
    {
      "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":"logins",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"login_date",
                "type":"DateTime",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"device",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  }
]
POST/v4/restricted-user
Route {root}/v4/reporting/restricted-user
Request type BODY
User level APPROVER
Requires authentication Yes
Response type Array()

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
map_type_id CUSTOM REQUIRED 0 7 - company (0)
department (1)
tag (2)
staff (3)
my staff (4)
region (7)
map_id [INT32] REQUIRED 0 2147483647 - -
user_status_id CUSTOM ✓ OPTIONAL - disabled (0)
active (1)
both (99)

Sample cURL

curl --location --request POST "{{ROOT}}/v4/reporting/restricted-user/" \
-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"}'

Sample response

[
    {
      "object_name":"staff_code",
      "type":"String",
      "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":"status_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"disabled",
                "value":"0"
            },
            {
                "name":"active",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"restricted_first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"restricted_last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"restricted_department_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"restricted_status_id",
      "type":"Byte",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]
POST/v4/staff
Route {root}/v4/reporting/staff
Request type BODY
User level APPROVER
Requires authentication Yes
Response type Array()

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
map_type_id CUSTOM ✓ OPTIONAL - company (0)
department (1)
tag (2)
staff (3)
my staff (4)
region (7)
map_id [INT32] ✓ OPTIONAL 0 2147483647 - -
user_status_id CUSTOM ✓ OPTIONAL - disabled (0)
active (1)
both (99)

Sample cURL

curl --location --request POST "{{ROOT}}/v4/reporting/staff/" \
-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"}'

Sample response

[
    {
      "object_name":"staff_code",
      "type":"String",
      "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":"user_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"approver plus add",
                "value":"210"
            },
            {
                "name":"approver plus add edit cancel",
                "value":"220"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]
      "note": 
  },
    {
      "object_name":"approver_for_total",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"employee_start_date",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"employee_end_date",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"department_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"department_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"region_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"region_name",
      "type":"String",
      "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":"allowance_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"days",
                "value":"0"
            },
            {
                "name":"hours",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"opening",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"remaining",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"carryover_opening",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"carryover_remaining",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"lieu",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]
POST/v4/staff-directory
Route {root}/v4/reporting/staff-directory
Request type BODY
User level STAFF
Requires authentication Yes
Response type Array()

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
map_type_id CUSTOM ✓ OPTIONAL - company (0)
department (1)
tag (2)
staff (3)
my staff (4)
region (7)
map_id [INT32] ✓ OPTIONAL 0 2147483647 - -
user_status_id CUSTOM ✓ OPTIONAL - disabled (0)
active (1)
both (99)

Sample cURL

curl --location --request POST "{{ROOT}}/v4/reporting/staff-directory/" \
-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"}'

Sample response

[
    {
      "object_name":"user_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"title",
      "type":"String",
      "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":"email_contact",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"email_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"text",
                "value":"1"
            },
            {
                "name":"html",
                "value":"2"
            }]
      "note": 
  },
    {
      "object_name":"work_telephone",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"mobile_telephone",
      "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":"mfa_method_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]
POST/v4/yearly
Route {root}/v4/reporting/yearly
Request type BODY
User level APPROVER
Requires authentication Yes
Response type Array()

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
user_id [INT32] REQUIRED 0 2147483647 - -
start_date DATE REQUIRED - -

Sample cURL

curl --location --request POST "{{ROOT}}/v4/reporting/yearly/" \
-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"}'

Sample response

[
    {
      "object_name":"work",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "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":"monday",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"tuesday",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"wednesday",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"thursday",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"friday",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"saturday",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"sunday",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"monday_label",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"tuesday_label",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"wednesday_label",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"thursday_label",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"friday_label",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"saturday_label",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"sunday_label",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"leave",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "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":"name",
                "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":"leave_type_id",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "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":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"free_days",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "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":"description",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"restricted_days",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "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":"description",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"leave_types",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"leave_type_id",
                "type":"Int32",
                "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":"name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  }
]
POST/v4/whosoff
Route {root}/v4/reporting/whosoff
Request type BODY
User level APPROVER
Requires authentication Yes
Response type Array()

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
map_type_id CUSTOM REQUIRED 0 7 - company (0)
department (1)
tag (2)
staff (3)
my staff (4)
region (7)
map_id [INT32] REQUIRED 0 2147483647 - -
user_status_id CUSTOM ✓ OPTIONAL - disabled (0)
active (1)
both (99)
date_option CUSTOM REQUIRED 0 3 - custom (0)
this year (1)
next year (2)
last year (3)
start_date DATE REQUIRED FOR OPTION 0 - -
end_date DATE REQUIRED FOR OPTION 0 - -
leave_type_ids NESTED OPTIONAL List (Of leave_type_ids) -
status_id CUSTOM REQUIRED 0 1010 - approved and pending (0)
pending only (1)
approved only (100)
cancelled only (900)
declined only (930)
approved and declined (1000)
cancelled and declined (1010)
return_record_option_id CUSTOM REQUIRED 1 2 - all (1)
only with data (2)
date_range_only [BOOLEAN] REQUIRED - -
show_bradford_factor [BOOLEAN] REQUIRED - -

Nested object(s)[]

Object name Param name Type Is Nullable? Required? Min. Max.
leave_type_ids
leave_type_id[Int32]FalseREQUIRED02147483647

Sample cURL

curl --location --request POST "{{ROOT}}/v4/reporting/whosoff/" \
-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","leave_type_ids": [{"leave_type_id":"234"},{"leave_type_id":"234"}],"status_id": "0","return_record_option_id": "1","date_range_only": false,"show_bradford_factor": false}'

Sample response

[
    {
      "object_name":"user_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"staff_code",
      "type":"String",
      "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":"allowance_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"days",
                "value":"0"
            },
            {
                "name":"hours",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"department_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"department_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"region_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"region_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"bradford_factor_instance",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"total_shifts",
      "type":"[Decimal]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"allowances",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "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":"opening",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"remaining",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"carryover_opening",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"carryover_remaining",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"pending",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"lieu",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"leave",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"status_id",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"disabled",
                "value":"0"
            },
            {
                "name":"active",
                "value":"1"
            }]"
                "note":"",
            },
            {
                "object_name":"leave_type_id",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "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":"split_start_date",
                "type":"Date",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"split_end_date",
                "type":"Date",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"leave_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":"shifts",
                "type":"[Decimal]",
                "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":"allowance_duration",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"work_duration",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"free_duration",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"request_note",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"approve_note",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"cancel_note",
                "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":"",
            }],
      "custom":null
      "note": 
  }
]
POST/v4/leave-summary
Route {root}/v4/reporting/leave-summary
Request type BODY
User level APPROVER
Requires authentication Yes
Response type Single

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
map_type_id CUSTOM REQUIRED 0 7 - company (0)
department (1)
tag (2)
staff (3)
my staff (4)
region (7)
map_id [INT32] REQUIRED 0 2147483647 - -
user_status_id CUSTOM ✓ OPTIONAL - disabled (0)
active (1)
both (99)
date_option CUSTOM REQUIRED 0 3 - custom (0)
this year (1)
next year (2)
last year (3)
start_date DATE REQUIRED FOR OPTION 0 - -
end_date DATE REQUIRED FOR OPTION 0 - -
leave_type_ids NESTED OPTIONAL List (Of leave_type_ids) -

Nested object(s)[]

Object name Param name Type Is Nullable? Required? Min. Max.
leave_type_ids
leave_type_id[Int32]FalseREQUIRED02147483647

Sample cURL

curl --location --request POST "{{ROOT}}/v4/reporting/leave-summary/" \
-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","leave_type_ids": [{"leave_type_id":"234"},{"leave_type_id":"234"}]}'

Sample response

[
    {
      "object_name":"leave_types",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"leave_type_id",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"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":"deduct_allowance_id",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"no",
                "value":"0"
            },
            {
                "name":"yes",
                "value":"1"
            },
            {
                "name":"no hours only",
                "value":"2"
            }]"
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"leave_summary",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"staff_code",
                "type":"String",
                "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":"allowance_type_id",
                "type":"custom",
                "is_nullable":False,
                "nest":null,
                "custom":"[
            {
                "name":"days",
                "value":"0"
            },
            {
                "name":"hours",
                "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":"opening",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"remaining",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"carryover_opening",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"carryover_remaining",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"pending",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"lieu",
                "type":"minute(int32)",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"leave_summary",
                "type":"ResObjReportSummaryUserLeaveAllowance",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  }
]
POST/v4/overtime
Route {root}/v4/reporting/overtime
Request type BODY
User level APPROVER
Requires authentication Yes
Response type Array()

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
map_type_id CUSTOM REQUIRED 0 7 - company (0)
department (1)
tag (2)
staff (3)
my staff (4)
region (7)
map_id [INT32] REQUIRED 0 2147483647 - -
user_status_id CUSTOM ✓ OPTIONAL - disabled (0)
active (1)
both (99)
start_date DATE REQUIRED FOR OPTION 0 - -
end_date DATE REQUIRED FOR OPTION 0 - -
date_option CUSTOM REQUIRED 0 3 - custom (0)
this year (1)
next year (2)
last year (3)
overtime_type_ids NESTED OPTIONAL List (Of overtime_type_ids) -
status_id CUSTOM REQUIRED 0 1010 - approved and pending (0)
pending only (1)
approved only (100)
cancelled only (900)
declined only (930)
approved and declined (1000)
cancelled and declined (1010)
return_record_option_id CUSTOM REQUIRED 1 2 - all (1)
only with data (2)

Nested object(s)[]

Object name Param name Type Is Nullable? Required? Min. Max.
overtime_type_ids
overtime_type_id[Int32]FalseREQUIRED02147483647

Sample cURL

curl --location --request POST "{{ROOT}}/v4/reporting/overtime/" \
-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","overtime_type_ids": [{"overtime_type_id":"234"},{"overtime_type_id":"234"}],"status_id": "0","return_record_option_id": "1"}'

Sample response

[
    {
      "object_name":"user_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"staff_code",
      "type":"String",
      "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_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"department_name",
      "type":"String",
      "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":"overtime",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"overtime_id",
                "type":"[Int32]",
                "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":"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":"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":"request_note",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"approve_note",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"cancellation_note",
                "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":"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":"",
            }],
      "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 Monday, 26th January 2026 to try the full service, for Free!

Get your instant FREE account today
Close [X]
Schedule your personalised demo

Let us show you, in 20 minutes, how WhosOff can elevate your leave management process.

Simply enter your email address in the space provided below and one of our team will reach out and setup a personalised platform demonstration.


Book your demonstration now

Manage Cookie Consent

Cookies are used to store and/or access device information. Providing consent to these technologies allows us to process data such as browsing behaviour. Not consenting or removing consent may adversely affect some features and functions.

AdvertisingEnables storage related to advertising, for example, advertising campaign.
AnalyticsEnables storage related to analytics, for example, visit duration.
TargetingSets consent for sending user data to Google for online advertising purposes.
MarketingSets consent for personalized advertising.
Cookie Policy
Manage cookies