BreatheHR API Integration

These are the list of integration use cases supported by Knit for BreatheHR API as part of the HRIS category

Delete Employee Expense

ID: delete_employee_expense
Operation: write
Entities: employee, employee expense, company
Summary: The Delete Employee Expense API allows you to delete an employee expense by specifying the expense ID in the path parameters. The API uses the DELETE HTTP method and returns a JSON response containing details of the deleted expense, including fields such as id, employee_id, account_id, expense_date, description, amount, and more. The response is optional and may include various fields related to the expense.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Employee Expense Claim

ID: delete_employee_expense_claim
Operation: write
Entities: approver, employee expense claim, employee
Summary: The Delete Employee Expense Claim API allows users to delete an employee expense claim by specifying the claim ID in the path parameters. The API supports pagination through optional query parameters 'page' and 'per_page'. The response returns a JSON object containing details of the deleted expense claim, including employee information, claim status, and other related metadata. All fields in the response are optional and may not be present if not applicable.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Employee Training Course

ID: delete_employee_training_course
Operation: write
Entities: employee training course, company training provider, employee
Summary: The Delete Employee Training Course API allows you to delete a specific employee training course by its unique identifier. The API requires the 'id' path parameter to specify which training course to delete. The response includes details of the deleted training course, such as its name, start and end dates, status, and associated employee information. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Sickness Record

ID: delete_sickness_record
Operation: write
Entities: company sickness type, sickness, employee
Summary: The Delete Sickness Record API allows you to delete a specific sickness record from the system using its unique ID. The request requires the 'id' parameter in the path to specify which sickness record to delete. The response returns a JSON object representing the deleted sickness record, including details such as company sickness type, employee, start and end dates, and other optional fields. The response content type is application/json.
Input Fields: Input Fields
Output Fields: Output Fields

Get Absences

ID: get_absences
Operation: read
Entities: department, employee, absence
Summary: The Get Absences API retrieves a list of absences from the BreatheHR system. It supports filtering by various query parameters such as type of absence, employee ID, department ID, and date range. The response includes details about each absence, including the employee information, approval status, leave reason, and dates. The response is paginated, and the number of results per page can be specified.
Input Fields: Input Fields
Output Fields: Output Fields

Get Account Details

ID: get_account_details
Operation: read
Entities: account
Summary: The Get Account Details API retrieves information about a specific account from the BreatheHR system. It does not require any input parameters. The response includes details such as the account's unique identifier (id), name, domain, universally unique identifier (uuid), and a boolean indicating if the account is using RTA. The response is returned in JSON format with headers specifying cache control, content length, and content type.
Input Fields: Input Fields
Output Fields: Output Fields

Get Bonuses

ID: get_bonuses
Operation: read
Entities: bonus, employee perk
Summary: The Get Bonuses API endpoint retrieves a list of bonuses from the BreatheHR system. It supports pagination through the 'page' and 'per_page' query parameters, which are both optional. The response includes a list of bonuses, each with details such as id, description, amount, award date, creation date, and last update date. The response headers provide caching directives, content length, content type, and the total number of bonuses available.
Input Fields: Input Fields
Output Fields: Output Fields

Get Change Requests

ID: get_change_requests
Operation: read
Entities: value, change request, field
Summary: The Get Change Requests API retrieves a list of change requests from the BreatheHR system. It supports pagination through the 'page' and 'per_page' query parameters, which are optional. The response includes a list of change requests, each with details such as 'id', 'field_name', 'value', 'approved', 'approved_at', 'created_at', and 'updated_at'. The response headers provide caching directives, content length, content type, and the total number of change requests.
Input Fields: Input Fields
Output Fields: Output Fields

Get Company Departments

ID: get_company_departments
Operation: read
Entities: department, company
Summary: The Get Company Departments API retrieves a list of company departments. It accepts optional query parameters 'page' and 'per_page' to paginate the results. The response includes a list of departments, each with an 'id', 'name', 'created_at', and 'updated_at' timestamp. The response headers provide caching information, content length, content type, and the total number of departments.
Input Fields: Input Fields
Output Fields: Output Fields

Get Company Divisions

ID: get_company_divisions
Operation: read
Entities: company division
Summary: The Get Company Divisions API retrieves a list of company divisions from the BreatheHR system. It does not require any input parameters. The response includes a list of divisions, each with optional fields such as id, name, created_at, and updated_at. The response headers provide caching information, content length, content type, and the total number of divisions returned.
Input Fields: Input Fields
Output Fields: Output Fields

Get Company Locations

ID: get_company_locations
Operation: read
Entities: location, company
Summary: The Get Company Locations API retrieves a list of company locations from the BreatheHR system. It does not require any input parameters. The response includes a list of locations, each with an id, name, created_at, and updated_at timestamp. The response headers provide caching information, content length, content type, and the total number of locations returned.
Input Fields: Input Fields
Output Fields: Output Fields

Get Company Training Types

ID: get_company_training_types
Operation: read
Entities: company training type
Summary: The Get Company Training Types API retrieves a list of company training types from the BreatheHR system. It accepts optional query parameters 'page' and 'per_page' to paginate the results. The response includes a list of training types, each with an ID, name, creation timestamp, and last update timestamp. The response headers provide caching information, content length, content type, and the total number of training types available.
Input Fields: Input Fields
Output Fields: Output Fields

Get Department Absences

ID: get_department_absences
Operation: read
Entities: department, employee, absence
Summary: The Get Department Absences API retrieves a list of absences for a specified department. The API requires the department ID as a path parameter. Optional query parameters include 'exclude_cancelled_absences' to filter out cancelled leave requests, 'page' to specify the page of results, and 'per_page' to determine the number of results per page. The response includes details about each absence, such as the employee involved, approval status, leave reason, and dates. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Department Benefits

ID: get_department_benefits
Operation: read
Entities: benefit, employee, department
Summary: The Get Department Benefits API retrieves a list of employee benefits for a specific department identified by its ID. The API supports pagination through the 'page' and 'per_page' query parameters. The response includes details such as the benefit ID, start and end dates, review date, amount, provider, pension opt-out status, employer and employee contributions, and timestamps for creation and last update. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Department Bonuses

ID: get_department_bonuses
Operation: read
Entities: bonus, employee perk, department
Summary: The Get Department Bonuses API retrieves a list of bonuses for a specific department identified by its ID. The API supports pagination through the 'page' and 'per_page' query parameters. The response includes details of each bonus such as its ID, description, amount, award date, and timestamps for creation and last update. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Department Salaries

ID: get_department_salaries
Operation: read
Entities: salary, employee, department
Summary: The Get Department Salaries API retrieves the salary details for a specific department identified by its ID. The API endpoint is accessed via a GET request to 'https://api.breathehr.com/v1/departments/{id}/salaries'. The request can include optional query parameters 'page' and 'per_page' to paginate the results. The response is a JSON array of salary records, each containing fields such as 'id', 'start_date', 'end_date', 'amount', 'basis', 'created_at', and 'updated_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Absences

ID: get_employee_absences
Operation: read
Entities: note, employee, absence
Summary: The Get Employee Absences API retrieves the absence records for a specific employee identified by their ID. The API endpoint is 'https://api.breathehr.com/v1/employees/{id}/absences' and uses the GET method. It requires the employee ID as a path parameter and optionally accepts query parameters to exclude cancelled absences, specify the page of results, and the number of results per page. The response includes detailed information about each absence, such as the employee's details, approval status, leave reason, dates, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Benefits

ID: get_employee_benefits
Operation: read
Entities: benefit, provider, employee
Summary: The Get Employee Benefits API retrieves a list of benefits for a specific employee identified by their ID. The API endpoint is 'https://api.breathehr.com/v1/employees/{id}/benefits'. It supports pagination through the 'page' and 'per_page' query parameters. The response includes a list of benefits with details such as id, start date, end date, review date, amount, provider, pension opt-out status, employer and employee contributions, and timestamps for creation and last update. The response headers provide caching information, content length, content type, and the total number of benefits.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Bonuses

ID: get_employee_bonuses
Operation: read
Entities: bonus, page, employee
Summary: The Get Employee Bonuses API retrieves a list of bonuses for a specific employee identified by the employee ID. The API endpoint is 'https://api.breathehr.com/v1/employees/{id}/bonuses'. It accepts optional query parameters 'page' and 'per_page' to paginate the results. The response includes a list of employee perks with details such as 'id', 'description', 'amount', 'award_date', 'created_at', and 'updated_at'. The response headers provide caching information, content length, content type, and the total number of bonuses.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Change Requests

ID: get_employee_change_requests
Operation: read
Entities: change request, employee
Summary: The Get Employee Change Requests API retrieves a list of change requests for a specific employee identified by their ID. The API supports pagination through the 'page' and 'per_page' query parameters. The response includes details of each change request such as the field name, new value, approval status, and timestamps for creation, approval, and last update. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Details

ID: get_employee_details
Operation: read
Entities: location, employee, department
Summary: The Get Employee Details API retrieves detailed information about an employee using their unique ID. The API endpoint is 'https://api.breathehr.com/v1/employees/{id}' and requires the HTTP GET method. The only required path parameter is 'id', which specifies the employee's ID. The response includes a comprehensive set of optional fields such as personal details, job information, contact details, and more, all returned in JSON format. This API is useful for obtaining a complete profile of an employee within the BreatheHR system.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Expense Claim Details

ID: get_employee_expense_claim_details
Operation: read
Entities: employee expense claim, employee expense, employee
Summary: This API endpoint retrieves the details of a specific employee expense claim using the claim ID. The request requires the 'id' path parameter to specify the expense claim. Optional query parameters 'page' and 'per_page' can be used to paginate the results. The response includes various details about the expense claim, such as employee information, claim status, dates of submission, approval, rejection, and payment, as well as any associated descriptions and reasons for rejection. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Expense Claims

ID: get_employee_expense_claims
Operation: read
Entities: approver, employee expense claim, employee
Summary: The Get Employee Expense Claims API retrieves a list of expense claims for employees. It supports filtering by employee ID and claim state, and allows pagination through 'page' and 'per_page' query parameters. The response includes a list of employee expense claims with details such as employee information, claim status, and dates of submission, approval, and payment. The response headers provide metadata about the response, including cache control, content length, and total number of records.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Expenses

ID: get_employee_expenses
Operation: read
Entities: employee, employee expense, company
Summary: The Get Employee Expenses API retrieves a list of employee expenses from the BreatheHR system. It accepts query parameters such as 'employee_id' to filter expenses for a specific employee, 'show_claimed' to include claimed expenses, 'page' to specify the page of results, and 'per_page' to define the number of results per page. The response includes headers with caching information, content length, content type, and total number of expenses. The response body contains an array of employee expenses, each with details such as expense ID, employee ID, account ID, expense date, description, amount, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Expenses by ID

ID: get_employee_expenses_by_id
Operation: read
Entities: employee expense
Summary: This API endpoint retrieves the details of an employee expense by its ID. The request requires the 'id' path parameter, which is the unique identifier of the employee expense record. The response includes various details about the expense, such as the employee ID, account ID, expense date, description, amount, and other related information. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Jobs

ID: get_employee_jobs
Operation: read
Entities: employee job, employee
Summary: The Get Employee Jobs API retrieves a list of jobs for employees. It accepts query parameters such as 'employee_id' to filter jobs for a specific employee, 'page' to specify the page of results, and 'per_page' to determine the number of results per page. The response includes a list of employee jobs with details such as title, full-time or part-time status, start and end dates, contract end date, and timestamps for creation and last update. The response headers provide caching information, content length, content type, and the total number of jobs.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Leave Requests

ID: get_employee_leave_requests
Operation: read
Entities: leave request, employee
Summary: This API retrieves the leave requests for a specific employee identified by their ID. The endpoint requires the employee ID as a path parameter. Optionally, you can exclude cancelled leave requests by setting the 'exclude_cancelled_requests' query parameter to true. The response is a JSON array of leave requests, each containing details such as start and end dates, status, and notes. The response content type is application/json.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Salaries

ID: get_employee_salaries
Operation: read
Entities: salary, employee
Summary: The Get Employee Salaries API retrieves a list of employee salaries from the BreatheHR system. It supports pagination through the 'page' and 'per_page' query parameters, which are optional. The response includes a list of salaries, each with details such as id, start_date, end_date, amount, basis, created_at, and updated_at. The response headers provide caching information, content length, content type, and the total number of salaries available.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Sickness Records

ID: get_employee_sickness_records
Operation: read
Entities: company sickness type, sickness, employee
Summary: The Get Employee Sickness Records API retrieves the sickness records for a specified employee using their ID. The API requires the employee ID as a path parameter. The response includes details such as the type of sickness, employee information, start and end dates, status, and other relevant details. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Training Courses

ID: get_employee_training_courses
Operation: read
Entities: employee training course, employee, company
Summary: The Get Employee Training Courses API retrieves a list of training courses associated with employees. It accepts query parameters such as 'employee_id' to filter courses for a specific employee, 'page' to specify the page of results, and 'per_page' to determine the number of results per page. The response includes a list of employee training courses with details such as course ID, name, start and end dates, cost, status, and more. The response headers provide caching directives, content length, content type, and the total number of courses.
Input Fields: Input Fields
Output Fields: Output Fields

Get Holiday Allowances

ID: get_holiday_allowances
Operation: read
Entities: holiday allowance
Summary: The Get Holiday Allowances API retrieves a list of holiday allowances from the BreatheHR system. It does not require any input parameters. The response includes details such as the name, units, amount, and other attributes of each holiday allowance. The response is returned in JSON format and includes headers like Cache-Control, Content-Length, Content-Type, and Total, which indicates the number of holiday allowances returned.
Input Fields: Input Fields
Output Fields: Output Fields

Get Leave Request Cancelling Details

ID: get_leave_request_cancelling_details
Operation: read
Entities: leave request
Summary: This API endpoint retrieves the details of a leave request that is in the process of being cancelled. The request requires the 'id' of the leave request as a path parameter. The response includes details such as the start and end dates, whether the leave starts or ends at half day, the action taken, status, notes, and timestamps for creation and last update. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Leave Request Details

ID: get_leave_request_details
Operation: read
Entities: leave request
Summary: The Get Leave Request Details API retrieves the details of a specific leave request identified by its unique ID. The API requires the 'id' parameter as a path parameter to specify which leave request to retrieve. The response includes details such as the start and end dates, whether the leave starts or ends at half day, the action taken, status, notes, and timestamps for creation and last update. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Leave Requests

ID: get_leave_requests
Operation: read
Entities: employee, leave request, department
Summary: The Get Leave Requests API retrieves a list of leave requests from the BreatheHR system. It supports filtering by start and end dates, exclusion of cancelled requests, and filtering by employee or department ID. Pagination is supported through 'page' and 'per_page' query parameters. The response includes a list of leave requests with details such as start and end dates, status, and notes. The response headers provide caching information and the total number of leave requests.
Input Fields: Input Fields
Output Fields: Output Fields

Get Leave Requests for a Department

ID: get_leave_requests_for_a_department
Operation: read
Entities: leave request, department
Summary: This API retrieves leave requests for a specific department identified by the department ID. The request can include optional query parameters such as 'exclude_cancelled_requests' to filter out cancelled requests, 'page' to specify the page of results, and 'per_page' to define the number of results per page. The response is a JSON array of leave requests, each containing details such as 'id', 'start_date', 'end_date', 'status', and timestamps for creation and updates.
Input Fields: Input Fields
Output Fields: Output Fields

Get Other Leave Reasons

ID: get_other_leave_reasons
Operation: read
Entities: company leave reason, other leave reason
Summary: The 'Get Other Leave Reasons' API endpoint retrieves a list of other leave reasons available in the system. It does not require any input parameters and returns a JSON response containing an array of leave reasons. Each leave reason includes an 'id', 'name', and 'created_at' timestamp. The response headers provide additional metadata such as cache control, content length, content type, and the total number of leave reasons returned.
Input Fields: Input Fields
Output Fields: Output Fields

Get Sickness Records

ID: get_sickness_records
Operation: read
Entities: employee, sickness, department
Summary: The Get Sickness Records API retrieves a list of sickness records from the BreatheHR system. It allows filtering by start date, end date, employee ID, and department ID. Pagination is supported through the 'page' and 'per_page' query parameters. The response includes a list of sickness records, each with details such as company sickness type, employee, start and end dates, status, and reason. The response headers provide metadata about the response, including caching directives and the total number of records.
Input Fields: Input Fields
Output Fields: Output Fields

Get Statutory Holiday Countries

ID: get_statutory_holiday_countries
Operation: read
Entities: statutory holiday country
Summary: The Get Statutory Holiday Countries API retrieves a list of countries with statutory holidays. It does not require any input parameters. The response includes a list of countries, each with an id, name, created_at, and updated_at timestamp. The response headers provide caching information, content length, content type, pagination links, and the total number of countries available. This API is useful for obtaining information about statutory holidays in different countries.
Input Fields: Input Fields
Output Fields: Output Fields

Get Working Patterns

ID: get_working_patterns
Operation: read
Entities: working pattern
Summary: The Get Working Patterns API retrieves a list of working patterns from the BreatheHR system. It does not require any input parameters. The response includes details such as the working pattern ID, name, total hours, and the working days with their respective hours. The response is returned in JSON format with headers indicating cache control, content length, and content type.
Input Fields: Input Fields
Output Fields: Output Fields

Approve Employee Change Request

ID: post_approve_employee_change_request
Operation: write
Entities: change request, employee
Summary: The Approve Employee Change Request API is used to approve a change request for a specific employee. The API requires the employee ID and the change request ID as path parameters. Upon successful approval, it returns details of the change request including the field name, new value, approval status, and timestamps for creation, approval, and last update. The response is in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Approve Leave Request

ID: post_approve_leave_request
Operation: write
Entities: note, status, leave request
Summary: The Approve Leave Request API is used to approve a leave request identified by its ID. The API requires the 'id' path parameter to specify which leave request to approve. The response includes details of the leave request such as start and end dates, half-day indicators, action taken, status, notes, and timestamps for creation and last update. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Cancel Absence Request

ID: post_cancel_absence_request
Operation: write
Entities: leave request, absence
Summary: The Cancel Absence Request API allows users to cancel an existing absence request by providing the absence ID in the path parameters. The request can optionally include a reason for cancellation in the body. The API returns a JSON response containing details of the leave request, including its ID, start and end dates, status, and any notes. The response also includes timestamps for when the request was created and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Create Employee Expenses

ID: post_create_employee_expenses
Operation: write
Entities: company project, employee expense, employee
Summary: The Create Employee Expenses API allows you to create a new employee expense record in the system. It accepts various parameters related to the expense, such as employee ID, expense date, description, amount, and more. The request body should be in JSON format and include details like whether the expense is payable to the employee, chargeable to a client, and if there is a receipt. The response returns a JSON object containing the details of the created expense, including its ID and other related information.
Input Fields: Input Fields
Output Fields: Output Fields

Create Leave Request for Employee

ID: post_create_leave_request_for_employee
Operation: write
Entities: leave request, employee
Summary: This API endpoint allows the creation of a leave request for a specific employee identified by their ID. The request can include details such as start and end dates, whether the leave starts or ends at half day, the type of leave, and additional notes. The response returns the details of the created leave request, including its status and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Create New Employee Record

ID: post_create_new_employee_record
Operation: write
Entities: location, employee, department
Summary: This API endpoint allows the creation of a new employee record in the BreatheHR system. It accepts a variety of employee details as input, including personal information such as name, email, gender, and date of birth, as well as employment details like job title, department, and salary. The input is structured as a JSON object with nested properties for different categories of information. The response returns a JSON object containing the full details of the newly created employee, including their unique ID, status, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Create Employee Change Request

ID: post_employee_change_request
Operation: write
Entities: change request, employee
Summary: This API endpoint allows the creation of a change request for an employee's details. The request is made by specifying the employee ID in the path parameters and providing the field name and new value in the request body. Optionally, the change can be immediately approved by setting the 'approved' field to true. The response includes details of the change request, such as the field name, new value, approval status, and timestamps for creation and updates.
Input Fields: Input Fields
Output Fields: Output Fields

Create Employee Expense Claims

ID: post_employee_expense_claims
Operation: write
Entities: expense, employee expense claim, employee
Summary: The Create Employee Expense Claims API allows users to submit expense claims for employees. The request requires a JSON body with optional parameters such as employee_id and a list of employee_expense_ids. The response returns a JSON object containing details of the expense claim, including employee information, claim status, and dates of submission, approval, or rejection.
Input Fields: Input Fields
Output Fields: Output Fields

Create Employee Sickness Record

ID: post_employee_sickness_record
Operation: write
Entities: company_sicknesstype, sickness, employee
Summary: This API endpoint allows the creation of a sickness record for a specific employee. The request requires the employee ID as a path parameter and accepts various optional fields in the request body to describe the sickness, such as company sickness type ID, start and end dates, half-day indicators, status, reason, and review notes. The response returns a JSON object containing details of the created sickness record, including the company sickness type, employee, start and end dates, status, and other related information.
Input Fields: Input Fields
Output Fields: Output Fields

Create Employee Training Course

ID: post_employee_training_course
Operation: write
Entities: employee training course, company training, employee
Summary: This API endpoint allows the creation of a new employee training course. It accepts various parameters related to the training course such as employee ID, course name, training type, status, and more. The request body should include these parameters under the 'employee_training_course' object. The response returns the details of the created training course, including its ID, name, start and end dates, status, outcome, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Reject Leave Request

ID: post_reject_leave_request
Operation: write
Entities: leave request
Summary: The Reject Leave Request API allows users to reject a leave request by providing the leave request ID in the path parameters and a required rejection reason in the request body. The API responds with the details of the leave request, including its ID, start and end dates, status, and any notes. The response is in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Update Employee Expense

ID: put_update_employee_expense
Operation: write
Entities: expense claim, employee expense, company
Summary: The Update Employee Expense API allows you to edit an unclaimed employee expense by specifying the expense ID in the path parameters. The API accepts various optional parameters in the request body, such as expense date, description, project ID, mileage rate ID, miles, amount, VAT, and more. The response returns the updated employee expense details in JSON format, including fields like employee ID, account ID, expense date, description, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Update Employee Expense Claim

ID: put_update_employee_expense_claim
Operation: write
Entities: approver, employee expense claim, employee
Summary: The Update Employee Expense Claim API allows users to update the status and details of an employee's expense claim. The API requires the expense claim ID as a path parameter. The request body can include the approval status, approver or rejector ID, and a rejection reason. The response returns the updated details of the expense claim, including employee information, expense details, approval status, and other related metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Update Employee Training Course

ID: put_update_employee_training_course
Operation: write
Entities: company training type, employee training course, company training provider
Summary: This API endpoint allows updating an existing employee training course by its ID. The request requires the path parameter 'id' to specify which training course to update. The body of the request can include various optional fields such as 'name', 'company_training_type_id', 'status', 'remuneration_currency_id', 'company_training_category_id', 'company_training_provider_id', 'start_on', 'half_day', 'half_day_am_pm', 'end_on', 'followup_date', 'cost', 'outcome', and 'notes'. The response returns the updated details of the employee training course, including fields like 'id', 'name', 'start_on', 'end_on', 'half_day', 'half_day_am_pm', 'expires_on', 'hours', 'cost', 'status', 'outcome', 'remuneration_currency_id', 'rejection_reason', 'notes', 'followup_date', 'employee', 'company_training_type', 'company_training_category', and 'company_training_provider'.
Input Fields: Input Fields
Output Fields: Output Fields

Update Sickness Record

ID: put_update_sickness_record
Operation: write
Entities: company_sicknesstype, sickness, employee
Summary: The Update Sickness Record API allows updating an existing sickness record in the system. The API requires the sickness ID as a path parameter and accepts various optional fields in the request body to update the sickness details, such as company sickness type ID, start and end dates, half-day indicators, status, reason, and review notes. The response returns the updated sickness record details in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields