- Category: human resources
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 117
- Triggers: 0
- Slug:
SMARTHR - Version: 20261101_00
Tools
Bulk Create Payslips
Bulk Create Payslips
SMARTHR_BULK_CREATE_PAYSLIPSCreate up to 100 sensitive payslip entries in one SmartHR payroll group. The connected API access token must have payroll Update permission and any applicable employee-field Update permissions.Input Parameters
Output
Create Department
Create Department
Create Employee
Create Employee
SMARTHR_CREATE_EMPLOYEECreate an employee using the documented SmartHR employee fields. The connected API token must have employee resource and field Update permissions.Input Parameters
Output
Create Employee Custom Field Template
Create Employee Custom Field Template
Create Employee Custom Field Template Group
Create Employee Custom Field Template Group
Create Employee Dependent
Create Employee Dependent
SMARTHR_CREATE_EMPLOYEE_DEPENDENTCreate a dependent for one employee using the documented family fields. The connected API token must have the required family and employee-field Update permissions.Input Parameters
Output
Create Employment Type
Create Employment Type
Create Grade
Create Grade
Create Job Category
Create Job Category
Create Job Title
Create Job Title
Create Payroll
Create Payroll
Create Payslip
Create Payslip
Create Recruitment Type
Create Recruitment Type
Create Tax Withholding
Create Tax Withholding
SMARTHR_CREATE_TAX_WITHHOLDINGCreate a sensitive SmartHR tax-withholding group in the unconfirmed state. The connected API access token must have tax-withholding-group Update permission.Input Parameters
Output
Create Tax Withholding Slip
Create Tax Withholding Slip
SMARTHR_CREATE_TAX_WITHHOLDING_SLIPCreate a file-backed or field-backed sensitive tax-withholding slip for an employee in one SmartHR tax-withholding group. The connected API access token must have the tax-withholding-slip resource and applicable employee-field Update permissions.Input Parameters
Output
Create User SAML Configuration
Create User SAML Configuration
Create Webhook
Create Webhook
SMARTHR_CREATE_WEBHOOKCreate a SmartHR webhook configuration for future employee and dependent events. Matching events can send data to the configured destination, so confirm the URL, event selections, payload exposure, and secret token before calling. The connected API access token must have the webhook resource Update permission.Input Parameters
Output
Delete Department
Delete Department
SMARTHR_DELETE_DEPARTMENTDeprecated: delete a SmartHR department by ID. Prefer SMARTHR_DISCONTINUE_DEPARTMENT because SmartHR no longer recommends department deletion. Deletion requires the department resource Update permission and fails when the department or a child department has a scheduled employee update whose effective date has not arrived.Input Parameters
Output
Delete Employee
Delete Employee
Delete Employee Custom Field Template
Delete Employee Custom Field Template
Delete Employee Custom Field Template Group
Delete Employee Custom Field Template Group
SMARTHR_DELETE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUPDelete one employee custom-field template group by ID. This also permanently deletes every custom-field template in the group and all values set for those templates. SmartHR rejects deletion when a group field has a scheduled employee update whose effective date has not arrived.Input Parameters
Output
Delete Employee Dependent
Delete Employee Dependent
Delete Employment Type
Delete Employment Type
SMARTHR_DELETE_EMPLOYMENT_TYPEDelete one SmartHR employment type by ID. SmartHR does not allow deletion of a system-standard employment type or one referenced by a scheduled employee update whose effective date has not arrived. The connected API access token must have the employment type resource Update permission.Input Parameters
Output
Delete Grade
Delete Grade
Delete Job Category
Delete Job Category
Delete Job Title
Delete Job Title
Delete Payroll
Delete Payroll
Delete Payslip
Delete Payslip
Delete Recruitment Type
Delete Recruitment Type
SMARTHR_DELETE_RECRUITMENT_TYPEDelete one SmartHR recruitment type by ID. A recruitment type referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the recruitment type resource Update permission.Input Parameters
Output
Delete Tax Withholding
Delete Tax Withholding
Delete Tax Withholding Slip
Delete Tax Withholding Slip
SMARTHR_DELETE_TAX_WITHHOLDING_SLIPPermanently delete one sensitive SmartHR tax-withholding slip from its tax-withholding group. The connected API access token must have the tax-withholding-slip resource Update permission, and employee fields may also require Update permission.Input Parameters
Output
Delete User SAML Configuration
Delete User SAML Configuration
Delete Webhook
Delete Webhook
Disable User SAML Configuration
Disable User SAML Configuration
Discontinue Department
Discontinue Department
SMARTHR_DISCONTINUE_DEPARTMENTIrreversibly discontinue one SmartHR department as of its final active date. The date must be in the past. SmartHR rejects discontinuation when a scheduled employee update references this department or a descendant; the connected access token must have department Update permission.Input Parameters
Output
Download Batch Job Attachment
Download Batch Job Attachment
SMARTHR_DOWNLOAD_BATCH_JOB_ATTACHMENTDownload a SmartHR batch-job attachment as an offloaded file reference, with a maximum download size of 100,000,000 bytes. SmartHR deletes the provider attachment five minutes after it is retrieved, so use the returned reference for subsequent work.Input Parameters
Output
Enable User SAML Configuration
Enable User SAML Configuration
Finalize Payroll
Finalize Payroll
Get Batch Job
Get Batch Job
Get Department
Get Department
Get Employee
Get Employee
Get Employee Custom Field Template
Get Employee Custom Field Template
Get Employee Custom Field Template Group
Get Employee Custom Field Template Group
Get Employee Dependent
Get Employee Dependent
Get Employee Input Form
Get Employee Input Form
Get Employment Type
Get Employment Type
Get Grade
Get Grade
Get Job Category
Get Job Category
Get Job Title
Get Job Title
Get Mail Format
Get Mail Format
Get Payment Period
Get Payment Period
Get Payroll
Get Payroll
Get Payslip
Get Payslip
Get Recruitment Type
Get Recruitment Type
Get Tax Withholding
Get Tax Withholding
Get Tax Withholding Slip
Get Tax Withholding Slip
Get User
Get User
Get User SAML Configuration
Get User SAML Configuration
Get Webhook
Get Webhook
Invite Employee
Invite Employee
List Bank Account Settings
List Bank Account Settings
List Batch Jobs
List Batch Jobs
List Business Establishments
List Business Establishments
List Companies
List Companies
List Departments
List Departments
SMARTHR_LIST_DEPARTMENTSList one page of SmartHR departments using the documented code and sort filters. Returns hierarchy and company details when present.Input Parameters
Output
List Dependent Custom Field Templates
List Dependent Custom Field Templates
List Dependent Relations
List Dependent Relations
List Employee Custom Field Template Groups
List Employee Custom Field Template Groups
List Employee Custom Field Templates
List Employee Custom Field Templates
List Employee Dependents
List Employee Dependents
List Employee Input Forms
List Employee Input Forms
List Employee Maternity and Childcare Leaves
List Employee Maternity and Childcare Leaves
List Employees
List Employees
SMARTHR_LIST_EMPLOYEESList one page of employees matching SmartHR’s documented employee filters. Employee records contain sensitive HR data; use fields to request only the attributes needed.Input Parameters
Output
List Employment Types
List Employment Types
List Job Categories
List Job Categories
List Job Titles
List Job Titles
List Mail Formats
List Mail Formats
List Payment Periods
List Payment Periods
List Payrolls
List Payrolls
List Payslips
List Payslips
List Recruitment Types
List Recruitment Types
List Tax Withholdings
List Tax Withholdings
List Tax Withholding Slips
List Tax Withholding Slips
List Users
List Users
SMARTHR_LIST_USERSList one page of SmartHR user accounts with the documented sort and embed options, invitation status, role, and email-delivery status.Input Parameters
Output
List Webhooks
List Webhooks
Partially Update Department
Partially Update Department
Partially Update Employee Custom Field Template
Partially Update Employee Custom Field Template
Partially Update Employment Type
Partially Update Employment Type
SMARTHR_PARTIALLY_UPDATE_EMPLOYMENT_TYPEPartially update a SmartHR employment type by ID. SmartHR does not allow renaming a system preset employment type or updating an employment type used by a pending future-dated employee update. The connected API access token must have the employment type resource Update permission.Input Parameters
Output
Partially Update Payroll
Partially Update Payroll
Partially Update User SAML Configuration
Partially Update User SAML Configuration
Partially Update Webhook
Partially Update Webhook
SMARTHR_PARTIALLY_UPDATE_WEBHOOKPartially update a SmartHR webhook by ID. Changing its destination or event selections can redirect future employee and dependent data externally, so confirm them before calling. The connected API access token must have the webhook resource Update permission.Input Parameters
Output
Publish Payroll
Publish Payroll
SMARTHR_PUBLISH_PAYROLLIrreversibly publish one sensitive SmartHR payroll group immediately or at a scheduled time within one month, optionally notifying employees. The connected API access token must have payroll Update permission.Input Parameters
Output
Remove Employee Departments
Remove Employee Departments
Reopen Payroll
Reopen Payroll
Replace Department
Replace Department
Replace Employee Custom Field Template
Replace Employee Custom Field Template
SMARTHR_REPLACE_EMPLOYEE_CUSTOM_FIELD_TEMPLATEReplace an employee custom-field template through the documented PUT operation. Omitted optional attributes are deleted; use the PATCH action to preserve attributes that are not being changed. Existing dropdown elements omitted from elements are also deleted.Input Parameters
Output
Replace Employee Custom Field Template Group
Replace Employee Custom Field Template Group
SMARTHR_REPLACE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUPReplace an employee custom-field template group through the documented PUT operation. Omitted optional attributes are deleted; use the PATCH action to preserve attributes that are not being changed.Input Parameters
Output
Replace Employment Type
Replace Employment Type
SMARTHR_REPLACE_EMPLOYMENT_TYPEReplace a SmartHR employment type through PUT. Attributes omitted from the PUT contract are deleted; use the partial-update action to preserve them. System-standard employment types and employment types used by pending employee updates cannot be changed.Input Parameters
Output
Replace Grade
Replace Grade
SMARTHR_REPLACE_GRADEReplace a SmartHR grade by ID using full PUT semantics. The PUT contract allows name and rank to be omitted. Grades used by pending future-dated employee updates cannot be changed. The connected API access token must have the grade resource Update permission.Input Parameters
Output
Replace Job Category
Replace Job Category
SMARTHR_REPLACE_JOB_CATEGORYReplace a SmartHR job category by ID using full PUT semantics. The PUT contract allows name to be omitted. Job categories used by pending future-dated employee updates cannot be changed. The connected API access token must have the job category resource Update permission.Input Parameters
Output
Replace Job Title
Replace Job Title
SMARTHR_REPLACE_JOB_TITLEReplace a SmartHR job title by ID using full PUT semantics. The PUT contract allows name and rank to be omitted. Job titles used by pending future-dated employee updates cannot be changed. The connected API access token must have the job title resource Update permission.Input Parameters
Output
Replace Recruitment Type
Replace Recruitment Type
SMARTHR_REPLACE_RECRUITMENT_TYPEReplace a SmartHR recruitment type by ID using full PUT semantics. Name is required for the complete replacement. Recruitment types used by pending future-dated employee updates cannot be changed. The connected API access token must have the recruitment type resource Update permission.Input Parameters
Output
Replace Tax Withholding
Replace Tax Withholding
SMARTHR_REPLACE_TAX_WITHHOLDINGReplace a sensitive SmartHR tax-withholding group by ID using full PUT semantics. Name, status, and year are all required for the complete replacement. Finalized tax withholdings cannot be updated. The connected API access token must have the tax-withholding-group resource Update permission.Input Parameters
Output
Replace Webhook
Replace Webhook
SMARTHR_REPLACE_WEBHOOKReplace a SmartHR webhook through PUT. Omitted optional attributes are deleted; use the partial-update action to preserve attributes that are not being changed. Changing its destination or event selections can redirect future employee and dependent data externally, so confirm them before calling.Input Parameters
Output
Start Dependent Import Job
Start Dependent Import Job
SMARTHR_START_DEPENDENT_IMPORT_JOBStart an asynchronous SmartHR dependent-data import from a Base64-encoded CSV or Excel file. This creates a background job that processes sensitive family HR data; the connected API access token must have the corresponding resource and employee-field Update permissions.Input Parameters
Output
Start Employee Export Job
Start Employee Export Job
SMARTHR_START_EMPLOYEE_EXPORT_JOBStart a SmartHR background job that exports employee information using an existing custom download format. A successful 201 response only confirms that the asynchronous job was registered; use the batch-job actions to monitor it and retrieve any resulting attachment. The connected access token must have the required resource and employee-field Update permissions.Input Parameters
Output
Start Employee Import Job
Start Employee Import Job
SMARTHR_START_EMPLOYEE_IMPORT_JOBStart a SmartHR background job that inserts or updates employees from a sensitive base64-encoded CSV or Excel file. The connected API access token must have the required resource and employee-field Update permissions.Input Parameters
Output
Update Employee
Update Employee
SMARTHR_UPDATE_EMPLOYEEUpdate the supplied documented fields of one employee by SmartHR employee ID.Input Parameters
Output
Update Employee Custom Field Template Group
Update Employee Custom Field Template Group
Update Employee Dependent
Update Employee Dependent
SMARTHR_UPDATE_EMPLOYEE_DEPENDENTUpdate the supplied fields of one dependent belonging to an employee.Input Parameters
Output
Update Grade
Update Grade
Update Job Category
Update Job Category
Update Job Title
Update Job Title
Update Recruitment Type
Update Recruitment Type
Update Tax Withholding
Update Tax Withholding
SMARTHR_UPDATE_TAX_WITHHOLDINGUpdate the supplied fields of a sensitive SmartHR tax-withholding group by ID. SmartHR does not allow updates after the group is fixed. The connected API access token must have the tax-withholding-group resource Update permission.Input Parameters
Output
Update Tax Withholding Slip
Update Tax Withholding Slip
SMARTHR_UPDATE_TAX_WITHHOLDING_SLIPUpdate a sensitive SmartHR tax-withholding slip using a file, legacy values, or a complete set of required structured fields. Confirmed slips cannot be updated, switching between file-backed and field-backed data requires deleting and recreating the slip, and the access token must have tax-withholding-slip Update permission.