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 : Leave

VERSION: 4.0, DEPRECATED: NO

When submitting leave the start_date and end_date should be supplied as follows...

  • All Day 28th March 2023 - start_date 2023-03-28T00:00 end_date 2023-03-29T00:00
  • Multi-day 23rd/28th March 2023 - start_date 2023-03-23T00:00 end_date 2023-03-29T00:00
  • AM 28th March 2023 Morning - start_date 2023-03-28T00:00 end_date 2023-03-28T12:00
  • PM 28th March 2023 Afternoon - start_date 2023-03-28T12:00 end_date 2023-03-29T00:00
  • Hours 28th March 2023 09:00 - 09:15 - start_date 2023-03-28T09:00 end_date 2023-03-28T09:15 (15 minute increments only)

    get-by-id get-declined-by-id my get validate submit approve-decline cancel Return to API overview

    Calls: {root}/leave


    GETget by id

    Route: {root}/v4/leave/get-by-id

    Sample call: {root}/v4/leave/get-by-id/12345678

    Request type User level Requires authentication Response type
    URL STAFF Yes Single

    Params

    Name Type Nullable? Required? Min. Max. Nest Custom
    leave_id INT32 REQUIRED 0 2147483647 - -
    cURL
    curl --location --request GET "{{ROOT}}leave/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: */*" \

    Response object 
    [
        {
          "object_name":"cancellation_period",
          "type":"minute(int32)",
          "is_nullable":false,
          "nest":null,
          "custom":null
          "note": 
      },
        {
          "object_name":"image_url_small",
          "type":"String",
          "is_nullable":false,
          "nest":null,
          "custom":null
          "note": 
      },
        {
          "object_name":"image_url_large",
          "type":"String",
          "is_nullable":false,
          "nest":null,
          "custom":null
          "note": 
      },
        {
          "object_name":"leave_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_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":"leave_type_id",
          "type":"Int32",
          "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":"cancellation_period_id",
          "type":"[Int32]",
          "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":"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":"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":"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_date",
          "type":"DateTime",
          "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":"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":"last_reminder_date",
          "type":"DateTime",
          "is_nullable":false,
          "nest":null,
          "custom":null
          "note": 
      },
        {
          "object_name":"leave_type_status_id",
          "type":"custom",
          "is_nullable":false,
          "nest":null,
          "custom":[
                {
                    "name":"disabled",
                    "value":"0"
                },
                {
                    "name":"active",
                    "value":"1"
                }]
          "note": 
      }
    ]



    GETget declined by id

    Route: {root}/v4/leave/get-declined-by-id

    Sample call: {root}/v4/leave/get-declined-by-id/12345678

    Request type User level Requires authentication Response type
    URL STAFF Yes Single

    Params

    Name Type Nullable? Required? Min. Max. Nest Custom
    leave_id INT32 REQUIRED 0 2147483647 - -
    cURL
    curl --location --request GET "{{ROOT}}leave/get-declined-by-id/12345678-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \

    Response object 
    [
        {
          "object_name":"leave_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_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":"leave_type_id",
          "type":"Int32",
          "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":"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":"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":"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":"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_date",
          "type":"DateTime",
          "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":"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":"declined_by_first_name",
          "type":"String",
          "is_nullable":false,
          "nest":null,
          "custom":null
          "note": 
      },
        {
          "object_name":"declined_by_last_name",
          "type":"String",
          "is_nullable":false,
          "nest":null,
          "custom":null
          "note": 
      },
        {
          "object_name":"declined_date",
          "type":"DateTime",
          "is_nullable":false,
          "nest":null,
          "custom":null
          "note": 
      }
    ]



    POSTmy

    Route: {root}/v4/leave/my
    Request type User level Requires authentication Response type
    BODY STAFF Yes Single

    Params

    Name Type Nullable? Required? Min. Max. Nest Custom
    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 OPTIONAL - approved and pending (0)
    pending only (1)
    approved only (100)
    include_leave BOOLEAN OPTIONAL - -
    include_work BOOLEAN OPTIONAL - -
    include_free_restricted BOOLEAN OPTIONAL - -

    Nested object(s)[]

    Object name Param name Type Is Nullable? Required? Min. Max.
    leave_type_ids
    leave_type_id[Int32]FalseREQUIRED02147483647
    cURL
    curl --location --request POST "{{ROOT}}leave/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","leave_type_ids": [{"leave_type_id":"234"},{"leave_type_id":"234"}],"status_id": "0","include_leave": false,"include_work": false,"include_free_restricted": false}'

    Response object 
    [
        {
          "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":"leave",
          "type":"NESTED",
          "is_nullable":false,
          "nest":[
                {
                    "object_name":"leave_id",
                    "type":"Int32",
                    "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":"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":"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":"allowance_duration",
                    "type":"minute(int32)",
                    "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":"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":"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_date",
                    "type":"DateTime",
                    "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":"approved_note",
                    "type":"String",
                    "is_nullable":False,
                    "nest":null,
                    "custom":null
                    "note":"",
                },
                {
                    "object_name":"cancellation_period",
                    "type":"minute(int32)",
                    "is_nullable":False,
                    "nest":null,
                    "custom":null
                    "note":"",
                },
                {
                    "object_name":"last_reminder_date",
                    "type":"DateTime",
                    "is_nullable":False,
                    "nest":null,
                    "custom":null
                    "note":"",
                }],
          "custom":null
          "note": 
      },
        {
          "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":"",
                }],
          "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":"",
                }],
          "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":"",
                }],
          "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": 
      }
    ]



    POSTget

    Route: {root}/v4/leave/get
    Request type User level Requires authentication Response type
    BODY APPROVER Yes Array()

    Params

    Name Type Nullable? Required? Min. Max. Nest Custom
    map_type_id CUSTOM REQUIRED 0 4 - company (0)
    department (1)
    tag (2)
    staff (3)
    my staff (4)
    map_id INT32 REQUIRED 0 2147483647 - -
    user_status_id CUSTOM ✓ OPTIONAL - disabled (0)
    active (1)
    both (99)
    leave_type_ids NESTED OPTIONAL List (Of leave_type_ids) -
    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 - -
    status_id CUSTOM OPTIONAL - approved and pending (0)
    pending only (1)
    approved only (100)
    cancelled only (900)
    declined only (930)
    approved and declined (1000)
    cancelled and declined (1010)

    Nested object(s)[]

    Object name Param name Type Is Nullable? Required? Min. Max.
    leave_type_ids
    leave_type_id[Int32]FalseREQUIRED02147483647
    cURL
    curl --location --request POST "{{ROOT}}leave/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","leave_type_ids": [{"leave_type_id":"234"},{"leave_type_id":"234"}],"date_option": "0","status_id": "0"}'

    Response object 
    [
        {
          "object_name":"leave_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_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":"leave_type_id",
          "type":"Int32",
          "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":"cancellation_period_id",
          "type":"[Int32]",
          "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":"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":"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":"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_date",
          "type":"DateTime",
          "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":"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":"last_reminder_date",
          "type":"DateTime",
          "is_nullable":false,
          "nest":null,
          "custom":null
          "note": 
      },
        {
          "object_name":"leave_type_status_id",
          "type":"custom",
          "is_nullable":false,
          "nest":null,
          "custom":[
                {
                    "name":"disabled",
                    "value":"0"
                },
                {
                    "name":"active",
                    "value":"1"
                }]
          "note": 
      }
    ]



    POSTvalidate

    Route: {root}/v4/leave/validate
    Request type User level Requires authentication Response type
    BODY STAFF Yes Single

    Params

    Name Type Nullable? Required? Min. Max. Nest Custom
    leave_id [INT32] ✓ OPTIONAL 0 2147483647 - -
    user_id [INT32] ✓ OPTIONAL 0 2147483647 - -
    leave_type_id [INT32] REQUIRED 0 2147483647 - -
    start_date DATETIME REQUIRED - -
    end_date DATETIME REQUIRED - -
    admin BOOLEAN OPTIONAL - -
    note STRING OPTIONAL 0 500 - -
    cURL
    curl --location --request POST "{{ROOT}}leave/validate/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"leave_id": "123456","user_id": "123456","leave_type_id": "123456","start_date": "20230401T00:00","end_date": "20230401T00:00","admin": false,"note": "sample"}'

    Response object 
    [
        {
          "object_name":"user_id",
          "type":"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":"free_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":"duration",
          "type":"minute(int32)",
          "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":"breakdown",
          "type":"NESTED",
          "is_nullable":false,
          "nest":[
                {
                    "object_name":"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":"allowance_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":"user_allowance_id",
                    "type":"[Int32]",
                    "is_nullable":False,
                    "nest":null,
                    "custom":null
                    "note":"",
                },
                {
                    "object_name":"allowance_start_date",
                    "type":"String",
                    "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":"remaining_deducted",
                    "type":"[Int32]",
                    "is_nullable":False,
                    "nest":null,
                    "custom":null
                    "note":"",
                },
                {
                    "object_name":"carryover_remaining_deducted",
                    "type":"[Int32]",
                    "is_nullable":False,
                    "nest":null,
                    "custom":null
                    "note":"",
                },
                {
                    "object_name":"pending_deducted",
                    "type":"[Int32]",
                    "is_nullable":False,
                    "nest":null,
                    "custom":null
                    "note":"",
                },
                {
                    "object_name":"remaining_deduction",
                    "type":"[Int32]",
                    "is_nullable":False,
                    "nest":null,
                    "custom":null
                    "note":"",
                },
                {
                    "object_name":"carryover_remaining_deduction",
                    "type":"[Int32]",
                    "is_nullable":False,
                    "nest":null,
                    "custom":null
                    "note":"",
                }],
          "custom":null
          "note": 
      }
    ]



    POSTsubmit

    Route: {root}/v4/leave/submit
    Request type User level Requires authentication Response type
    BODY STAFF Yes Single

    Params

    Name Type Nullable? Required? Min. Max. Nest Custom
    leave_id [INT32] ✓ OPTIONAL 0 2147483647 - -
    user_id INT32 OPTIONAL 0 2147483647 - -
    leave_type_id INT32 REQUIRED 0 2147483647 - -
    start_date DATETIME REQUIRED - -
    end_date DATETIME REQUIRED - -
    note STRING OPTIONAL 0 500 - -
    admin [BOOLEAN] REQUIRED - -
    cURL
    curl --location --request POST "{{ROOT}}leave/submit/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"leave_id": "123456","user_id": "123456","leave_type_id": "123456","start_date": "20230401T00:00","end_date": "20230401T00:00","note": "sample","admin": false}'

    Response object 
    [
        {
          "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":"leave_id",
          "type":"[Int32]",
          "is_nullable":false,
          "nest":null,
          "custom":null
          "note": 
      },
        {
          "object_name":"message",
          "type":"String",
          "is_nullable":false,
          "nest":null,
          "custom":null
          "note": 
      }
    ]



    POSTapprove decline

    Route: {root}/v4/leave/approve-decline
    Request type User level Requires authentication Response type
    BODY APPROVER Yes Single

    Params

    Name Type Nullable? Required? Min. Max. Nest Custom
    leave_id INT32 REQUIRED 0 2147483647 - -
    option_id CUSTOM REQUIRED 1 2 - approve (1)
    decline (2)
    approver_note STRING OPTIONAL 0 500 - -
    cURL
    curl --location --request POST "{{ROOT}}leave/approve-decline/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"leave_id": "123456","option_id": "1","approver_note": "sample"}'

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



    POSTcancel

    Route: {root}/v4/leave/cancel
    Request type User level Requires authentication Response type
    BODY STAFF Yes Single

    Params

    Name Type Nullable? Required? Min. Max. Nest Custom
    leave_id INT32 REQUIRED 0 2147483647 - -
    cancellation_note STRING OPTIONAL 0 500 - -
    admin [BOOLEAN] REQUIRED - -
    cURL
    curl --location --request POST "{{ROOT}}leave/cancel/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"leave_id": "123456","cancellation_note": "sample","admin": false}'

    Response object 
    [
        {
          "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 Saturday, 26th July 2025 to try the full service, for Free!

    Get your instant FREE account today
    Close [X] Book your FREE WhosOff demo today
    Get a personalised demo

    Discover how WhosOff can elevate your leave management processes with a 20-min guided walkthrough.

    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