Home Features Tour Pricing
Blog Support Contact us
Call us today on +44 (0)1227 812932 Get your FREE Trial

Controller : Leave Type

VERSION: 4.0, DEPRECATED: NO

create retrieve retrieve-by-id retrieve-for-user update del Return to API overview

Calls: {root}/leave type

POSTcreate

Route: {root}/v4/leave-type/create
Request type User level Requires authentication Response type
BODY SUPERUSER Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
name STRING REQUIRED 0 50 - -
code STRING REQUIRED 0 2 - -
colour STRING REQUIRED 0 7 - -
deduct_allowance_id CUSTOM REQUIRED 0 2 - no (0)
yes (1)
no hours only (2)
requires_approval [BOOLEAN] REQUIRED - -
consecutive_duration MINUTE(INT32) REQUIRED 0 2147483647 - -
notes_visible_to_id CUSTOM REQUIRED 100 310 - staff (100)
approver (200)
superuser (300)
poweruser (310)
available_to_id CUSTOM REQUIRED 100 310 - staff (100)
approver (200)
superuser (300)
poweruser (310)
seen_by_id CUSTOM REQUIRED 100 310 - staff (100)
approver (200)
superuser (300)
poweruser (310)
min_notice_period [INT32] REQUIRED -2147483648 2147483647 - -
cancellation_period [INT32] REQUIRED -2147483648 2147483647 - -
include_department_level [BOOLEAN] REQUIRED - -
note_required [BOOLEAN] REQUIRED - -
email_request_id CUSTOM REQUIRED 0 4 - none (0)
staff approver notifier (1)
staff only (2)
staff approver (3)
approver only (4)
email_approve_id CUSTOM REQUIRED 0 4 - none (0)
staff approver notifier (1)
staff only (2)
staff approver (3)
approver only (4)
email_cancel_id CUSTOM REQUIRED 0 4 - none (0)
staff approver notifier (1)
staff only (2)
staff approver (3)
approver only (4)
status_id CUSTOM REQUIRED 0 1 - disabled (0)
active (1)
staff_url STRING OPTIONAL 0 500 - -
staff_note STRING OPTIONAL 0 500 - -
approver_url STRING OPTIONAL 0 500 - -
approver_note STRING OPTIONAL 0 500 - -
message STRING OPTIONAL 0 500 - -
cURL
curl --location --request POST "{{ROOT}}leave-type/create/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"name": "sample","code": "sample","colour": "sample","deduct_allowance_id": "0","requires_approval": false,"notes_visible_to_id": "100","available_to_id": "100","seen_by_id": "100","min_notice_period": "123456","cancellation_period": "123456","include_department_level": false,"note_required": false,"email_request_id": "0","email_approve_id": "0","email_cancel_id": "0","status_id": "0","staff_url": "sample","staff_note": "sample","approver_url": "sample","approver_note": "sample","message": "sample"}'

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


POSTretrieve

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

Params

Name Type Nullable? Required? Min. Max. Nest Custom
status_id CUSTOM REQUIRED 0 99 - disabled (0)
active (1)
both (99)
cURL
curl --location --request POST "{{ROOT}}leave-type/retrieve/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"status_id": "0"}'

Response object 
[
    {
      "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": 
  },
    {
      "object_name":"requires_approval",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"consecutive_duration",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"notes_visible_to_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"superuser",
                "value":"300"
            },
            {
                "name":"poweruser",
                "value":"310"
            }]
      "note": 
  },
    {
      "object_name":"available_to_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"superuser",
                "value":"300"
            },
            {
                "name":"poweruser",
                "value":"310"
            }]
      "note": 
  },
    {
      "object_name":"seen_by_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"superuser",
                "value":"300"
            },
            {
                "name":"poweruser",
                "value":"310"
            }]
      "note": 
  },
    {
      "object_name":"min_notice_period",
      "type":"minute(int32)",
      "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":"include_department_level",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"note_required",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"email_request_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"staff approver notifier",
                "value":"1"
            },
            {
                "name":"staff only",
                "value":"2"
            },
            {
                "name":"staff approver",
                "value":"3"
            },
            {
                "name":"approver only",
                "value":"4"
            }]
      "note": 
  },
    {
      "object_name":"email_approve_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"staff approver notifier",
                "value":"1"
            },
            {
                "name":"staff only",
                "value":"2"
            },
            {
                "name":"staff approver",
                "value":"3"
            },
            {
                "name":"approver only",
                "value":"4"
            }]
      "note": 
  },
    {
      "object_name":"email_cancel_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"staff approver notifier",
                "value":"1"
            },
            {
                "name":"staff only",
                "value":"2"
            },
            {
                "name":"staff approver",
                "value":"3"
            },
            {
                "name":"approver only",
                "value":"4"
            }]
      "note": 
  },
    {
      "object_name":"status_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"disabled",
                "value":"0"
            },
            {
                "name":"active",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"staff_url",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"staff_note",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_url",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_note",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"message",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]


GETretrieve by id

Route: {root}/v4/leave-type/retrieve-by-id

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

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

Params

Name Type Nullable? Required? Min. Max. Nest Custom
leave_type_id INT32 REQUIRED 0 2147483647 - -
cURL
curl --location --request GET "{{ROOT}}leave-type/retrieve-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_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": 
  },
    {
      "object_name":"requires_approval",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"consecutive_duration",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"notes_visible_to_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"superuser",
                "value":"300"
            },
            {
                "name":"poweruser",
                "value":"310"
            }]
      "note": 
  },
    {
      "object_name":"available_to_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"superuser",
                "value":"300"
            },
            {
                "name":"poweruser",
                "value":"310"
            }]
      "note": 
  },
    {
      "object_name":"seen_by_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"superuser",
                "value":"300"
            },
            {
                "name":"poweruser",
                "value":"310"
            }]
      "note": 
  },
    {
      "object_name":"min_notice_period",
      "type":"minute(int32)",
      "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":"include_department_level",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"note_required",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"email_request_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"staff approver notifier",
                "value":"1"
            },
            {
                "name":"staff only",
                "value":"2"
            },
            {
                "name":"staff approver",
                "value":"3"
            },
            {
                "name":"approver only",
                "value":"4"
            }]
      "note": 
  },
    {
      "object_name":"email_approve_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"staff approver notifier",
                "value":"1"
            },
            {
                "name":"staff only",
                "value":"2"
            },
            {
                "name":"staff approver",
                "value":"3"
            },
            {
                "name":"approver only",
                "value":"4"
            }]
      "note": 
  },
    {
      "object_name":"email_cancel_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"staff approver notifier",
                "value":"1"
            },
            {
                "name":"staff only",
                "value":"2"
            },
            {
                "name":"staff approver",
                "value":"3"
            },
            {
                "name":"approver only",
                "value":"4"
            }]
      "note": 
  },
    {
      "object_name":"status_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"disabled",
                "value":"0"
            },
            {
                "name":"active",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"staff_url",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"staff_note",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_url",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_note",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"message",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]


GETretrieve for user

Route: {root}/v4/leave-type/retrieve-for-user

Sample call: {root}/v4/leave-type/retrieve-for-user

Request type User level Requires authentication Response type
URL STAFF Yes Array()

cURL
curl --location --request GET "{{ROOT}}leave-type/retrieve-for-user/-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_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": 
  },
    {
      "object_name":"consecutive_duration",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"min_notice_period",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"note_required",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"can_request",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"can_record",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"cancellation_period",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]


PUTupdate

Route: {root}/v4/leave-type/update
Request type User level Requires authentication Response type
BODY SUPERUSER Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
leave_type_id INT32 REQUIRED 0 2147483647 - -
name STRING OPTIONAL 0 50 - -
code STRING OPTIONAL 0 2 - -
colour STRING OPTIONAL 0 7 - -
deduct_allowance_id CUSTOM ✓ OPTIONAL - no (0)
yes (1)
no hours only (2)
requires_approval [BOOLEAN] ✓ OPTIONAL - -
consecutive_duration MINUTE(INT32) ✓ OPTIONAL 0 2147483647 - -
notes_visible_to_id CUSTOM ✓ OPTIONAL - staff (100)
approver (200)
superuser (300)
poweruser (310)
available_to_id CUSTOM ✓ OPTIONAL - staff (100)
approver (200)
superuser (300)
poweruser (310)
seen_by_id CUSTOM ✓ OPTIONAL - staff (100)
approver (200)
superuser (300)
poweruser (310)
min_notice_period [INT32] ✓ OPTIONAL -2147483648 2147483647 - -
cancellation_period [INT32] ✓ OPTIONAL -2147483648 2147483647 - -
include_department_level [BOOLEAN] ✓ OPTIONAL - -
note_required [BOOLEAN] ✓ OPTIONAL - -
email_request_id CUSTOM ✓ OPTIONAL - none (0)
staff approver notifier (1)
staff only (2)
staff approver (3)
approver only (4)
email_approve_id CUSTOM ✓ OPTIONAL - none (0)
staff approver notifier (1)
staff only (2)
staff approver (3)
approver only (4)
email_cancel_id CUSTOM ✓ OPTIONAL - none (0)
staff approver notifier (1)
staff only (2)
staff approver (3)
approver only (4)
status_id CUSTOM ✓ OPTIONAL - disabled (0)
active (1)
staff_url STRING OPTIONAL 0 500 - -
staff_note STRING OPTIONAL 0 500 - -
approver_url STRING OPTIONAL 0 500 - -
approver_note STRING OPTIONAL 0 500 - -
message STRING OPTIONAL 0 500 - -
cURL
curl --location --request PUT "{{ROOT}}leave-type/update/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"leave_type_id": "123456","name": "sample","code": "sample","colour": "sample","deduct_allowance_id": "0","requires_approval": false,"notes_visible_to_id": "100","available_to_id": "100","seen_by_id": "100","min_notice_period": "123456","cancellation_period": "123456","include_department_level": false,"note_required": false,"email_request_id": "0","email_approve_id": "0","email_cancel_id": "0","status_id": "0","staff_url": "sample","staff_note": "sample","approver_url": "sample","approver_note": "sample","message": "sample"}'

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


DELETEdel

Route: {root}/v4/leave-type/del

Sample call: {root}/v4/leave-type/del/12345678/true

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

Params

Name Type Nullable? Required? Min. Max. Nest Custom
leave_type_id INT32 REQUIRED 0 2147483647 - -
force_removal BOOLEAN REQUIRED - -
cURL
curl --location --request DELETE "{{ROOT}}leave-type/del/12345678true-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \


Standard response object returned, see API Overview for structure.

INSTANTLY REDUCE TIME SPENT ON LEAVE MANAGEMENT

Get your long FREE trial today!

No obligation and no payment setup required.
Sign up today and get until Saturday, 25th November 2023 to try the full service, for Free!
 

Start Your Free Trial