Documentation Index Fetch the complete documentation index at: https://mintlify.com/Falasefemi2/companyflow/llms.txt
Use this file to discover all available pages before exploring further.
Create a new leave type configuration for a company. Leave types define the different categories of leave available to employees (e.g., Annual Leave, Sick Leave, etc.) along with their policies and allowances.
Authentication Requires authentication with Bearer token. Available to:
Path Parameters The unique identifier of the company (UUID format) Example: "123e4567-e89b-12d3-a456-426614174000"
Request Body Name of the leave type Example: "Annual Leave"
Short code for the leave type (typically uppercase) Example: "AL"
Detailed description of the leave type Example: "Paid annual vacation time for all employees"
Total number of days allowed per year for this leave type Example: 20
Whether this leave type is paid or unpaid Example: true
Whether documentation (e.g., medical certificate) is required Example: false
Whether unused days can be carried forward to the next year Example: true
Maximum number of days that can be carried forward Example: 5
Hex color code for calendar display Example: "#3B82F6"
Status of the leave type: active or inactive Example: "active"
Response Indicates if the request was successful
The created leave type object Show LeaveType properties
Unique identifier for the leave type
Short code for the leave type
Total days allowed per year
Whether the leave is paid
Whether documentation is required
Whether carry forward is allowed
Maximum carry forward days
Status: active or inactive
curl -X POST https://api.companyflow.com/companies/123e4567-e89b-12d3-a456-426614174000/leave-types \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Annual Leave", "code": "AL", "description": "Paid annual vacation time for all employees", "daysAllowed": 20, "isPaid": true, "requiresDocumentation": false, "carryForwardAllowed": true, "maxCarryForwardDays": 5, "colorCode": "#3B82F6", "status": "active" }'
201 - Created
400 - Bad Request
401 - Unauthorized
{ "success" : true , "data" : { "id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890" , "company_id" : "123e4567-e89b-12d3-a456-426614174000" , "name" : "Annual Leave" , "code" : "AL" , "description" : "Paid annual vacation time for all employees" , "days_allowed" : 20 , "is_paid" : true , "requires_documentation" : false , "carry_forward_allowed" : true , "max_carry_forward_days" : 5 , "color_code" : "#3B82F6" , "status" : "active" , "created_at" : "2025-03-03T10:30:00Z" , "updated_at" : "2025-03-03T10:30:00Z" } }
After creating a leave type, employees in the company will need to have leave balances initialized for this type before they can request leave.