CharlieHR API Integration

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

Get All Salaries from Authenticated Company

ID: get_all_salaries_from_authenticated_company
Operation: read
Entities: team member, salaries, job title
Summary: This API endpoint retrieves all salaries from the authenticated company. It requires an Authorization header containing the access credentials. The response includes a success status and an array of salary objects, each containing details such as the team member's ID, job title, pay rate, pay period, pay frequency, pay currency, effective date, and employment type. The response also includes metadata about the total results, results per page, current page, total pages, and URLs for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Bank Account Details

ID: get_bank_account_details
Operation: read
Entities: team member, company, bank account
Summary: This API retrieves the bank account details of a specific team member from the authenticated company. The request requires an Authorization header containing the access credentials and a path parameter specifying the team member ID. The response includes the success status and the bank account details such as team member ID, account number, sort code, and bank name.
Input Fields: Input Fields
Output Fields: Output Fields

Get Bank Account Information for Team Members

ID: get_bank_account_information_for_team_members
Operation: read
Entities: team member, company, bank account
Summary: This API endpoint retrieves bank account information for all team members of the authenticated company. It requires an Authorization header containing the access credentials. The response includes a success status and an array of bank account details for each team member, including their account number, sort code, and bank name. The response may also include metadata about the results, such as total results, results per page, and pagination URLs.
Input Fields: Input Fields
Output Fields: Output Fields

Company Show

ID: get_company_show
Operation: read
Entities: company, credential
Summary: The Company Show API responds with the company details that own the credentials used to make the request. It requires an Authorization header containing the access credentials. The response includes a success status and company data such as the company ID, name, subdomain, and logo URL. A successful response indicates valid credentials, while a false success status indicates an invalid request or validation errors.
Input Fields: Input Fields
Output Fields: Output Fields

Leave Allowances Index

ID: get_leave_allowances_index
Operation: read
Entities: leave allowance, team member, leave type
Summary: The Leave Allowances Index API responds with the current leave allowances for all team members at the authenticated company. It requires an Authorization header containing the access credentials. The response includes a success status and an array of leave allowance objects, each detailing the team member's ID, total allowance in days, days used, remaining allowance, leave types, and the period start and end dates. The response also includes metadata about the total results, pagination, and URLs for navigating through pages.
Input Fields: Input Fields
Output Fields: Output Fields

Leave Requests Index

ID: get_leave_requests_index
Operation: read
Entities: team member, leave request, approver
Summary: The Leave Requests Index API responds with all leave requests for the authenticated company. It requires an Authorization header containing the access credentials. The API supports optional query parameters for pagination (page and per_page) and filtering by date range (start_date and end_date). The response includes a success status, metadata about the pagination, and an array of leave request objects, each containing details such as the team member, approver, status, and dates of the leave.
Input Fields: Input Fields
Output Fields: Output Fields

Leave Requests Show

ID: get_leave_requests_show
Operation: read
Entities: team member, leave request, approver
Summary: The 'Leave Requests Show' API endpoint retrieves a single leave request from the currently authenticated company. It requires an Authorization header containing the access credentials. The path parameter ':id' specifies the ID of the leave request to retrieve. The response includes details such as the ID of the leave request, the team member it belongs to, the approver, status, details, amount, units, request type, start date, and end date. The success field indicates whether the request was successful.
Input Fields: Input Fields
Output Fields: Output Fields

List All Teams for Authenticated Company

ID: get_list_all_teams_for_authenticated_company
Operation: read
Entities: team, team member, company
Summary: This API endpoint lists all the teams that belong to the authenticated company. It requires an Authorization header containing the access credentials. The response includes a success status and an array of team objects, each with an ID, name, and list of team members. Pagination details are also provided in the response.
Input Fields: Input Fields
Output Fields: Output Fields

List Company Offices

ID: get_list_company_offices
Operation: read
Entities: company, office
Summary: This API endpoint lists all of the offices that belong to the authenticated company. It requires an Authorization header containing the access credentials. The response includes a success status and an array of office objects, each containing details such as the office ID, name, whether it is the head office, address, timezone, phone number, and email.
Input Fields: Input Fields
Output Fields: Output Fields

Get Salary Details

ID: get_salary_details
Operation: read
Entities: salary, team member, job title
Summary: The Get Salary Details API responds with a single salary from the given company. It requires an Authorization header containing the access credentials. The response includes details such as the salary ID, team member ID, job title, pay rate, pay period, pay frequency, currency, effective date, and employment type. The success field indicates the success status of the response.
Input Fields: Input Fields
Output Fields: Output Fields

Show Office Details

ID: get_show_office_details
Operation: read
Entities: address, company, office
Summary: The Show Office Details API responds with the requested office details from the currently authenticated company. It requires an Authorization header containing the access credentials and a path parameter 'id' which is the ID of the office. The response includes a success status and an object containing details of the office such as its ID, name, whether it is the head office, address, timezone, phone number, and email.
Input Fields: Input Fields
Output Fields: Output Fields

Get Team Details

ID: get_team_details
Operation: read
Entities: team, team member, company
Summary: The Get Team Details API retrieves information about a specific team identified by its ID, provided that the team belongs to the authenticated company. The request requires an Authorization header containing the access credentials. The response includes the team's ID, name, and a list of team member IDs, along with a success status indicating whether the request was successful.
Input Fields: Input Fields
Output Fields: Output Fields

Get Team Member Details

ID: get_team_member_details
Operation: read
Entities: team member, company, note
Summary: This API retrieves the details of a single team member from the authenticated company. It requires an Authorization header containing the access credentials and a path parameter 'id' which is the ID of the team member. The response includes detailed information about the team member such as their name, email addresses, phone number, address, office, manager, teams, national insurance number, gender, marital status, date of birth, employment status, profile picture, notes, job title, and payroll ID.
Input Fields: Input Fields
Output Fields: Output Fields

Show Team Member Note Type

ID: get_team_member_note_type
Operation: read
Entities: team member, permission, team member note type
Summary: The 'Show Team Member Note Type' API endpoint retrieves a single team member note type for the authenticated company. It requires an authorization header containing the access credentials. The endpoint uses the GET method and requires the ID of the note type as a path parameter. The response includes the note type's ID, name, type, and permissions, which indicate who can view the note type's content. The permissions include boolean values for anyone, owners, team leads, line managers, payroll admins, admins, and super admins.
Input Fields: Input Fields
Output Fields: Output Fields

Team Member Note Types Index

ID: get_team_member_note_types_index
Operation: read
Entities: team member, permission, note type
Summary: The Team Member Note Types Index API responds with all team member note types for the authenticated company. It requires an Authorization header containing the access credentials. The API supports pagination through optional query parameters 'page' and 'per_page'. The response includes a success status and an array of team member note types, each with an ID, name, type, and permissions. The response also includes pagination metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Get Team Member Notes

ID: get_team_member_notes
Operation: read
Entities: team member, note, note type
Summary: This API endpoint retrieves the notes for a specific team member. It requires the team member's ID as a path parameter and an Authorization header containing the access credentials. The response includes a success status, metadata about the results, and an array of notes, each with details such as note ID, team member ID, note type ID, label, and content.
Input Fields: Input Fields
Output Fields: Output Fields

Get Team Members

ID: get_team_members
Operation: read
Entities: team member, address, company
Summary: The Get Team Members API responds with all of the authenticated company's team members. It requires an Authorization header containing the access credentials. The API supports pagination through optional query parameters 'page' and 'per_page'. The response includes a success status and an array of team member objects, each containing details such as id, company, name, emails, phone number, address, office, manager, teams, and employment details.
Input Fields: Input Fields
Output Fields: Output Fields

Team Members Leave Allowance

ID: get_team_members_leave_allowance
Operation: read
Entities: leave allowance, team member, leave type
Summary: The Team Members Leave Allowance API responds with the current leave allowance for a specified team member. It requires an Authorization header containing access credentials and a path parameter 'id' representing the team member's ID. The response includes details such as the total number of leave allowance days, days used, remaining allowance, types of leave deductible, and the leave period's start and end dates. A success status indicates whether the request was valid.
Input Fields: Input Fields
Output Fields: Output Fields

Team Members Leave Requests

ID: get_team_members_leave_requests
Operation: read
Entities: team member, leave request, approver
Summary: The Team Members Leave Requests API responds with a list of leave requests that belong to a specified team member. The API requires an Authorization header containing access credentials. The team member's ID is specified in the path parameters. Optional query parameters include page, per_page, start_date, and end_date for pagination and filtering. The response includes a success status, an array of leave request data, and pagination metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Create Team Member Note

ID: post_create_team_member_note
Operation: write
Entities: team member, note, team member note type
Summary: This API creates a new note for a specified team member. It requires the team member's ID in the path parameters and the note type ID and content in the request body. The request must include authorization credentials in the headers. On success, it returns the details of the created note, including its ID, the team member's ID, the note type ID, the label, and the content. If the request fails, it returns an array of errors and a success status of false.
Input Fields: Input Fields
Output Fields: Output Fields

Create Team Member Note Type

ID: post_create_team_member_note_type
Operation: write
Entities: error, permission, team member note type
Summary: This API creates a new team member note type for the company. The request must include an Authorization header with access credentials and a Content-Type header set to application/json. The body of the request should include the name of the note type, the type (optional, defaults to Text), and permissions (optional, with default values set to false for all roles). The response will indicate success or failure, and on success, it will return the details of the created note type.
Input Fields: Input Fields
Output Fields: Output Fields