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 : User Allowance

DEPRECATED: NO

create retrieve my update del Return to API overview

Calls: {root}/{version}/user allowance


POST/v4/create
Route {root}/v4/user-allowance/create
Request type BODY
User level SUPER USER
Requires authentication Yes
Response type Single

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
user_id [INT32] REQUIRED 0 2147483647 - -
start_date DATE REQUIRED - -
opening MINUTE(INT32) REQUIRED -2147483648 2147483647 - -
remaining MINUTE(INT32) REQUIRED -2147483648 2147483647 - -
carryover_opening MINUTE(INT32) REQUIRED -2147483648 2147483647 - -
carryover_remaining MINUTE(INT32) REQUIRED -2147483648 2147483647 - -
locked BOOLEAN OPTIONAL - -

Sample cURL

curl --location --request POST "{{ROOT}}/v4/user-allowance/create/" \
-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","locked": false}'

Sample response

[
    {
      "object_name":"user_allowance_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]
POST/v4/retrieve
Route {root}/v4/user-allowance/retrieve
Request type BODY
User level STAFF
Requires authentication Yes
Response type Array()

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
user_id INT32 REQUIRED 1 2147483647 - -
start_date DATE OPTIONAL - -
end_date DATE OPTIONAL - -

Sample cURL

curl --location --request POST "{{ROOT}}/v4/user-allowance/retrieve/" \
-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":"user_allowance_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":"start_date",
      "type":"Date",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"end_date",
      "type":"Date",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"allowance_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"days",
                "value":"0"
            },
            {
                "name":"hours",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"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": 
  },
    {
      "object_name":"pending",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"locked",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"carryover_expiry_date",
      "type":"Date",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]
POST/v4/my
Route {root}/v4/user-allowance/my
Request type BODY
User level STAFF
Requires authentication Yes
Response type Array()

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
start_date DATE REQUIRED - -
end_date DATE REQUIRED - -

Sample cURL

curl --location --request POST "{{ROOT}}/v4/user-allowance/my/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{}'

Sample response

[
    {
      "object_name":"user_allowance_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":"start_date",
      "type":"Date",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"end_date",
      "type":"Date",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"allowance_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"days",
                "value":"0"
            },
            {
                "name":"hours",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"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": 
  },
    {
      "object_name":"pending",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"locked",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"carryover_expiry_date",
      "type":"Date",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]
PUT/v4/update
Route {root}/v4/user-allowance/update
Request type BODY
User level SUPER USER
Requires authentication Yes
Response type Single

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
user_allowance_id [INT32] REQUIRED 0 2147483647 - -
opening MINUTE(INT32) ✓ OPTIONAL -2147483648 2147483647 - -
remaining MINUTE(INT32) ✓ OPTIONAL -2147483648 2147483647 - -
carryover_opening MINUTE(INT32) ✓ OPTIONAL -2147483648 2147483647 - -
carryover_remaining MINUTE(INT32) ✓ OPTIONAL -2147483648 2147483647 - -
locked BOOLEAN OPTIONAL - -

Sample cURL

curl --location --request PUT "{{ROOT}}/v4/user-allowance/update/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"user_allowance_id": "123456","locked": false}'

Sample response

[
    {
      "object_name":"user_allowance_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]
DELETE/v4/del
Route {root}/v4/user-allowance/del
Request type URL
User level SUPER USER
Requires authentication Yes
Response type Single
Sample call{root}/v0/user-allowance/del/12345678

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
user_allowance_id INT32 REQUIRED 0 2147483647 - -

Sample cURL

curl --location --request DELETE "{{ROOT}}/v4/user-allowance/del/12345678-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \

Sample response

Standard response object returned, see API Overview for structure.


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