# Breathe HR

BreatheHR is a simple, cloud-based HR software designed for SMEs to manage employee records, absences, performance reviews, and other HR processes.

- **Category:** human resources
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 51
- **Triggers:** 0
- **Slug:** `BREATHEHR`
- **Version:** 20260217_00

## Tools

### Approve Leave Request

**Slug:** `BREATHEHR_APPROVE_LEAVE_REQUEST`

Tool to approve a leave request in BreatheHR. Use when an authorized user needs to approve a pending leave request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | ID of the leave request to approve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Employee

**Slug:** `BREATHEHR_CREATE_EMPLOYEE`

Tool to create a new employee in BreatheHR. Use when you need to add a new employee record with their personal information, contact details, and employment information. Required fields are first_name, last_name, email, and company_join_date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hr` | boolean | No | Whether the employee has HR manager permissions |
| `ddi` | string | No | Direct dial-in number for the employee |
| `dob` | string | No | Employee's date of birth in YYYY-MM-DD format |
| `email` | string | Yes | Employee's work email address |
| `gender` | string | No | Employee's gender identifier |
| `salary` | object | No | Salary information |
| `status` | string ("Current employee" | "Pending leaver" | "Ex-employee") | No | Employee status enum |
| `division` | integer | No | Division ID the employee belongs to |
| `location` | integer | No | Location ID where the employee is based |
| `work_ext` | string | No | Work extension number |
| `ethnicity` | string | No | Employee's ethnicity |
| `job_title` | string | No | Employee's job title or position |
| `last_name` | string | Yes | Employee's last name |
| `department` | integer | No | Department ID the employee belongs to |
| `first_name` | string | Yes | Employee's first name |
| `middle_name` | string | No | Employee's middle name |
| `nationality` | string ("British" | "Afghan" | "Albanian" | "Algerian" | "Andorran" | "Angolan" | "Antiguans" | "Argentinean" | "Armenian" | "Australian" | "Austrian" | "Azerbaijani" | "Bahamian" | "Bahraini" | "Bangladeshi" | "Barbadian" | "Barbudans" | "Belarusian" | "Belgian" | "Belizean" | "Beninese" | "Bermudian" | "Bhutanese" | "Bolivian" | "Bosnian" | "Botswana" | "Brazilian" | "Bruneian" | "Bulgarian" | "Burkinabe" | "Burmese" | "Burundian" | "Cambodian" | "Cameroonian" | "Canadian" | "Cape Verdean" | "Caymanian" | "Central African" | "Chadian" | "Chilean" | "Chinese" | "Colombian" | "Comoran" | "Congolese" | "Cornish British" | "Costa Rican" | "Croatian" | "Cuban" | "Cypriot" | "Czech" | "Danish" | "Djibouti" | "Dominican" | "Dutch" | "East Timorese" | "Ecuadorean" | "Egyptian" | "Emirian" | "English" | "Equatorial Guinean" | "Eritrean" | "Estonian" | "Ethiopian" | "Fijian" | "Filipino" | "Finnish" | "French" | "Gabonese" | "Gambian" | "Georgian" | "German" | "Ghanaian" | "Greek" | "Grenadian" | "Guatemalan" | "Guinea-Bissauan" | "Guinean" | "Guyanese" | "Haitian" | "Herzegovinian" | "Honduran" | "Hongkonger" | "Hungarian" | "Icelander" | "Indian" | "Indonesian" | "Iranian" | "Iraqi" | "Irish" | "Israeli" | "Italian" | "Ivorian" | "Jamaican" | "Japanese" | "Jordanian" | "Kazakhstani" | "Kenyan" | "Kittian and Nevisian" | "Kuwaiti" | "Kyrgyz" | "Laotian" | "Latvian" | "Lebanese" | "Liberian" | "Libyan" | "Liechtensteiner" | "Lithuanian" | "Luxembourger" | "Macedonian" | "Malagasy" | "Malawian" | "Malaysian" | "Maldivan" | "Malian" | "Maltese" | "Marshallese" | "Mauritanian" | "Mauritian" | "Mexican" | "Micronesian" | "Moldovan" | "Monacan" | "Mongolian" | "Montenegrin" | "Moroccan" | "Mosotho" | "Motswana" | "Mozambican" | "Namibian" | "Nauruan" | "Nepalese" | "Netherlander" | "New Zealander" | "Ni-Vanuatu" | "Nicaraguan" | "Nigerian" | "Nigerien" | "North Korean" | "Northern Irish" | "Norwegian" | "Omani" | "Pakistani" | "Palauan" | "Palestinian" | "Panamanian" | "Papua New Guinean" | "Paraguayan" | "Peruvian" | "Polish" | "Portuguese" | "Qatari" | "Romanian" | "Russian" | "Rwandan" | "Saint Lucian" | "Salvadoran" | "Samoan" | "San Marinese" | "Sao Tomean" | "Saudi" | "Scottish" | "Senegalese" | "Serbian" | "Seychellois" | "Sierra Leonean" | "Singaporean" | "Slovakian" | "Slovenian" | "Solomon Islander" | "Somali" | "South African" | "South Korean" | "Spanish" | "Sri Lankan" | "Sudanese" | "Surinamer" | "Swazi" | "Swedish" | "Swiss" | "Syrian" | "Taiwanese" | "Tajik" | "Tanzanian" | "Thai" | "Togolese" | "Tongan" | "Trinidadian or Tobagonian" | "Tunisian" | "Turkish" | "Tuvaluan" | "Ugandan" | "Ukrainian" | "Uruguayan" | "USA" | "Uzbekistani" | "Venezuelan" | "Vietnamese" | "Vincentian" | "Welsh" | "Yemeni" | "Zambian" | "Zimbabwean") | No | Nationality enum with all supported values |
| `person_type` | string ("Employee" | "Contractor" | "Volunteer") | No | Person type enum |
| `work_mobile` | string | No | Employee's work mobile phone number |
| `employee_ref` | string | No | Employee reference number or employee ID |
| `ethnicity_id` | string | No | Ethnicity identifier |
| `home_telephone` | string | No | Employee's home telephone number |
| `job_start_date` | string | No | Date employee started their current job role in YYYY-MM-DD format |
| `marital_status` | string ("Single" | "Co-Habiting" | "Married" | "Civil Partnership" | "Separated" | "Divorced" | "Widowed") | No | Marital status enum |
| `personal_mobile` | string | No | Employee's personal mobile phone number |
| `working_pattern` | integer | No | Working pattern ID defining the employee's work schedule |
| `company_join_date` | string | Yes | Date employee joined the company in YYYY-MM-DD format |
| `full_or_part_time` | string ("Full-Time" | "Part-Time") | No | Employment type enum |
| `holiday_allowance` | integer | No | Holiday allowance ID defining the employee's leave entitlement |
| `working_pattern_id` | integer | No | Alternative field for working pattern ID |
| `holiday_allowance_id` | integer | No | Alternative field for holiday allowance ID |
| `national_insurance_no` | string | No | UK National Insurance Number |
| `ignore_working_pattern` | boolean | No | If true, ignores working pattern and allows manual entry of time lost when requesting leave |
| `statutory_holiday_country` | string | No | Name of the country for statutory holidays |
| `receives_statutory_holidays` | boolean | No | Whether the employee receives statutory holidays for their country |
| `statutory_holiday_country_id` | integer | No | ID of the country for statutory holidays |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Employee Change Request

**Slug:** `BREATHEHR_CREATE_EMPLOYEE_CHANGE_REQUEST`

Tool to create a change request for an employee field. Use when you need to update employee information such as job title, department, or salary.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The employee ID for whom the change request is being created. |
| `field` | string | Yes | The field name to change (e.g., 'job_title', 'department', 'salary'). |
| `value` | string | Yes | The new value for the field. |
| `approved` | boolean | No | Set to true to immediately apply the change without approval workflow. If false or omitted, the change requires approval. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Employee Expense

**Slug:** `BREATHEHR_CREATE_EMPLOYEE_EXPENSE`

Tool to create an employee expense record in BreatheHR. Use when an employee needs to submit a new expense claim for reimbursement or record a company-paid expense.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vat` | integer | No | The VAT (Value Added Tax) amount included in the expense, in the smallest currency unit (e.g., cents). Optional for jurisdictions using VAT. |
| `miles` | integer | No | The number of miles traveled if this is a mileage expense. Use together with company_mileage_rate_id for travel reimbursement. |
| `amount` | integer | Yes | The expense amount in the smallest currency unit (e.g., cents for USD, pence for GBP). For example, 5000 represents $50.00 or £50.00. |
| `client_name` | string | No | The name of the client if the expense is chargeable to a client. Required if chargeable_to_client is true. |
| `description` | string | Yes | A textual description of the expense (e.g., 'Office supplies purchase', 'Client meeting lunch'). |
| `employee_id` | integer | Yes | The unique identifier of the employee who incurred the expense. |
| `has_receipt` | boolean | No | Whether a receipt exists for this expense. Set to true if the employee has provided a receipt that can be uploaded separately. |
| `expense_date` | string | Yes | The date the expense was incurred, in YYYY-MM-DD format. |
| `company_project_id` | integer | No | The identifier for the company project this expense relates to, if applicable. Use to track expenses by project. |
| `payable_to_employee` | boolean | Yes | Whether the expense amount should be reimbursed/paid to the employee (true) or was paid by the company directly (false). |
| `chargeable_to_client` | boolean | No | Whether this expense should be charged/billed to a client. Set to true if the expense is billable to a client project. |
| `company_expense_type_id` | integer | Yes | The identifier for the expense type/category as defined in the company's expense configuration. |
| `company_mileage_rate_id` | integer | No | The identifier for the mileage reimbursement rate if this is a mileage expense. Use this for travel expenses calculated by distance. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Employee Expense Claim

**Slug:** `BREATHEHR_CREATE_EMPLOYEE_EXPENSE_CLAIM`

Tool to create a new expense claim for an employee. Use when you need to submit expenses for reimbursement by grouping one or more unclaimed expense records into a claim.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employee_id` | integer | Yes | The ID of the employee for whom the expense claim is being created |
| `employee_expense_ids` | array | Yes | Array of employee expense IDs to include in the claim. Must reference unclaimed expenses (expenses where employee_expense_claim_id is null). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Employee Sickness

**Slug:** `BREATHEHR_CREATE_EMPLOYEE_SICKNESS`

Tool to create a sickness record for an employee in BreatheHR. Use when you need to log an employee's sick leave with details like type, dates, and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the employee to create sickness for |
| `reason` | string | No | Reason for the sickness |
| `status` | string ("open" | "returned" | "rejected" | "clarification" | "closed") | No | Enum for sickness status values. |
| `end_date` | string | No | End date of the sickness in YYYY-MM-DD format |
| `half_day` | boolean | No | Whether this is a half day sickness |
| `half_end` | boolean | No | Whether the end date is a half day |
| `half_start` | boolean | No | Whether the start date is a half day |
| `start_date` | string | Yes | Start date of the sickness in YYYY-MM-DD format (required) |
| `review_notes` | string | No | Review notes for the sickness record |
| `half_end_am_pm` | string ("am" | "pm") | No | Enum for half day period values. |
| `half_start_am_pm` | string ("am" | "pm") | No | Enum for half day period values. |
| `company_sicknesstype_id` | integer | Yes | The ID of the company sickness type (required) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Employee Expense

**Slug:** `BREATHEHR_DELETE_EMPLOYEE_EXPENSE`

Tool to delete an employee expense by ID. Use when you need to remove an expense record from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the employee expense to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Employee Training Course

**Slug:** `BREATHEHR_DELETE_EMPLOYEE_TRAINING_COURSE`

Tool to delete an employee training course record by its ID. Use when you need to remove a training record from an employee's profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the employee training course record to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account

**Slug:** `BREATHEHR_GET_ACCOUNT`

Tool to retrieve account information including ID, name, domain, UUID, and RTA usage status. Use when you need to check account details or verify account configuration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee

**Slug:** `BREATHEHR_GET_EMPLOYEE`

Tool to retrieve detailed information about a specific employee by ID. Use when you need comprehensive employee data including personal details, employment information, organizational structure, and compensation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the employee to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Expense

**Slug:** `BREATHEHR_GET_EMPLOYEE_EXPENSE`

Tool to retrieve a specific employee expense record by ID. Use when you need detailed information about a particular expense.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Employee expense record ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Leave Request

**Slug:** `BREATHEHR_GET_LEAVE_REQUEST`

Tool to retrieve detailed information about a specific leave request by ID. Use when you need to check the status, dates, or details of a particular leave/absence request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the leave request to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Leave Request Cancelling

**Slug:** `BREATHEHR_GET_LEAVE_REQUEST_CANCELLING`

Tool to retrieve the leave request that is being cancelled. Use when you need to find the original leave request associated with a cancellation request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the leave request to get cancelling information for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Absences

**Slug:** `BREATHEHR_LIST_ABSENCES`

Tool to list all absences with optional filtering by date range, employee, department, and type. Use when you need to retrieve absence records from BreatheHR with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. Defaults to 1. |
| `type` | string ("Holiday" | "OtherLeave") | No | Type of absences to return. Use 'Holiday' for holidays or 'OtherLeave' for other leave types. |
| `end_date` | string | No | Return absences on or before this date. Format: YYYY-MM-DD. |
| `per_page` | integer | No | Number of results to return per page. Useful for pagination. |
| `rotacloud` | boolean | No | Return absences where rotacloud is not excluded from integration. |
| `start_date` | string | No | Return absences on or after this date. Format: YYYY-MM-DD. |
| `employee_id` | integer | No | Return absences for this employee only. Alternative to using /employees/:id/absences endpoint. |
| `department_id` | integer | No | Return absences for this department only. Alternative to using /departments/:id/absences endpoint. |
| `other_leave_reason_id` | integer | No | ID of other leave reason to filter by. Used to filter absences by specific leave reason. |
| `exclude_cancelled_absences` | boolean | No | When set to true, cancelled absences will not be returned in the results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Benefits

**Slug:** `BREATHEHR_LIST_BENEFITS`

Tool to retrieve a list of employee benefits with optional pagination. Use when you need to access benefit information across employees.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. Defaults to 1 if not specified. |
| `per_page` | integer | No | Number of results to return per page. If not specified, uses API default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Bonuses

**Slug:** `BREATHEHR_LIST_BONUSES`

Tool to retrieve employee bonuses from BreatheHR with pagination support. Use when you need to list bonuses across the organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. Must be a positive integer. |
| `per_page` | integer | No | Number of results to return per page. Must be a positive integer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Change Requests

**Slug:** `BREATHEHR_LIST_CHANGE_REQUESTS`

Tool to list change requests from BreatheHR. Use when you need to retrieve change requests with optional pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Company Documents

**Slug:** `BREATHEHR_LIST_COMPANY_DOCUMENTS`

Tool to retrieve a paginated list of company documents from BreatheHR. Use when you need to access or view company-wide documents stored in the BreatheHR system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number of results to fetch. Defaults to 1 for the first page. |
| `per_page` | integer | No | Number of results to return per page. If not specified, the API will use its default page size. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Company Projects

**Slug:** `BREATHEHR_LIST_COMPANY_PROJECTS`

Tool to list company projects from BreatheHR. Use when you need to retrieve all projects associated with the company. Supports pagination via page and per_page parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number of results to fetch. Must be a positive integer. |
| `per_page` | integer | No | Number of results to return per page. Must be a positive integer if specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Company Training Types

**Slug:** `BREATHEHR_LIST_COMPANY_TRAINING_TYPES`

Tool to list company training types. Use when you need to retrieve available training type categories. Returns paginated training type records including identifiers, names, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Department Absences

**Slug:** `BREATHEHR_LIST_DEPARTMENT_ABSENCES`

Tool to list absences for a specific department. Use when you need to retrieve absence records for employees in a department. Supports pagination and filtering of cancelled absences.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | ID of department to return absences for |
| `page` | integer | No | Page of results to fetch. Default is 1. |
| `per_page` | integer | No | Number of results to return per page. Default is 50, maximum is 100. |
| `exclude_cancelled_absences` | boolean | No | Don't return cancelled leave requests. Set to true to exclude cancelled absences. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Department Benefits

**Slug:** `BREATHEHR_LIST_DEPARTMENT_BENEFITS`

Tool to list all employee benefits for a specific department. Use when you need to retrieve benefit information including contributions, dates, and provider details for department members.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the department to retrieve benefits for. |
| `page` | integer | No | Page number of results to fetch. Defaults to 1. |
| `per_page` | integer | No | Number of results to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Department Bonuses

**Slug:** `BREATHEHR_LIST_DEPARTMENT_BONUSES`

Tool to list bonuses for a specific department. Use when you need to retrieve bonus information for employees within a department. Returns paginated bonus records including amounts, award dates, and descriptions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the department to retrieve bonuses for. |
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Department Leave Requests

**Slug:** `BREATHEHR_LIST_DEPARTMENT_LEAVE_REQUESTS`

Tool to list leave requests for a specific department. Use when you need to retrieve absence or time-off requests for employees within a particular department.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | ID of department to return leave requests for |
| `page` | integer | No | Page of results to fetch. Defaults to 1. |
| `per_page` | integer | No | Number of results to return per page. Controls pagination size. |
| `exclude_cancelled_requests` | boolean | No | Don't return cancelled leave requests. Set to true to exclude cancelled requests from the results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Departments

**Slug:** `BREATHEHR_LIST_DEPARTMENTS`

Tool to list all company departments from BreatheHR. Use when you need to retrieve department information including IDs and names. Returns a paginated list of departments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Department Salaries

**Slug:** `BREATHEHR_LIST_DEPARTMENT_SALARIES`

Tool to list salaries for a specific department. Use when you need to retrieve salary information for employees within a department. Returns paginated salary records including amounts, dates, and basis information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the department to retrieve salaries for. |
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Divisions

**Slug:** `BREATHEHR_LIST_DIVISIONS`

Tool to retrieve all company divisions. Use when you need to view organizational divisions or departments.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Absences

**Slug:** `BREATHEHR_LIST_EMPLOYEE_ABSENCES`

Tool to list absences for a specific employee from BreatheHR. Use when you need to retrieve absence records for an employee with optional filtering and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | ID of employee to return absences for |
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |
| `exclude_cancelled_absences` | boolean | No | Don't return cancelled leave requests |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Benefits

**Slug:** `BREATHEHR_LIST_EMPLOYEE_BENEFITS`

Tool to list benefits for an employee. Use when you need to retrieve all benefits associated with a specific employee by their ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The employee ID to retrieve benefits for |
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Bonuses

**Slug:** `BREATHEHR_LIST_EMPLOYEE_BONUSES`

Tool to list bonuses for a specific employee. Use when you need to retrieve all bonus records associated with an employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID to fetch bonuses for |
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Change Requests

**Slug:** `BREATHEHR_LIST_EMPLOYEE_CHANGE_REQUESTS`

Tool to list change requests for a specific employee. Use when you need to retrieve pending or historical change requests associated with an employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The employee ID to fetch change requests for |
| `page` | integer | No | Page of results to fetch |
| `per_page` | integer | No | Number of results to return per page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Expense Claims

**Slug:** `BREATHEHR_LIST_EMPLOYEE_EXPENSE_CLAIMS`

Tool to list employee expense claims from BreatheHR. Use when you need to retrieve expense claims, optionally filtered by employee ID or claim state. Supports pagination for large result sets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. Defaults to 1. |
| `per_page` | integer | No | Number of results to return per page. If not specified, the API will use its default page size. |
| `employee_id` | integer | No | Return expense claims for this employee only. If not provided, returns expense claims for all employees. |
| `state_filter` | string ("submitted" | "approved" | "completed" | "rejected") | No | Filter expense claims by their current state. Only claims matching this state will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Expenses

**Slug:** `BREATHEHR_LIST_EMPLOYEE_EXPENSES`

Tool to list employee expenses from BreatheHR. Use when you need to retrieve expense records, optionally filtered by employee or claim status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number of results to fetch. Defaults to 1 if not specified. |
| `per_page` | integer | No | Number of results to return per page. If not specified, the API default applies. |
| `employee_id` | integer | No | Return expenses for this employee only. If not specified, returns expenses for all employees. |
| `show_claimed` | boolean | No | Include claimed expenses in search. If not specified, the API default behavior applies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Holiday Years

**Slug:** `BREATHEHR_LIST_EMPLOYEE_HOLIDAY_YEARS`

Tool to get holiday years for an employee. Use when you need to retrieve holiday allowance information for a specific employee, optionally filtered by date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | ID of employee to return holiday years for |
| `for_date` | string | No | Return employee_holiday_years that include this date. Format: YYYY-MM-DD |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Jobs

**Slug:** `BREATHEHR_LIST_EMPLOYEE_JOBS`

Tool to list employee jobs with optional employee filtering. Use when you need to retrieve job information for employees. Returns paginated job records including title, employment type, dates, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |
| `employee_id` | integer | No | Return jobs for this employee only. If not provided, returns jobs for all employees. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Leave Requests

**Slug:** `BREATHEHR_LIST_EMPLOYEE_LEAVE_REQUESTS`

Tool to list leave requests for a specific employee. Use when you need to retrieve leave request history including vacation, sick leave, and other absence requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | ID of the employee to return leave requests for |
| `exclude_cancelled_requests` | boolean | No | Don't return cancelled leave requests when set to true |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employees

**Slug:** `BREATHEHR_LIST_EMPLOYEES`

Tool to list all employees in the BreatheHR account with pagination support. Use when you need to retrieve employee information from BreatheHR. Supports filtering by role type (HR, line manager) and RotaCloud integration status. Pagination is handled via page and per_page query parameters, with metadata returned in HTTP headers (Link and Total headers).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. Defaults to 1. |
| `filter` | string ("hr" | "line_manager" | "either" | "neither") | No | Filter employees by their role type. |
| `per_page` | integer | No | Number of results to return per page. Maximum is 100, default is 25. |
| `rotacloud` | boolean | No | Return only employees where rotacloud integration is not excluded. When true, filters to employees included in RotaCloud integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Salaries

**Slug:** `BREATHEHR_LIST_EMPLOYEE_SALARIES`

Tool to list salaries for a specific employee. Use when you need to retrieve salary history or current salary information for an employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the employee whose salaries to retrieve. |
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Training Courses

**Slug:** `BREATHEHR_LIST_EMPLOYEE_TRAINING_COURSES`

Tool to list employee training courses with optional filtering by employee and pagination support. Use when you need to retrieve training course records for employees.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |
| `employee_id` | integer | No | Return training courses for this employee only. If not provided, returns courses for all employees. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Holiday Allowances

**Slug:** `BREATHEHR_LIST_HOLIDAY_ALLOWANCES`

Tool to list holiday allowances configured for the company. Returns tiered holiday allowances based on years of service (1-10 years). Use when you need to view or retrieve holiday entitlement configurations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Leave Requests

**Slug:** `BREATHEHR_LIST_LEAVE_REQUESTS`

Tool to list all leave requests with optional date and employee/department filtering. Use when you need to retrieve absence or time-off requests across the organization, optionally filtered by date range, employee, or department.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. Defaults to 1. |
| `end_date` | string | No | Return leave requests starting on or before this date (YYYY-MM-DD format) |
| `per_page` | integer | No | Number of results to return per page. Controls pagination size. |
| `rotacloud` | boolean | No | Return leave requests where rotacloud is not excluded from integration. When true, filters to leave requests included in RotaCloud integration. |
| `start_date` | string | No | Return leave requests starting on or after this date (YYYY-MM-DD format) |
| `employee_id` | integer | No | Return leave requests for this employee only |
| `department_id` | integer | No | Return leave requests for this department only |
| `exclude_cancelled_requests` | boolean | No | Don't return cancelled leave requests. Set to true to exclude cancelled requests from the results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Locations

**Slug:** `BREATHEHR_LIST_LOCATIONS`

Tool to list all company locations from BreatheHR. Use when you need to retrieve location information including IDs and names. Returns a paginated list of locations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Other Leave Reasons

**Slug:** `BREATHEHR_LIST_OTHER_LEAVE_REASONS`

Tool to list other leave reasons configured for the company in BreatheHR. Use when you need to retrieve available custom leave types beyond standard leave.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Salaries

**Slug:** `BREATHEHR_LIST_SALARIES`

Tool to list employee salaries with pagination support. Use when you need to retrieve salary information across the organization. Returns paginated salary records including amounts, dates, and basis information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. |
| `per_page` | integer | No | Number of results to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sicknesses

**Slug:** `BREATHEHR_LIST_SICKNESSES`

Tool to list all sickness records from BreatheHR with optional date filtering. Use when you need to retrieve sickness absence records with support for filtering by employee, department, date range, and RotaCloud integration status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. |
| `end_date` | string | No | Return sicknesses starting on or before this date in YYYY-MM-DD format |
| `per_page` | integer | No | Number of results to return per page. |
| `rotacloud` | boolean | No | Return sicknesses for employees without exclude from rotacloud. When true, filters to employees included in RotaCloud integration. |
| `start_date` | string | No | Return sicknesses starting on or after this date in YYYY-MM-DD format |
| `employee_id` | integer | No | Return sicknesses for this employee only |
| `department_id` | integer | No | Return sicknesses for this department only |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Working Patterns

**Slug:** `BREATHEHR_LIST_WORKING_PATTERNS`

Tool to list all working patterns defined in the BreatheHR account with pagination support. Use when you need to retrieve working pattern information including weekly schedules, hours per day, and default patterns. Returns complete details for each pattern including day-by-day breakdowns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch. Defaults to 1. |
| `per_page` | integer | No | Number of results to return per page. Maximum is 100, default is 25. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reject Leave Request

**Slug:** `BREATHEHR_REJECT_LEAVE_REQUEST`

Tool to reject a leave request in BreatheHR. Use when an authorized user needs to decline an employee's time-off request with a provided reason.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | ID of the leave request to reject |
| `rejection_reason` | string | Yes | Reason for rejecting the leave request. This will be communicated to the employee. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Expense Claim

**Slug:** `BREATHEHR_UPDATE_EMPLOYEE_EXPENSE_CLAIM`

Tool to approve or reject an employee expense claim. Use when you need to update the approval status of an expense claim by providing the claim ID and approver/rejector ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the employee expense claim to update. |
| `approve` | boolean | Yes | Whether to approve (true) or reject (false) the expense claim. |
| `rejection_reason` | string | No | Reason for rejecting the expense claim. Required when approve is false. |
| `approver_rejector_id` | integer | Yes | The unique identifier of the employee who is approving or rejecting the claim. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update employee training course

**Slug:** `BREATHEHR_UPDATE_EMPLOYEE_TRAINING_COURSE`

Tool to update an existing employee training course record in BreatheHR. Use when you need to modify training details such as status, dates, notes, outcome, or other training attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the employee training course to update. This is required to identify which training record to modify. |
| `cost` | string | No | The cost of the training course as a float string. |
| `name` | string | No | The name or title of the training course. |
| `notes` | string | No | Additional notes or comments about the training course. |
| `end_on` | string | No | The end date of the training course in date format (YYYY-MM-DD). |
| `status` | string ("Requested" | "Approved" | "Pending" | "Rejected" | "Booked" | "Completed" | "Cancelled" | "Non-attended" | "Expired") | No | Status values for employee training courses. |
| `outcome` | string ("Passed" | "passed" | "Failed" | "failed") | No | Outcome values for completed training courses. |
| `half_day` | boolean | No | Whether the training is a half-day course (true) or full-day (false). |
| `start_on` | string | No | The start date of the training course in date format (YYYY-MM-DD). |
| `followup_date` | string | No | The date for following up on the training in date format (YYYY-MM-DD). |
| `half_day_am_pm` | string ("am" | "pm") | No | Period for half-day training courses. |
| `company_training_type_id` | integer | No | The ID of the training type classification. |
| `remuneration_currency_id` | integer | No | The ID of the currency for the training cost. |
| `company_training_category_id` | integer | No | The ID of the training category this course belongs to. |
| `company_training_provider_id` | integer | No | The ID of the training provider or organization delivering the course. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Sickness

**Slug:** `BREATHEHR_UPDATE_SICKNESS`

Tool to update an existing sickness record in BreatheHR. Use when you need to modify sickness details such as status, dates, review notes, or other sickness attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the sickness record to update |
| `reason` | string | No | Reason for the sickness |
| `status` | string ("open" | "returned" | "rejected" | "clarification" | "closed") | No | Enum for sickness status values. |
| `end_date` | string | No | End date of the sickness in YYYY-MM-DD format |
| `half_day` | boolean | No | Whether this is a half day sickness |
| `half_end` | boolean | No | Whether the end date is a half day |
| `half_start` | boolean | No | Whether the start date is a half day |
| `start_date` | string | No | Start date of the sickness in YYYY-MM-DD format |
| `review_notes` | string | No | Review notes for the sickness record |
| `half_end_am_pm` | string ("am" | "pm") | No | Enum for half day period values. |
| `half_start_am_pm` | string ("am" | "pm") | No | Enum for half day period values. |
| `company_sicknesstype_id` | integer | No | The ID of the company sickness type |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
