---
canonical_url: "https://docs.composio.dev/toolkits/smarthr"
markdown_url: "https://docs.composio.dev/toolkits/smarthr.md"
product: "platform"
version: null
last_updated: null
---

# SmartHR

SmartHR is a cloud human resources platform for managing employee records, organization data, payroll documents, and HR workflows.

- **Category:** human resources
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 117
- **Triggers:** 0
- **Slug:** `SMARTHR`
- **Version:** 00000000_00

## Tools

### Bulk Create Payslips

**Slug:** `SMARTHR_BULK_CREATE_PAYSLIPS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payslips` | array | Yes | Employee-specific payslips to create in bulk. Each entry identifies an employee and contains that employee's payslip values. SmartHR accepts at most 100 payslips per request. |
| `payroll_id` | string | Yes | Payroll group ID in which to create the sensitive payslips. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Department

**Slug:** `SMARTHR_CREATE_DEPARTMENT`

Create a SmartHR department. The connected API access token must have the department resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Department code. |
| `name` | string | Yes | Department name. SmartHR does not allow forward slashes (/). |
| `position` | integer | No | Department position. SmartHR assigns one when omitted. |
| `parent_id` | string | No | Parent department ID. |
| `company_id` | string | No | Company ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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:** `SMARTHR_CREATE_EMPLOYEE`

Create an employee using the documented SmartHR employee fields. The connected API token must have employee resource and field Update permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Employee email. |
| `grade` | string | No | Employee grade. |
| `gender` | string ("male" | "female") | No | Employee gender. |
| `tax_cd` | string ("kou" | "otsu" | "hei" | "reward" | "non_resident" | "no_taxation_required") | No | Employee taxation category. |
| `address` | object | No | Employee address. |
| `resume1` | object | No | Employee resume1. |
| `resume2` | object | No | Employee resume2. |
| `user_id` | string | No | Employee user ID. |
| `birth_at` | string | No | Employee birth date. |
| `emp_code` | string | No | Employee employment code. |
| `emp_type` | string ("board_member" | "full_timer" | "contract_worker" | "permatemp" | "part_timer" | "outsourcing_contractor" | "etc") | No | Employee employment type. |
| `position` | string | No | Employee position. |
| `last_name` | string | No | Employee last name. |
| `positions` | array | No | Employee positions. |
| `department` | string | No | Employee department. |
| `emp_status` | string ("employed" | "absent" | "retired") | No | Employee employment status. |
| `entered_at` | string | No | Employee entered date. |
| `first_name` | string | No | Employee first name. |
| `occupation` | string | No | Employee occupation. |
| `tel_number` | string | No | Employee telephone number. |
| `widow_memo` | string | No | Employee widow memo. |
| `widow_type` | string ("widow" | "single_parent") | No | Employee widow type. |
| `enrolled_at` | string | No | Employee enrolled date. |
| `resigned_at` | string | No | Employee resigned date. |
| `school_name` | string | No | Employee school name. |
| `job_category` | string | No | Employee job category. |
| `address_image` | object | No | Employee address image. |
| `bank_accounts` | array | No | Employee bank accounts. |
| `contract_type` | string ("unlimited" | "fixed_term") | No | Employee contract type. |
| `custom_fields` | array | No | Employee custom fields. |
| `having_spouse` | boolean | No | Employee having spouse. |
| `profile_image` | object | No | Employee profile image. |
| `department_ids` | array | No | Employee department IDs. |
| `last_name_yomi` | string | No | Employee last name phonetic reading. |
| `last_workplace` | string | No | Employee last workplace. |
| `contract_end_on` | string | No | Employee contract end on. |
| `first_name_yomi` | string | No | Employee first name phonetic reading. |
| `first_workplace` | string | No | Employee first workplace. |
| `resident_end_at` | string | No | Employee resident end date. |
| `resigned_reason` | string | No | Employee resigned reason. |
| `handicapped_type` | string ("ordinary_handicapped" | "special_handicapped") | No | Employee handicapped type. |
| `nationality_code` | string | No | Employee nationality code. |
| `recruitment_type` | string | No | Employee recruitment type. |
| `contract_start_on` | string | No | Employee contract start on. |
| `emergency_address` | object | No | Employee emergency address. |
| `handicapped_image` | object | No | Employee handicapped image. |
| `payment_period_id` | string | No | Employee payment period ID. |
| `widow_reason_type` | string ("divorce" | "bereavement" | "missing" | "unmarried") | No | Employee widow reason type. |
| `business_last_name` | string | No | Employee business last name. |
| `employment_type_id` | string | No | Employee employment type ID. |
| `estate_income_flag` | boolean | No | Employee estate income flag. |
| `previous_workplace` | string | No | Employee previous workplace. |
| `student_card_image` | object | No | Employee student card image. |
| `business_first_name` | string | No | Employee business first name. |
| `emergency_last_name` | string | No | Employee emergency last name. |
| `monthly_base_salary` | integer | No | Employee monthly base salary. |
| `basic_pension_number` | string | No | Employee basic pension number. |
| `biz_establishment_id` | string | No | Employee business establishment ID. |
| `business_income_flag` | boolean | No | Employee business income flag. |
| `commutation_1_period` | string ("commutation_period_1_month" | "commutation_period_3_month" | "commutation_period_6_month") | No | Employee commutation 1 period. |
| `commutation_2_period` | string ("commutation_period_1_month" | "commutation_period_3_month" | "commutation_period_6_month") | No | Employee commutation 2 period. |
| `devidend_income_flag` | boolean | No | Whether the employee has dividend income. |
| `emergency_first_name` | string | No | Employee emergency first name. |
| `emergency_tel_number` | string | No | Employee emergency telephone number. |
| `emp_ins_qualified_at` | string | No | Employee employment insurance qualified date. |
| `identity_card_image1` | object | No | Employee identity card image1. |
| `identity_card_image2` | object | No | Employee identity card image2. |
| `monthly_income_goods` | integer | No | Employee monthly income goods. |
| `resident_status_type` | string | No | Employee resident status type. |
| `soc_ins_qualified_at` | string | No | Employee social insurance qualified date. |
| `spouse_yearly_income` | integer | No | Employee spouse yearly income. |
| `working_student_flag` | boolean | No | Employee working student flag. |
| `address_relation_name` | string | No | Employee address relation name. |
| `contract_renewal_type` | string ("renewal" | "none" | "auto_renewal") | No | Employee contract renewal type. |
| `handicapped_note_type` | string | No | Employee handicapped note type. |
| `resident_card_address` | object | No | Employee resident card address. |
| `address_head_of_family` | string | No | Employee address head of family. |
| `commutation_1_expenses` | integer | No | Employee commutation 1 expenses. |
| `commutation_2_expenses` | integer | No | Employee commutation 2 expenses. |
| `employment_income_flag` | boolean | No | Employee employment income flag. |
| `last_employment_end_on` | string | No | Employee last employment end on. |
| `other_be_workable_type` | string ("other_be_workable" | "others") | No | Dispatch or contract-work category. |
| `working_student_income` | integer | No | Employee working student income. |
| `business_last_name_yomi` | string | No | Employee business last name phonetic reading. |
| `child_care_contribution` | integer | No | Employee child care contribution. |
| `emergency_relation_name` | string | No | Employee emergency relation name. |
| `emp_ins_disqualified_at` | string | No | Employee employment insurance disqualified date. |
| `first_employment_end_on` | string | No | Employee first employment end on. |
| `monthly_income_currency` | integer | No | Employee monthly income currency. |
| `soc_ins_disqualified_at` | string | No | Employee social insurance disqualified date. |
| `business_first_name_yomi` | string | No | Employee business first name phonetic reading. |
| `emergency_last_name_yomi` | string | No | Employee emergency last name phonetic reading. |
| `last_employment_start_on` | string | No | Employee last employment start on. |
| `nearest_station_and_line` | string | No | Employee nearest station and line. |
| `commutation_1_single_fare` | integer | No | Employee commutation 1 single fare. |
| `commutation_2_single_fare` | integer | No | Employee commutation 2 single fare. |
| `emergency_first_name_yomi` | string | No | Employee emergency first name phonetic reading. |
| `first_employment_start_on` | string | No | Employee first employment start on. |
| `basic_pension_number_image` | object | No | Employee basic pension number image. |
| `foreign_resident_last_name` | string | No | Employee foreign resident last name. |
| `previous_employment_end_on` | string | No | Employee previous employment end on. |
| `foreign_resident_first_name` | string | No | Employee foreign resident first name. |
| `last_workplace_address_text` | string | No | Employee last workplace address text. |
| `monthly_standard_income_hel` | integer | No | Employee monthly standard income health. |
| `monthly_standard_income_pns` | integer | No | Employee monthly standard income pension. |
| `first_workplace_address_text` | string | No | Employee first workplace address text. |
| `foreign_resident_card_image1` | object | No | Employee foreign resident card image1. |
| `foreign_resident_card_image2` | object | No | Employee foreign resident card image2. |
| `foreign_resident_card_number` | string | No | Employee foreign resident card number. |
| `foreign_resident_middle_name` | string | No | Employee foreign resident middle name. |
| `handicapped_note_delivery_at` | string | No | Employee handicapped note delivery date. |
| `previous_employment_start_on` | string | No | Employee previous employment start on. |
| `resident_status_other_reason` | string | No | Employee resident status other reason. |
| `emp_ins_insured_person_number` | string | No | Employee employment insurance insured person number. |
| `having_ex_activity_permission` | string ("permitted" | "none") | No | Employee having ex activity permission. |
| `health_insurance_qualified_at` | string | No | Employee health insurance qualified date. |
| `hel_ins_insured_person_number` | integer | No | Employee health insurance insured person number. |
| `soc_ins_insured_person_number` | integer | No | Employee social insurance insured person number. |
| `care_insurance_premium_company` | integer | No | Employee care insurance premium company. |
| `child_care_support_fund_company` | integer | No | Employee child care support fund company. |
| `health_insurance_disqualified_at` | string | No | Employee health insurance disqualified date. |
| `health_insurance_premium_company` | integer | No | Employee health insurance premium company. |
| `care_insurance_premium_individual` | integer | No | Employee care insurance premium individual. |
| `child_care_support_fund_individual` | integer | No | Employee child care support fund individual. |
| `insurance_premium_calculation_type` | string ("rate" | "fixed") | No | Employee insurance premium calculation type. |
| `monthly_standard_income_updated_at` | string | No | Employee monthly standard income updated date. |
| `emp_ins_insured_person_number_image` | object | No | Employee employment insurance insured person number image. |
| `first_enrolling_in_emp_pns_ins_flag` | boolean | No | Employee first enrolling in employment pension insurance flag. |
| `health_insurance_premium_individual` | integer | No | Employee health insurance premium individual. |
| `resident_card_address_relation_name` | string | No | Employee resident card address relation name. |
| `resident_card_address_head_of_family` | string | No | Employee resident card address head of family. |
| `basic_pension_number_unknown_reason_type` | string ("non_pensionable" | "unknown") | No | Employee basic pension number unknown reason type. |
| `employees_pension_insurance_qualified_at` | string | No | Employee employees pension insurance qualified date. |
| `employees_pension_insurance_disqualified_at` | string | No | Employee employees pension insurance disqualified date. |
| `employees_pension_insurance_premium_company` | integer | No | Employee employees pension insurance premium company. |
| `employees_pension_insurance_premium_individual` | integer | No | Employee employees pension insurance premium individual. |
| `emp_ins_insured_person_number_unknown_reason_type` | string ("no_work_experience" | "never_joined" | "unknown") | No | Employee employment insurance insured person number unknown reason type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Custom Field Template

**Slug:** `SMARTHR_CREATE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE`

Create an employee custom-field template. The connected API token must have the custom employee field resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hint` | string | No | Input hint. |
| `name` | string | Yes | Custom employee field name. |
| `type` | string ("date" | "decimal" | "enum" | "file" | "string" | "text") | Yes | Input type. |
| `scale` | integer | No | Decimal precision. |
| `elements` | array | No | Dropdown elements. Only applicable when type is 'enum'. |
| `group_id` | string | Yes | ID of the custom employee field group. |
| `position` | integer | Yes | Custom employee field position. |
| `separated_by_commas` | boolean | No | Whether numbers display with thousands separators. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Custom Field Template Group

**Slug:** `SMARTHR_CREATE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUP`

Create an employee custom-field template group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Custom employee field group name. |
| `position` | integer | No | Group position. |
| `access_type` | string ("read_and_update" | "hidden" | "read_and_update_values" | "read_and_update_only_origin") | No | Access type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Dependent

**Slug:** `SMARTHR_CREATE_EMPLOYEE_DEPENDENT`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job` | string | No | Dependent job. |
| `code` | string | No | Dependent code. |
| `gender` | string ("male" | "female") | Yes | Dependent gender. |
| `income` | integer | No | Dependent income. |
| `address` | object | No | Dependent address. |
| `birth_at` | string | Yes | Dependent birth date. |
| `moved_at` | string | No | Dependent moved date. |
| `is_spouse` | boolean | No | Dependent is spouse. |
| `last_name` | string | Yes | Dependent last name. |
| `first_name` | string | Yes | Dependent first name. |
| `tel_number` | string | No | Dependent telephone number. |
| `employee_id` | string | Yes | SmartHR employee ID. |
| `relation_id` | string | Yes | Dependent relation ID. |
| `custom_fields` | array | No | Dependent custom fields. |
| `kinship_image` | object | No | Dependent kinship image. |
| `last_name_yomi` | string | No | Dependent last name phonetic reading. |
| `monthly_income` | integer | No | Dependent monthly income. |
| `first_name_yomi` | string | No | Dependent first name phonetic reading. |
| `handicapped_type` | string ("ordinary_handicapped" | "special_handicapped" | "special_handicapped_living_together") | No | Dependent handicapped type. |
| `handicapped_image` | object | No | Dependent handicapped image. |
| `remittance_image1` | object | No | Dependent remittance image1. |
| `remittance_image2` | object | No | Dependent remittance image2. |
| `remittance_image3` | object | No | Dependent remittance image3. |
| `live_together_type` | string ("living_together" | "living_separately") | Yes | Dependent live together type. |
| `disqualified_reason` | string | No | Dependent disqualified reason. |
| `basic_pension_number` | string | No | Dependent basic pension number. |
| `soc_ins_qualified_at` | string | No | Dependent social insurance qualified date. |
| `tax_deduction_income` | integer | No | Dependent tax deduction income. |
| `tax_law_support_type` | string ("unsupported" | "unsupported_same_living_spouse" | "supported" | "special_spousal_exemption" | "unknown") | No | Dependent tax law support type. |
| `handicapped_note_type` | string | No | Dependent handicapped note type. |
| `international_student` | boolean | No | Dependent international student. |
| `remittance_to_relative` | integer | No | Dependent remittance to relative. |
| `soc_ins_disqualified_at` | string | No | Dependent social insurance disqualified date. |
| `disqualified_reason_type` | string ("death" | "divorce" | "employment" | "income_increase" | "aging_out_75" | "disability_certificate" | "others") | No | Dependent disqualified reason type. |
| `maternity_handbook_image` | object | No | Dependent maternity handbook image. |
| `soc_ins_qualified_reason` | string | No | Dependent social insurance qualified reason. |
| `basic_pension_number_image` | object | No | Dependent basic pension number image. |
| `tax_deduction_qualified_at` | string | No | Dependent tax deduction qualified date. |
| `international_student_image` | object | No | Dependent international student image. |
| `handicapped_note_delivery_at` | string | No | Dependent handicapped note delivery date. |
| `social_insurance_support_type` | string ("unsupported" | "supported" | "unknown") | No | Dependent social insurance support type. |
| `tax_deduction_disqualified_at` | string | No | Dependent tax deduction disqualified date. |
| `tax_deduction_qualified_reason` | string | No | Dependent tax deduction qualified reason. |
| `tax_deduction_disqualified_reason` | string | No | Dependent tax deduction disqualified reason. |
| `tax_deduction_disqualified_reason_type` | string ("death" | "divorce" | "employment" | "income_increase" | "others") | No | Dependent tax deduction disqualified reason type. |
| `spouse_dependent_disqualification_reason` | string | No | Dependent spouse dependent disqualification reason. |
| `spouse_dependent_disqualification_dead_at` | string | No | Dependent spouse dependent disqualification dead date. |
| `spouse_dependent_qualification_reason_type` | string ("joined_employee_ins" | "changed_soc_ins_to_mutual_aid" | "changed_mutual_aid_to_soc_ins" | "changed_mutual_aid_to_mutual_aid" | "marriage" | "retired" | "income_decrease" | "others") | No | Dependent spouse dependent qualification reason type. |
| `spouse_dependent_disqualification_reason_type` | string ("dead" | "others") | No | Dependent spouse dependent disqualification reason type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Employment Type

**Slug:** `SMARTHR_CREATE_EMPLOYMENT_TYPE`

Create a SmartHR employment type. The connected API access token must have the employment type resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Employment type code. |
| `name` | string | Yes | Employment type name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Grade

**Slug:** `SMARTHR_CREATE_GRADE`

Create a SmartHR grade. The connected API access token must have the grade resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Grade name. |
| `rank` | integer | No | Grade rank from 1 to 99999. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Job Category

**Slug:** `SMARTHR_CREATE_JOB_CATEGORY`

Create a SmartHR job category. The connected API access token must have the job category resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Job category name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Job Title

**Slug:** `SMARTHR_CREATE_JOB_TITLE`

Create a SmartHR job title. The connected API access token must have the job title resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Job title code. |
| `name` | string | No | Job title name. |
| `rank` | integer | No | Job title rank from 1 to 99999. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Payroll

**Slug:** `SMARTHR_CREATE_PAYROLL`

Create a sensitive SmartHR payroll group. The connected API access token must have payroll Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `paid_at` | string | Yes | Payment date. |
| `payment_type` | string ("salary" | "bonus") | Yes | Payment type. |
| `name_for_crew` | string | Yes | Payroll group name shown to employees. |
| `period_end_at` | string | Yes | End date of the payroll period. |
| `name_for_admin` | string | Yes | Payroll group name shown to administrators. |
| `period_start_at` | string | Yes | Start date of the payroll period. |
| `numeral_system_handle_type` | string ("as_is" | "force_sexagesimal" | "force_decimal") | Yes | Numeral-system handling mode. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Payslip

**Slug:** `SMARTHR_CREATE_PAYSLIP`

Create a sensitive employee payslip in one SmartHR payroll group. The connected API access token must have payslip resource Update permission, and employee-field Update permissions may constrain writable data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `memo` | string | No | Optional payslip notes. |
| `values` | array | Yes | Payslip item names and their string-form values. |
| `company_id` | string | No | Optional company ID associated with the payslip. |
| `payroll_id` | string | Yes | Payroll group ID in which to create the sensitive payslip. |
| `employee_id` | string | Yes | Employee ID for the payslip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Recruitment Type

**Slug:** `SMARTHR_CREATE_RECRUITMENT_TYPE`

Create a SmartHR recruitment type. The connected API access token must have the recruitment type resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Recruitment type name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Tax Withholding

**Slug:** `SMARTHR_CREATE_TAX_WITHHOLDING`

Create a sensitive SmartHR tax-withholding group in the unconfirmed state. The connected API access token must have tax-withholding-group Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Tax-withholding group name. |
| `year` | string ("H28" | "H29" | "H30" | "H31" | "R01" | "R02" | "R03" | "R04" | "R05" | "R06" | "R07" | "R08" | "R09") | Yes | Japanese era year to print on the tax-withholding slips. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Tax Withholding Slip

**Slug:** `SMARTHR_CREATE_TAX_WITHHOLDING_SLIP`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | File for a file-backed tax-withholding slip. |
| `memo` | string | No | Slip notes. |
| `widow` | string | No | Widow-status string marker; SmartHR's Swagger does not enumerate accepted values. |
| `values` | array | No | SmartHR legacy ordered array. SmartHR does not document the item order; prefer the named fields. Use only when replaying a known provider-compatible payload. |
| `widower` | string | No | Widower-status string marker; SmartHR's Swagger does not enumerate accepted values. |
| `column_b` | string | No | Tax-table column B string marker; SmartHR's Swagger does not enumerate accepted values. |
| `underage` | string | No | Minor-status string marker; SmartHR's Swagger does not enumerate accepted values. |
| `foreigner` | string | No | Foreign-national string marker; SmartHR's Swagger does not enumerate accepted values. |
| `slip_type` | string | No | Tax-withholding slip type. SmartHR accepts '給与・賞与' for structured slips. |
| `company_id` | string | No | Company ID to associate with the tax-withholding slip. |
| `employee_id` | string | Yes | Employee ID for the tax-withholding slip. |
| `crew_birth_at` | string | No | Employee date of birth. |
| `crew_position` | string | No | Employee job title. |
| `single_parent` | string | No | Single-parent string marker; SmartHR's Swagger does not enumerate accepted values. |
| `special_widow` | string | No | Special-widow string marker; SmartHR's Swagger does not enumerate accepted values. |
| `crew_full_name` | string | No | Employee full name. |
| `payment_amount` | integer | No | Payment amount. |
| `disaster_victim` | string | No | Disaster-victim string marker; SmartHR's Swagger does not enumerate accepted values. |
| `owner_full_name` | string | No | Payer full name. |
| `working_student` | string | No | Working-student string marker; SmartHR's Swagger does not enumerate accepted values. |
| `mid_term_entered` | string | No | Mid-year employment-start string marker; SmartHR's Swagger does not enumerate accepted values. |
| `spouse_deduction` | string | No | String marker that a deductible spouse is present. SmartHR's Swagger does not enumerate accepted marker values. |
| `spouse_full_name` | string | No | Spouse full name. |
| `mid_term_resigned` | string | No | Mid-year resignation string marker; SmartHR's Swagger does not enumerate accepted values. |
| `other_handicapped` | string | No | Employee other-disability string marker; SmartHR's Swagger does not enumerate accepted values. |
| `resigned_by_death` | string | No | Death-related resignation string marker; SmartHR's Swagger does not enumerate accepted values. |
| `tax_withholding_id` | string | Yes | Tax-withholding group ID in which to create the sensitive slip. |
| `crew_full_name_yomi` | string | No | Employee full name in phonetic form. |
| `special_handicapped` | string | No | Employee special-disability string marker; SmartHR's Swagger does not enumerate accepted values. |
| `spouse_non_resident` | string | No | Deductible spouse non-resident category code. SmartHR's Swagger does not enumerate accepted code values. |
| `spouse_total_income` | integer | No | Spouse total income. |
| `crew_address_literal` | string | No | Employee address. |
| `spouse_deduction_sub` | string | No | String marker for the secondary deductible-spouse category. SmartHR's Swagger does not enumerate accepted marker values. |
| `dependent_1_full_name` | string | No | First dependent full name. |
| `other_dependent_count` | integer | No | Number of other dependents. |
| `spouse_full_name_yomi` | string | No | Spouse full name in phonetic form. |
| `basic_deduction_amount` | integer | No | Basic deduction amount. |
| `soc_ins_payment_amount` | integer | No | Social insurance payment amount. |
| `withholding_tax_amount` | integer | No | Withholding tax amount. |
| `elderly_dependent_count` | integer | No | Number of elderly dependents. |
| `dependent_1_non_resident` | string ("0" | "1" | "00" | "01" | "02" | "03" | "04" | "10" | "11" | "20" | "21" | "30" | "31" | "40" | "41" | "50" | "51" | "60" | "61" | "70" | "71" | "80" | "81" | "90" | "91") | No | First dependent non-resident category. Use '0' or '1' for older tax-year formats; use one of 00, 01, 02, 03, 04, 10, 11, 20, 21, 30, 31, 40, 41, 50, 51, 60, 61, 70, 71, 80, 81, 90, or 91 for current tax-year formats. |
| `specific_dependent_count` | integer | No | Number of specific dependents. |
| `spouse_deduction_elderly` | string | No | String marker that the deductible spouse is elderly. SmartHR's Swagger does not enumerate accepted marker values. |
| `housing_loan_1_started_at` | string | No | First housing loan residence start date. |
| `housing_loan_2_started_at` | string | No | Second housing loan residence start date. |
| `life_ins_deduction_amount` | integer | No | Life insurance deduction amount. |
| `other_dependent_sub_count` | integer | No | Number of secondary other dependents. |
| `care_health_payment_amount` | integer | No | Nursing and medical insurance premium amount. |
| `dependent_1_full_name_yomi` | string | No | First dependent name in phonetic form. |
| `elderly_dependent_sub_count` | integer | No | Number of secondary elderly dependents. |
| `new_life_ins_payment_amount` | integer | No | New life insurance premium amount. |
| `non_resident_relative_count` | integer | No | Number of non-resident relatives. |
| `old_life_ins_payment_amount` | integer | No | Old life insurance premium amount. |
| `biz_establishment_tel_number` | string | No | Payer business establishment telephone number. |
| `housing_loan_deduction_count` | integer | No | Number of housing loan deductions. |
| `specific_dependent_sub_count` | integer | No | Number of secondary specific dependents. |
| `housing_loan_1_deduction_type` | string | No | First housing-loan special-deduction type code. SmartHR's provider docs do not enumerate code values. |
| `housing_loan_2_deduction_type` | string | No | Second housing-loan special-deduction type code. SmartHR's provider docs do not enumerate code values. |
| `housing_loan_deduction_amount` | integer | No | Housing loan deduction amount. |
| `under_16_years_dependent_count` | integer | No | Number of dependents under 16. |
| `earthquake_ins_deduction_amount` | integer | No | Earthquake insurance deduction amount. |
| `mid_term_entered_or_resigned_at` | string | No | Mid-year employment start or resignation date. |
| `national_pension_payment_amount` | integer | No | National pension insurance premium amount. |
| `spouse_special_deduction_amount` | integer | No | Special spouse deduction amount. |
| `biz_establishment_address_literal` | string | No | Payer business establishment address. |
| `other_handicapped_dependent_count` | integer | No | Number of other disabled dependents. |
| `specific_relative_dependent_count` | integer | No | Number of specific-relative dependents. |
| `income_adjustment_deduction_amount` | integer | No | Income adjustment deduction amount. |
| `special_handicapped_dependent_count` | integer | No | Number of special-disabled dependents. |
| `dependent_under_16_years_1_full_name` | string | No | First under-16 dependent full name. |
| `elderly_dependent_live_together_count` | integer | No | Number of elderly dependents living together. |
| `housing_loan_special_deduction_amount` | integer | No | Available housing loan special deduction amount. |
| `payment_after_income_deduction_amount` | integer | No | Payment after income deductions. |
| `specific_relative_dependent_sub_count` | integer | No | Number of secondary specific-relative dependents. |
| `dependent_under_16_years_1_non_resident` | string | No | First under-16 dependent non-resident category code. SmartHR's Swagger does not enumerate accepted code values. |
| `housing_loan_1_deduction_balance_amount` | integer | No | First housing loan year-end balance. |
| `housing_loan_2_deduction_balance_amount` | integer | No | Second housing loan year-end balance. |
| `new_personal_pension_ins_payment_amount` | integer | No | New personal pension insurance premium amount. |
| `old_personal_pension_ins_payment_amount` | integer | No | Old personal pension insurance premium amount. |
| `dependent_under_16_years_1_full_name_yomi` | string | No | First under-16 dependent name in phonetic form. |
| `old_long_term_property_ins_payment_amount` | integer | No | Old long-term casualty insurance premium amount. |
| `payment_after_emp_income_deduction_amount` | integer | No | Payment after employment income deductions. |
| `specific_relative_special_deduction_amount` | integer | No | Specific-relative special deduction amount. |
| `special_handicapped_dependent_live_together_count` | integer | No | Number of special-disabled dependents living together. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 User SAML Configuration

**Slug:** `SMARTHR_CREATE_USER_SAML_CONFIGURATION`

Create the SAML SSO account configuration for one SmartHR user. The tenant must have SAML SSO enabled, and the connected API access token must have the user resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SmartHR user ID whose SAML configuration to create. |
| `upn` | string | Yes | User identifier for the linked identity provider account. |
| `enable` | boolean | Yes | Whether to enable the SAML account when it is created. |
| `user_id` | string | Yes | SmartHR user ID to associate with the SAML account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Webhook

**Slug:** `SMARTHR_CREATE_WEBHOOK`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Webhook notification destination URL. |
| `access_type` | string ("read_and_update" | "hidden" | "read_and_update_only_origin") | No | Webhook access type. |
| `description` | string | No | Webhook description. |
| `disabled_at` | string | No | Date on which to disable the webhook. |
| `crew_created` | boolean | Yes | Whether to notify when an employee record is created. |
| `crew_deleted` | boolean | Yes | Whether to notify when an employee record is deleted. |
| `crew_updated` | boolean | Yes | Whether to notify when an employee record is updated. |
| `secret_token` | string | No | Secret token SmartHR includes with webhook deliveries. |
| `crew_imported` | boolean | Yes | Whether to notify when employee records are imported. |
| `expose_only_id` | boolean | No | Whether webhook deliveries should contain only the changed record ID. |
| `dependent_created` | boolean | Yes | Whether to notify when a dependent record is created. |
| `dependent_deleted` | boolean | Yes | Whether to notify when a dependent record is deleted. |
| `dependent_updated` | boolean | Yes | Whether to notify when a dependent record is updated. |
| `dependent_imported` | boolean | Yes | Whether to notify when dependent records are imported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Department

**Slug:** `SMARTHR_DELETE_DEPARTMENT`

Deprecated: 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `department_id` | string | Yes | SmartHR department ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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

**Slug:** `SMARTHR_DELETE_EMPLOYEE`

Permanently delete one employee by SmartHR employee ID. This requires the employee resource Update permission on the connected access token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SmartHR employee ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Custom Field Template

**Slug:** `SMARTHR_DELETE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE`

Delete one employee custom-field template by ID. This permanently deletes all employee values set for the template. SmartHR rejects deletion when the field has a scheduled employee update whose effective date has not arrived.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | Custom employee field template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Custom Field Template Group

**Slug:** `SMARTHR_DELETE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUP`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | Custom employee field group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Dependent

**Slug:** `SMARTHR_DELETE_EMPLOYEE_DEPENDENT`

Permanently delete one dependent and their sensitive family data from an employee record. This cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employee_id` | string | Yes | SmartHR employee ID. |
| `dependent_id` | string | Yes | SmartHR dependent ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Employment Type

**Slug:** `SMARTHR_DELETE_EMPLOYMENT_TYPE`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employment_type_id` | string | Yes | SmartHR employment type ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Grade

**Slug:** `SMARTHR_DELETE_GRADE`

Delete one SmartHR grade by ID. A grade referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the grade resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `grade_id` | string | Yes | SmartHR grade ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Job Category

**Slug:** `SMARTHR_DELETE_JOB_CATEGORY`

Delete one SmartHR job category by ID. A job category referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the job category resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_category_id` | string | Yes | SmartHR job category ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Job Title

**Slug:** `SMARTHR_DELETE_JOB_TITLE`

Delete one SmartHR job title by ID. A job title referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the job title resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_title_id` | string | Yes | SmartHR job title ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Payroll

**Slug:** `SMARTHR_DELETE_PAYROLL`

Permanently delete one sensitive SmartHR payroll group by ID. The connected API access token must have the payroll resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payroll_id` | string | Yes | SmartHR payroll group ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Payslip

**Slug:** `SMARTHR_DELETE_PAYSLIP`

Permanently delete one sensitive SmartHR payslip from its payroll group. The connected API access token must have the payslip resource Update permission, and employee fields may also require Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payroll_id` | string | Yes | SmartHR payroll group ID containing the payslip. |
| `payslip_id` | string | Yes | SmartHR payslip ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Recruitment Type

**Slug:** `SMARTHR_DELETE_RECRUITMENT_TYPE`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `recruitment_type_id` | string | Yes | SmartHR recruitment type ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Tax Withholding

**Slug:** `SMARTHR_DELETE_TAX_WITHHOLDING`

Permanently delete one sensitive SmartHR tax-withholding group by ID. The connected API access token must have the tax-withholding-group resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax_withholding_id` | string | Yes | SmartHR tax-withholding group ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Tax Withholding Slip

**Slug:** `SMARTHR_DELETE_TAX_WITHHOLDING_SLIP`

Permanently 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax_withholding_id` | string | Yes | SmartHR tax-withholding group ID containing the slip. |
| `tax_withholding_slip_id` | string | Yes | SmartHR tax-withholding slip ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 User SAML Configuration

**Slug:** `SMARTHR_DELETE_USER_SAML_CONFIGURATION`

Delete the SAML SSO account configuration for one SmartHR user. The tenant must have SAML SSO enabled, and the connected API access token must have the user resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SmartHR user ID whose SAML configuration to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Webhook

**Slug:** `SMARTHR_DELETE_WEBHOOK`

Permanently delete one SmartHR webhook configuration by ID. The connected API access token must have the webhook resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SmartHR webhook ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Disable User SAML Configuration

**Slug:** `SMARTHR_DISABLE_USER_SAML_CONFIGURATION`

Disable the SAML SSO account configuration for one SmartHR user. The tenant must have the SAML/SSO option enabled, and the connected API access token must have the user resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SmartHR user ID whose SAML configuration to disable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Discontinue Department

**Slug:** `SMARTHR_DISCONTINUE_DEPARTMENT`

Irreversibly 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SmartHR department ID to discontinue. |
| `discontinued_date` | string | Yes | The department's final active date in YYYY-MM-DD format. SmartHR accepts only a date in the past. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Download Batch Job Attachment

**Slug:** `SMARTHR_DOWNLOAD_BATCH_JOB_ATTACHMENT`

Download the binary file for a SmartHR batch-job attachment. SmartHR deletes the provider attachment five minutes after it is retrieved, so use the returned offloaded file reference for subsequent work.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachment_id` | string | Yes | Batch-job attachment ID returned by a SmartHR batch job. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Enable User SAML Configuration

**Slug:** `SMARTHR_ENABLE_USER_SAML_CONFIGURATION`

Enable the SAML SSO account configuration for one SmartHR user. The tenant must have the SAML/SSO option enabled, and the connected API access token must have the user resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SmartHR user ID whose SAML configuration to enable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Finalize Payroll

**Slug:** `SMARTHR_FINALIZE_PAYROLL`

Finalize one sensitive SmartHR payroll group. The connected API access token must have the payroll-group resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SmartHR payroll group ID to finalize. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Batch Job

**Slug:** `SMARTHR_GET_BATCH_JOB`

Get one SmartHR background batch job by ID, optionally embedding its attachments. The access token needs the corresponding resource Reference permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | string | No | Set to 'attachments' to include batch job attachments in the response. |
| `batch_job_id` | string | Yes | SmartHR background batch job ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Department

**Slug:** `SMARTHR_GET_DEPARTMENT`

Get one SmartHR department by its department ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `department_id` | string | Yes | SmartHR department ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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:** `SMARTHR_GET_EMPLOYEE`

Get one employee by SmartHR employee ID, with optional comma-separated field selection. The access token needs employee Reference permission, and returned attributes may be limited by employee-field Reference permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated names of employee fields to return. |
| `employee_id` | string | Yes | SmartHR employee ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Custom Field Template

**Slug:** `SMARTHR_GET_EMPLOYEE_CUSTOM_FIELD_TEMPLATE`

Get one employee custom-field template by ID. Set embed to group to include the custom field group that contains the template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | string | No | Set to 'group' to include the template's custom field group. |
| `template_id` | string | Yes | Custom employee field template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Custom Field Template Group

**Slug:** `SMARTHR_GET_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUP`

Get one employee custom-field template group by ID. Set embed to templates to include the custom field templates belonging to the group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | string | No | Set to 'templates' to include the custom field templates in the group. |
| `group_id` | string | Yes | Custom employee field group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Dependent

**Slug:** `SMARTHR_GET_EMPLOYEE_DEPENDENT`

Get one dependent belonging to an employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employee_id` | string | Yes | SmartHR employee ID. |
| `dependent_id` | string | Yes | SmartHR dependent ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Input Form

**Slug:** `SMARTHR_GET_EMPLOYEE_INPUT_FORM`

Get one SmartHR employee information-collection form by ID, preserving its nested field groups, fields, and embedded custom-field definitions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | string | No | Set to 'mail_format' to embed the mail format linked to the form. |
| `form_id` | string | Yes | Employee information-collection form ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Employment Type

**Slug:** `SMARTHR_GET_EMPLOYMENT_TYPE`

Get one SmartHR employment type by its employment type ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employment_type_id` | string | Yes | SmartHR employment type ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Grade

**Slug:** `SMARTHR_GET_GRADE`

Get one SmartHR grade by its grade ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `grade_id` | string | Yes | SmartHR grade ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Job Category

**Slug:** `SMARTHR_GET_JOB_CATEGORY`

Get one SmartHR job category by its job category ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_category_id` | string | Yes | SmartHR job category ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Job Title

**Slug:** `SMARTHR_GET_JOB_TITLE`

Get one SmartHR job title by its job title ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_title_id` | string | Yes | SmartHR job title ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Mail Format

**Slug:** `SMARTHR_GET_MAIL_FORMAT`

Get one SmartHR mail format by ID, optionally embedding the employee information-collection forms that use it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | string | No | Set to 'crew_input_forms' to embed forms that use this mail format. |
| `mail_format_id` | string | Yes | SmartHR mail format ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Payment Period

**Slug:** `SMARTHR_GET_PAYMENT_PERIOD`

Get one SmartHR payroll payment period by its payment period ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payment_period_id` | string | Yes | SmartHR payment period ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Payroll

**Slug:** `SMARTHR_GET_PAYROLL`

Get one sensitive SmartHR payroll group by ID. The access token needs payroll Reference permission, and returned data may contain sensitive financial information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payroll_id` | string | Yes | SmartHR payroll group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Payslip

**Slug:** `SMARTHR_GET_PAYSLIP`

Get one highly sensitive SmartHR payslip from a payroll group. The access token needs payslip Reference permission, and returned employee fields may be permission-filtered.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | string | No | Set to company to embed the payslip's company details. |
| `payroll_id` | string | Yes | SmartHR payroll group ID containing the payslip. |
| `payslip_id` | string | Yes | SmartHR payslip ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Recruitment Type

**Slug:** `SMARTHR_GET_RECRUITMENT_TYPE`

Get one SmartHR recruitment type by its recruitment type ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `recruitment_type_id` | string | Yes | SmartHR recruitment type ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Tax Withholding

**Slug:** `SMARTHR_GET_TAX_WITHHOLDING`

Get one highly sensitive SmartHR tax-withholding group by ID. The access token needs tax-withholding-group Reference permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax_withholding_id` | string | Yes | SmartHR tax-withholding group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Tax Withholding Slip

**Slug:** `SMARTHR_GET_TAX_WITHHOLDING_SLIP`

Get one highly sensitive SmartHR tax-withholding slip from a tax-withholding group. The access token needs tax-withholding-slip Reference permission, and employee fields may be permission-filtered.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | string | No | Set to company to embed the slip's full company details. |
| `slip_id` | string | Yes | SmartHR tax-withholding slip ID. |
| `tax_withholding_id` | string | Yes | SmartHR tax-withholding group ID containing the slip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 User

**Slug:** `SMARTHR_GET_USER`

Get one SmartHR user account by user ID with an optional related object embedded in the response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SmartHR user ID. |
| `embed` | string ("crew" | "biz_establishment" | "biz_establishment_company" | "department_company") | No | Related object to embed in the user response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 User SAML Configuration

**Slug:** `SMARTHR_GET_USER_SAML_CONFIGURATION`

Get the SAML SSO account configuration for one SmartHR user. This endpoint requires the tenant's SAML/SSO option to be enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | SmartHR user ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Webhook

**Slug:** `SMARTHR_GET_WEBHOOK`

Get one SmartHR webhook configuration by webhook ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | SmartHR webhook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Invite Employee

**Slug:** `SMARTHR_INVITE_EMPLOYEE`

Send the documented SmartHR invitation to one employee's configured email address. Repeating the action resends the invitation unless the employee has already accepted it; the inviter must be an administrator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SmartHR employee ID to invite. |
| `inviter_user_id` | string | Yes | SmartHR user ID of the administrator sending the invitation. |
| `crew_input_form_id` | string | No | Employee information collection form ID to use for the invitation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Bank Account Settings

**Slug:** `SMARTHR_LIST_BANK_ACCOUNT_SETTINGS`

List one page of SmartHR bank-account setting definitions. This does not return employee bank-account values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of bank account settings to fetch. Ignored when cursor is supplied. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of bank account settings to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Batch Jobs

**Slug:** `SMARTHR_LIST_BATCH_JOBS`

List one page of SmartHR background batch jobs. Optionally embed attachment metadata for each job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of batch jobs to fetch. Ignored when cursor is supplied. |
| `sort` | string ("created_at" | "-created_at" | "updated_at" | "-updated_at") | No | Field and direction used to sort jobs. |
| `embed` | string | No | Set to 'attachments' to embed each batch job's attachments. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of batch jobs to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Business Establishments

**Slug:** `SMARTHR_LIST_BUSINESS_ESTABLISHMENTS`

List one page of SmartHR business establishments, optionally embedding the social insurance representative, labor insurance representative, or company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of business establishments to fetch. Ignored when cursor is supplied. |
| `embed` | string ("soc_ins_owner" | "lab_ins_owner" | "company") | No | Related object to embed in each establishment. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of business establishments to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Companies

**Slug:** `SMARTHR_LIST_COMPANIES`

List one page of SmartHR companies with an optional embedded owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of companies to fetch. Ignored when cursor is supplied. |
| `embed` | string | No | Set to owner to embed each company's representative employee. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of companies to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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:** `SMARTHR_LIST_DEPARTMENTS`

List one page of SmartHR departments using the documented code and sort filters. Returns hierarchy and company details when present.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Filter departments by department code. |
| `page` | integer | No | Page of departments to fetch. Ignored when cursor is supplied. |
| `sort` | string | No | Comma-separated sort fields; prefix a field with '-' for descending order. SmartHR does not publish a finite list of accepted sort keys. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of departments to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Dependent Custom Field Templates

**Slug:** `SMARTHR_LIST_DEPENDENT_CUSTOM_FIELD_TEMPLATES`

List one page of SmartHR custom-field templates for employee dependents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of dependent custom field templates to fetch. Ignored when cursor is supplied. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of dependent custom field templates to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Dependent Relations

**Slug:** `SMARTHR_LIST_DEPENDENT_RELATIONS`

List one page of configured SmartHR dependent relationship types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of dependent relationship types to fetch. Ignored when cursor is supplied. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `filter` | string | No | Filter relationship types. Use spouse to return only spouse relationships. |
| `per_page` | integer | No | Number of dependent relationship types to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Custom Field Template Groups

**Slug:** `SMARTHR_LIST_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUPS`

List one page of employee custom-field template groups. Set embed to templates to include the custom fields belonging to each group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of custom-field template groups to fetch. Ignored when cursor is supplied. |
| `embed` | string | No | Set to 'templates' to include each group's custom-field templates. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of custom-field template groups to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Custom Field Templates

**Slug:** `SMARTHR_LIST_EMPLOYEE_CUSTOM_FIELD_TEMPLATES`

List one page of SmartHR employee custom-field templates. Set embed to group to include each template's custom-field group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of custom field templates to fetch. Ignored when cursor is supplied. |
| `embed` | string | No | Set to 'group' to embed each template's custom field group. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of custom field templates to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Dependents

**Slug:** `SMARTHR_LIST_EMPLOYEE_DEPENDENTS`

List one page of sensitive family and dependent records for a SmartHR employee. The access token needs dependent Reference permission, and returned fields may be limited by employee-field Reference permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of dependents to fetch. Ignored when cursor is supplied. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of dependents to return per page (1-100). |
| `employee_id` | string | Yes | SmartHR employee ID whose dependents to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Input Forms

**Slug:** `SMARTHR_LIST_EMPLOYEE_INPUT_FORMS`

List one page of SmartHR employee information-collection forms with their nested field definitions. Set embed to mail_format to include linked mail formats.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of employee input forms to fetch. Ignored when cursor is supplied. |
| `embed` | string | No | Set to 'mail_format' to embed the mail format linked to each form. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of employee input forms to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Maternity and Childcare Leaves

**Slug:** `SMARTHR_LIST_EMPLOYEE_MATERNITY_CHILDCARE_LEAVES`

List one page of sensitive maternity and childcare leave records for a SmartHR employee. The access token needs leave-record Reference permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of leave records to fetch. Ignored when cursor is supplied. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of leave records to return per page (1-100). |
| `employee_id` | string | Yes | SmartHR employee ID whose maternity and childcare leave records to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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:** `SMARTHR_LIST_EMPLOYEES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Free-text search across names, business names, departments, and positions. |
| `id` | string | No | Comma-separated employee IDs. |
| `page` | integer | No | Page of results to fetch. Ignored when cursor is supplied. |
| `sort` | string | No | Comma-separated sort fields; prefix a field with '-' for descending order. SmartHR does not publish a finite list of accepted sort keys. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `fields` | string | No | Comma-separated employee field names to return. Request only fields needed for the task. |
| `gender` | string ("male" | "female") | No | Filter by legal gender. |
| `user_id` | string | No | Comma-separated SmartHR user IDs. |
| `emp_code` | string | No | Filter by employee number. |
| `emp_type` | string ("board_member" | "full_timer" | "contract_worker" | "permatemp" | "part_timer" | "outsourcing_contractor" | "etc") | No | Deprecated preset employment type. Prefer employment_type_id. |
| `per_page` | integer | No | Number of employees to return per page (1-100). |
| `emp_status` | string ("employed" | "absent" | "retired") | No | Filter by employment status. |
| `position_id` | string | No | Comma-separated job-position IDs. |
| `department_id` | string | No | Comma-separated department IDs. |
| `entered_at_to` | string | No | Include employees who joined on or before this date (YYYY-MM-DD). |
| `resigned_at_to` | string | No | Include employees who resigned on or before this date (YYYY-MM-DD). |
| `entered_at_from` | string | No | Include employees who joined on or after this date (YYYY-MM-DD). |
| `resigned_at_from` | string | No | Include employees who resigned on or after this date (YYYY-MM-DD). |
| `employment_type_id` | string | No | Comma-separated employment type IDs. |
| `prefer_business_name` | boolean | No | Whether free-text search should prefer employees' business names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Employment Types

**Slug:** `SMARTHR_LIST_EMPLOYMENT_TYPES`

List one page of SmartHR employment types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of employment types to fetch. Ignored when cursor is supplied. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of employment types to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Grades

**Slug:** `SMARTHR_LIST_GRADES`

List one page of SmartHR grades.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of grades to fetch. Ignored when cursor is supplied. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of grades to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Job Categories

**Slug:** `SMARTHR_LIST_JOB_CATEGORIES`

List one page of SmartHR job categories.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of job categories to fetch. Ignored when cursor is supplied. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of job categories to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Job Titles

**Slug:** `SMARTHR_LIST_JOB_TITLES`

List one page of SmartHR job titles using the documented sort option.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of job titles to fetch. Ignored when cursor is supplied. |
| `sort` | string | No | Comma-separated sort fields; prefix a field with '-' for descending order. SmartHR does not publish a finite list of accepted sort keys. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of job titles to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Mail Formats

**Slug:** `SMARTHR_LIST_MAIL_FORMATS`

List one page of SmartHR mail formats. Set embed to crew_input_forms to include the employee input forms linked to each format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of mail formats to fetch. Ignored when cursor is supplied. |
| `embed` | string | No | Set to 'crew_input_forms' to embed linked employee input forms. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of mail formats to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Payment Periods

**Slug:** `SMARTHR_LIST_PAYMENT_PERIODS`

List one page of SmartHR payroll payment periods.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of payment periods to fetch. Ignored when cursor is supplied. |
| `sort` | string | No | Comma-separated sort fields; prefix a field with '-' for descending order. SmartHR does not publish a finite list of accepted sort keys. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of payment periods to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Payrolls

**Slug:** `SMARTHR_LIST_PAYROLLS`

List one page of sensitive SmartHR payroll groups using payment-date and payment-type filters. The access token needs payroll Reference permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of payroll groups to fetch. Ignored when cursor is supplied. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of payroll groups to return per page (1-100). |
| `paid_at_to` | string | No | Include payroll groups paid on or before this date (YYYY-MM-DD). |
| `paid_at_from` | string | No | Include payroll groups paid on or after this date (YYYY-MM-DD). |
| `payment_type` | string ("salary" | "bonus") | No | Filter by salary or bonus payment type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Payslips

**Slug:** `SMARTHR_LIST_PAYSLIPS`

List one page of highly sensitive SmartHR payslips in a payroll group. The access token needs payslip Reference permission, and employee fields may be permission-filtered.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of payslips to fetch. Ignored when cursor is supplied. |
| `embed` | string | No | Set to company to embed company details in each payslip. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of payslips to return per page (1-100). |
| `payroll_id` | string | Yes | SmartHR payroll group ID whose payslips to list. |
| `employee_id` | string | No | Comma-separated employee IDs whose payslips to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Recruitment Types

**Slug:** `SMARTHR_LIST_RECRUITMENT_TYPES`

List one page of SmartHR recruitment types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of recruitment types to fetch. Ignored when cursor is supplied. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of recruitment types to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Tax Withholdings

**Slug:** `SMARTHR_LIST_TAX_WITHHOLDINGS`

List one page of sensitive SmartHR tax-withholding groups. The access token needs tax-withholding-group Reference permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of tax-withholding groups to fetch. Ignored when cursor is supplied. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of tax-withholding groups to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Tax Withholding Slips

**Slug:** `SMARTHR_LIST_TAX_WITHHOLDING_SLIPS`

List one page of sensitive tax-withholding slips in a SmartHR tax-withholding group. The access token needs tax-withholding-slip Reference permission, and employee fields may be permission-filtered.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of tax-withholding slips to fetch. Ignored when cursor is supplied. |
| `embed` | string | No | Set to company to embed company details in each slip. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of tax-withholding slips to return per page (1-100). |
| `tax_withholding_id` | string | Yes | Tax-withholding group ID whose slips to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Users

**Slug:** `SMARTHR_LIST_USERS`

List one page of SmartHR user accounts with the documented sort and embed options, invitation status, role, and email-delivery status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of users to fetch. Ignored when cursor is supplied. |
| `sort` | string | No | Comma-separated sort fields; prefix a field with '-' for descending order. SmartHR does not publish a finite list of accepted sort keys. |
| `embed` | string ("crew" | "biz_establishment" | "biz_establishment_company" | "department_company") | No | Related object to embed in each user record. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of users to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Webhooks

**Slug:** `SMARTHR_LIST_WEBHOOKS`

List one page of SmartHR webhook configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of webhooks to fetch. Ignored when cursor is supplied. |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `per_page` | integer | No | Number of webhooks to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Partially Update Department

**Slug:** `SMARTHR_PARTIALLY_UPDATE_DEPARTMENT`

Partially update a SmartHR department by ID. The connected API access token must have the department resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Department code. |
| `name` | string | Yes | Department name. SmartHR does not allow forward slashes (/). |
| `position` | integer | No | Department position. |
| `parent_id` | string | No | Parent department ID. |
| `company_id` | string | No | Company ID. |
| `department_id` | string | Yes | SmartHR department ID of the department to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Partially Update Employee Custom Field Template

**Slug:** `SMARTHR_PARTIALLY_UPDATE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE`

Partially update an employee custom-field template. Elements apply only to enum templates. When a future-dated employee update is pending for the template, SmartHR permits updating only the hint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hint` | string | No | Input hint. |
| `name` | string | No | Custom employee field name. |
| `type` | string ("date" | "decimal" | "enum" | "file" | "string" | "text") | No | Input type. |
| `scale` | integer | No | Decimal precision. |
| `elements` | array | No | Dropdown elements. Only applicable when type is 'enum'. |
| `group_id` | string | No | ID of the custom employee field group. |
| `position` | integer | No | Custom employee field position. |
| `template_id` | string | Yes | Custom employee field template ID. |
| `separated_by_commas` | boolean | No | Whether numbers display with thousands separators. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Partially Update Employment Type

**Slug:** `SMARTHR_PARTIALLY_UPDATE_EMPLOYMENT_TYPE`

Partially 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Employment type code. |
| `name` | string | Yes | Employment type name. |
| `employment_type_id` | string | Yes | SmartHR employment type ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Partially Update Payroll

**Slug:** `SMARTHR_PARTIALLY_UPDATE_PAYROLL`

Partially update the administrator-facing and employee-facing names of a sensitive SmartHR payroll group by ID. Both names are required by SmartHR. The connected API access token must have the payroll resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payroll_id` | string | Yes | ID of the sensitive SmartHR payroll group to update. |
| `name_for_crew` | string | Yes | Payroll group name shown to employees. |
| `name_for_admin` | string | Yes | Payroll group name shown to SmartHR administrators. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Partially Update User SAML Configuration

**Slug:** `SMARTHR_PARTIALLY_UPDATE_USER_SAML_CONFIGURATION`

Partially update the SAML SSO account configuration for one SmartHR user. The tenant must have SAML SSO enabled, and the connected API access token must have the user resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SmartHR user ID whose SAML configuration to update. |
| `upn` | string | Yes | User identifier for the linked identity provider account. |
| `enable` | boolean | Yes | Whether the user's SAML account is enabled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Partially Update Webhook

**Slug:** `SMARTHR_PARTIALLY_UPDATE_WEBHOOK`

Partially 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Webhook notification destination URL. |
| `webhook_id` | string | Yes | SmartHR webhook ID. |
| `access_type` | string ("read_and_update" | "hidden" | "read_and_update_only_origin") | No | Webhook access type. |
| `description` | string | No | Webhook description. |
| `disabled_at` | string | No | Date on which the webhook is disabled. |
| `crew_created` | boolean | No | Whether to notify when employee information is created. |
| `crew_deleted` | boolean | No | Whether to notify when employee information is deleted. |
| `crew_updated` | boolean | No | Whether to notify when employee information is updated. |
| `secret_token` | string | No | Secret token included with webhook notifications. |
| `crew_imported` | boolean | No | Whether to notify when employee information is imported. |
| `expose_only_id` | boolean | No | Whether webhook notifications contain only the changed record ID. |
| `dependent_created` | boolean | No | Whether to notify when dependent information is created. |
| `dependent_deleted` | boolean | No | Whether to notify when dependent information is deleted. |
| `dependent_updated` | boolean | No | Whether to notify when dependent information is updated. |
| `dependent_imported` | boolean | No | Whether to notify when dependent information is imported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Publish Payroll

**Slug:** `SMARTHR_PUBLISH_PAYROLL`

Irreversibly 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payroll_id` | string | Yes | SmartHR payroll group ID to publish. |
| `published_at` | string | No | Optional scheduled publication time. It cannot be in the past and must be within one month; omit it to publish immediately. |
| `notify_with_publish` | boolean | No | Whether SmartHR should notify employees when publishing. Omit it to publish without notification. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Remove Employee Departments

**Slug:** `SMARTHR_REMOVE_EMPLOYEE_DEPARTMENTS`

Remove all department assignments from one employee using the documented SmartHR endpoint. This requires the employee resource and field Update permissions assigned to the connected access token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employee_id` | string | Yes | SmartHR employee ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Reopen Payroll

**Slug:** `SMARTHR_REOPEN_PAYROLL`

Reopen one sensitive SmartHR payroll group. Reopening a published payroll may also unpublish it. The connected API access token must have payroll Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payroll_id` | string | Yes | SmartHR payroll group ID to reopen. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Replace Department

**Slug:** `SMARTHR_REPLACE_DEPARTMENT`

Replace a SmartHR department through PUT. Omitted optional attributes are deleted; use the partial-update action to preserve attributes that are not being changed. Departments with pending employee updates in their hierarchy cannot be updated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Department code. Omitting it deletes the current value. |
| `name` | string | Yes | Department name. SmartHR does not allow forward slashes (/). |
| `position` | integer | Yes | Department position. SmartHR requires this field for PUT updates. |
| `parent_id` | string | No | Parent department ID. Omitting it deletes the current value. |
| `company_id` | string | No | Company ID. Omitting it deletes the current value. |
| `department_id` | string | Yes | ID of the SmartHR department to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Replace Employee Custom Field Template

**Slug:** `SMARTHR_REPLACE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE`

Replace 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Custom employee field template ID. |
| `hint` | string | No | Input hint. |
| `name` | string | Yes | Custom employee field name. |
| `type` | string ("date" | "decimal" | "enum" | "file" | "string" | "text") | Yes | Input type. |
| `scale` | integer | No | Decimal precision. |
| `elements` | array | No | Dropdown elements. Only applicable when type is 'enum'. |
| `group_id` | string | Yes | ID of the custom employee field group. |
| `position` | integer | Yes | Custom employee field position. |
| `separated_by_commas` | boolean | No | Whether numbers display with thousands separators. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Replace Employee Custom Field Template Group

**Slug:** `SMARTHR_REPLACE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUP`

Replace 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee custom-field template group ID. |
| `name` | string | Yes | Employee custom-field template group name. |
| `position` | integer | No | Display position of the group. |
| `access_type` | string ("read_and_update" | "hidden" | "read_and_update_values" | "read_and_update_only_origin") | No | Access policy that controls whether and how employees can view or update values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Replace Employment Type

**Slug:** `SMARTHR_REPLACE_EMPLOYMENT_TYPE`

Replace 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employment type ID. |
| `name` | string | Yes | Employment type name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Replace Grade

**Slug:** `SMARTHR_REPLACE_GRADE`

Replace 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Grade name. |
| `rank` | integer | No | Grade rank from 1 to 99999. |
| `grade_id` | string | Yes | ID of the SmartHR grade to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Replace Job Category

**Slug:** `SMARTHR_REPLACE_JOB_CATEGORY`

Replace 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Job category name. |
| `job_category_id` | string | Yes | ID of the SmartHR job category to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Replace Job Title

**Slug:** `SMARTHR_REPLACE_JOB_TITLE`

Replace 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Job title name. |
| `rank` | integer | No | Job title rank from 1 to 99999. |
| `job_title_id` | string | Yes | ID of the SmartHR job title to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Replace Recruitment Type

**Slug:** `SMARTHR_REPLACE_RECRUITMENT_TYPE`

Replace 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Recruitment type name. |
| `recruitment_type_id` | string | Yes | ID of the SmartHR recruitment type to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Replace Tax Withholding

**Slug:** `SMARTHR_REPLACE_TAX_WITHHOLDING`

Replace 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Tax-withholding group name. |
| `year` | string ("H28" | "H29" | "H30" | "H31" | "R01" | "R02" | "R03" | "R04" | "R05" | "R06" | "R07" | "R08" | "R09") | Yes | Japanese era year printed on the tax-withholding slips. |
| `status` | string ("wip" | "fixed" | "importing") | Yes | Tax-withholding group status. |
| `tax_withholding_id` | string | Yes | ID of the sensitive SmartHR tax-withholding group to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Replace Webhook

**Slug:** `SMARTHR_REPLACE_WEBHOOK`

Replace 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Webhook ID. |
| `url` | string | Yes | Webhook destination URL. |
| `access_type` | string ("read_and_update" | "hidden" | "read_and_update_only_origin") | No | Webhook access type. |
| `description` | string | No | Webhook description. |
| `disabled_at` | string | No | Date when the webhook is disabled. |
| `crew_created` | boolean | Yes | Whether to notify when employee information is created. |
| `crew_deleted` | boolean | Yes | Whether to notify when employee information is deleted. |
| `crew_updated` | boolean | Yes | Whether to notify when employee information is updated. |
| `secret_token` | string | No | Secret token attached to outbound webhook deliveries. |
| `crew_imported` | boolean | Yes | Whether to notify when employee information is imported. |
| `expose_only_id` | boolean | No | Whether webhook deliveries include only changed data IDs. |
| `dependent_created` | boolean | Yes | Whether to notify when dependent information is created. |
| `dependent_deleted` | boolean | Yes | Whether to notify when dependent information is deleted. |
| `dependent_updated` | boolean | Yes | Whether to notify when dependent information is updated. |
| `dependent_imported` | boolean | Yes | Whether to notify when dependent information is imported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Start Dependent Import Job

**Slug:** `SMARTHR_START_DEPENDENT_IMPORT_JOB`

Start 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Sensitive dependent-data file to import asynchronously. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Start Employee Export Job

**Slug:** `SMARTHR_START_EMPLOYEE_EXPORT_JOB`

Start 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `crew_export_format_id` | string | Yes | ID of an existing SmartHR custom employee download format to use for the export. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Start Employee Import Job

**Slug:** `SMARTHR_START_EMPLOYEE_IMPORT_JOB`

Start 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Sensitive employee data file to process asynchronously. |
| `mode` | string ("insert" | "update") | Yes | Whether the import inserts new employees or updates existing employees. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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

**Slug:** `SMARTHR_UPDATE_EMPLOYEE`

Update the supplied documented fields of one employee by SmartHR employee ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SmartHR employee ID of the employee to update. |
| `email` | string | No | Employee email. |
| `grade` | string | No | Employee grade. |
| `gender` | string ("male" | "female") | No | Employee gender. |
| `tax_cd` | string ("kou" | "otsu" | "hei" | "reward" | "non_resident" | "no_taxation_required") | No | Employee taxation category. |
| `address` | object | No | Employee address. |
| `resume1` | object | No | Employee resume1. |
| `resume2` | object | No | Employee resume2. |
| `user_id` | string | No | Employee user ID. |
| `birth_at` | string | No | Employee birth date. |
| `emp_code` | string | No | Employee employment code. |
| `emp_type` | string ("board_member" | "full_timer" | "contract_worker" | "permatemp" | "part_timer" | "outsourcing_contractor" | "etc") | No | Employee employment type. |
| `position` | string | No | Employee position. |
| `last_name` | string | No | Employee last name. |
| `positions` | array | No | Employee positions. |
| `department` | string | No | Employee department. |
| `emp_status` | string ("employed" | "absent" | "retired") | No | Employee employment status. |
| `entered_at` | string | No | Employee entered date. |
| `first_name` | string | No | Employee first name. |
| `occupation` | string | No | Employee occupation. |
| `tel_number` | string | No | Employee telephone number. |
| `widow_memo` | string | No | Employee widow memo. |
| `widow_type` | string ("widow" | "single_parent") | No | Employee widow type. |
| `enrolled_at` | string | No | Employee enrolled date. |
| `resigned_at` | string | No | Employee resigned date. |
| `school_name` | string | No | Employee school name. |
| `job_category` | string | No | Employee job category. |
| `address_image` | object | No | Employee address image. |
| `bank_accounts` | array | No | Employee bank accounts. |
| `contract_type` | string ("unlimited" | "fixed_term") | No | Employee contract type. |
| `custom_fields` | array | No | Employee custom fields. |
| `having_spouse` | boolean | No | Employee having spouse. |
| `profile_image` | object | No | Employee profile image. |
| `department_ids` | array | No | Employee department IDs. |
| `last_name_yomi` | string | No | Employee last name phonetic reading. |
| `last_workplace` | string | No | Employee last workplace. |
| `contract_end_on` | string | No | Employee contract end on. |
| `first_name_yomi` | string | No | Employee first name phonetic reading. |
| `first_workplace` | string | No | Employee first workplace. |
| `resident_end_at` | string | No | Employee resident end date. |
| `resigned_reason` | string | No | Employee resigned reason. |
| `handicapped_type` | string ("ordinary_handicapped" | "special_handicapped") | No | Employee handicapped type. |
| `nationality_code` | string | No | Employee nationality code. |
| `recruitment_type` | string | No | Employee recruitment type. |
| `contract_start_on` | string | No | Employee contract start on. |
| `emergency_address` | object | No | Employee emergency address. |
| `handicapped_image` | object | No | Employee handicapped image. |
| `payment_period_id` | string | No | Employee payment period ID. |
| `widow_reason_type` | string ("divorce" | "bereavement" | "missing" | "unmarried") | No | Employee widow reason type. |
| `business_last_name` | string | No | Employee business last name. |
| `employment_type_id` | string | No | Employee employment type ID. |
| `estate_income_flag` | boolean | No | Employee estate income flag. |
| `previous_workplace` | string | No | Employee previous workplace. |
| `student_card_image` | object | No | Employee student card image. |
| `business_first_name` | string | No | Employee business first name. |
| `emergency_last_name` | string | No | Employee emergency last name. |
| `monthly_base_salary` | integer | No | Employee monthly base salary. |
| `basic_pension_number` | string | No | Employee basic pension number. |
| `biz_establishment_id` | string | No | Employee business establishment ID. |
| `business_income_flag` | boolean | No | Employee business income flag. |
| `commutation_1_period` | string ("commutation_period_1_month" | "commutation_period_3_month" | "commutation_period_6_month") | No | Employee commutation 1 period. |
| `commutation_2_period` | string ("commutation_period_1_month" | "commutation_period_3_month" | "commutation_period_6_month") | No | Employee commutation 2 period. |
| `devidend_income_flag` | boolean | No | Whether the employee has dividend income. |
| `emergency_first_name` | string | No | Employee emergency first name. |
| `emergency_tel_number` | string | No | Employee emergency telephone number. |
| `emp_ins_qualified_at` | string | No | Employee employment insurance qualified date. |
| `identity_card_image1` | object | No | Employee identity card image1. |
| `identity_card_image2` | object | No | Employee identity card image2. |
| `monthly_income_goods` | integer | No | Employee monthly income goods. |
| `resident_status_type` | string | No | Employee resident status type. |
| `soc_ins_qualified_at` | string | No | Employee social insurance qualified date. |
| `spouse_yearly_income` | integer | No | Employee spouse yearly income. |
| `working_student_flag` | boolean | No | Employee working student flag. |
| `address_relation_name` | string | No | Employee address relation name. |
| `contract_renewal_type` | string ("renewal" | "none" | "auto_renewal") | No | Employee contract renewal type. |
| `handicapped_note_type` | string | No | Employee handicapped note type. |
| `resident_card_address` | object | No | Employee resident card address. |
| `address_head_of_family` | string | No | Employee address head of family. |
| `commutation_1_expenses` | integer | No | Employee commutation 1 expenses. |
| `commutation_2_expenses` | integer | No | Employee commutation 2 expenses. |
| `employment_income_flag` | boolean | No | Employee employment income flag. |
| `last_employment_end_on` | string | No | Employee last employment end on. |
| `other_be_workable_type` | string ("other_be_workable" | "others") | No | Dispatch or contract-work category. |
| `working_student_income` | integer | No | Employee working student income. |
| `business_last_name_yomi` | string | No | Employee business last name phonetic reading. |
| `child_care_contribution` | integer | No | Employee child care contribution. |
| `emergency_relation_name` | string | No | Employee emergency relation name. |
| `emp_ins_disqualified_at` | string | No | Employee employment insurance disqualified date. |
| `first_employment_end_on` | string | No | Employee first employment end on. |
| `monthly_income_currency` | integer | No | Employee monthly income currency. |
| `soc_ins_disqualified_at` | string | No | Employee social insurance disqualified date. |
| `business_first_name_yomi` | string | No | Employee business first name phonetic reading. |
| `emergency_last_name_yomi` | string | No | Employee emergency last name phonetic reading. |
| `last_employment_start_on` | string | No | Employee last employment start on. |
| `nearest_station_and_line` | string | No | Employee nearest station and line. |
| `commutation_1_single_fare` | integer | No | Employee commutation 1 single fare. |
| `commutation_2_single_fare` | integer | No | Employee commutation 2 single fare. |
| `emergency_first_name_yomi` | string | No | Employee emergency first name phonetic reading. |
| `first_employment_start_on` | string | No | Employee first employment start on. |
| `basic_pension_number_image` | object | No | Employee basic pension number image. |
| `foreign_resident_last_name` | string | No | Employee foreign resident last name. |
| `previous_employment_end_on` | string | No | Employee previous employment end on. |
| `foreign_resident_first_name` | string | No | Employee foreign resident first name. |
| `last_workplace_address_text` | string | No | Employee last workplace address text. |
| `monthly_standard_income_hel` | integer | No | Employee monthly standard income health. |
| `monthly_standard_income_pns` | integer | No | Employee monthly standard income pension. |
| `first_workplace_address_text` | string | No | Employee first workplace address text. |
| `foreign_resident_card_image1` | object | No | Employee foreign resident card image1. |
| `foreign_resident_card_image2` | object | No | Employee foreign resident card image2. |
| `foreign_resident_card_number` | string | No | Employee foreign resident card number. |
| `foreign_resident_middle_name` | string | No | Employee foreign resident middle name. |
| `handicapped_note_delivery_at` | string | No | Employee handicapped note delivery date. |
| `previous_employment_start_on` | string | No | Employee previous employment start on. |
| `resident_status_other_reason` | string | No | Employee resident status other reason. |
| `emp_ins_insured_person_number` | string | No | Employee employment insurance insured person number. |
| `having_ex_activity_permission` | string ("permitted" | "none") | No | Employee having ex activity permission. |
| `health_insurance_qualified_at` | string | No | Employee health insurance qualified date. |
| `hel_ins_insured_person_number` | integer | No | Employee health insurance insured person number. |
| `soc_ins_insured_person_number` | integer | No | Employee social insurance insured person number. |
| `care_insurance_premium_company` | integer | No | Employee care insurance premium company. |
| `child_care_support_fund_company` | integer | No | Employee child care support fund company. |
| `health_insurance_disqualified_at` | string | No | Employee health insurance disqualified date. |
| `health_insurance_premium_company` | integer | No | Employee health insurance premium company. |
| `care_insurance_premium_individual` | integer | No | Employee care insurance premium individual. |
| `child_care_support_fund_individual` | integer | No | Employee child care support fund individual. |
| `insurance_premium_calculation_type` | string ("rate" | "fixed") | No | Employee insurance premium calculation type. |
| `monthly_standard_income_updated_at` | string | No | Employee monthly standard income updated date. |
| `emp_ins_insured_person_number_image` | object | No | Employee employment insurance insured person number image. |
| `first_enrolling_in_emp_pns_ins_flag` | boolean | No | Employee first enrolling in employment pension insurance flag. |
| `health_insurance_premium_individual` | integer | No | Employee health insurance premium individual. |
| `resident_card_address_relation_name` | string | No | Employee resident card address relation name. |
| `resident_card_address_head_of_family` | string | No | Employee resident card address head of family. |
| `basic_pension_number_unknown_reason_type` | string ("non_pensionable" | "unknown") | No | Employee basic pension number unknown reason type. |
| `employees_pension_insurance_qualified_at` | string | No | Employee employees pension insurance qualified date. |
| `employees_pension_insurance_disqualified_at` | string | No | Employee employees pension insurance disqualified date. |
| `employees_pension_insurance_premium_company` | integer | No | Employee employees pension insurance premium company. |
| `employees_pension_insurance_premium_individual` | integer | No | Employee employees pension insurance premium individual. |
| `emp_ins_insured_person_number_unknown_reason_type` | string ("no_work_experience" | "never_joined" | "unknown") | No | Employee employment insurance insured person number unknown reason type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Custom Field Template Group

**Slug:** `SMARTHR_UPDATE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUP`

Update one or more supplied fields of an employee custom-field template group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee custom-field template group ID. |
| `name` | string | No | Employee custom-field template group name. |
| `position` | integer | No | Display position of the group. |
| `access_type` | string ("read_and_update" | "hidden" | "read_and_update_values" | "read_and_update_only_origin") | No | Access policy that controls whether and how employees can view or update values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Dependent

**Slug:** `SMARTHR_UPDATE_EMPLOYEE_DEPENDENT`

Update the supplied fields of one dependent belonging to an employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dependent id. |
| `job` | string | No | Dependent job. |
| `code` | string | No | Dependent code. |
| `gender` | string ("male" | "female") | No | Dependent gender. |
| `income` | integer | No | Dependent income. |
| `address` | object | No | Dependent address. |
| `birth_at` | string | No | Dependent birth date. |
| `moved_at` | string | No | Dependent moved date. |
| `is_spouse` | boolean | No | Dependent is spouse. |
| `last_name` | string | No | Dependent last name. |
| `first_name` | string | No | Dependent first name. |
| `tel_number` | string | No | Dependent telephone number. |
| `employee_id` | string | Yes | SmartHR employee ID. |
| `relation_id` | string | No | Dependent relation ID. |
| `custom_fields` | array | No | Dependent custom fields. |
| `kinship_image` | object | No | Dependent kinship image. |
| `last_name_yomi` | string | No | Dependent last name phonetic reading. |
| `monthly_income` | integer | No | Dependent monthly income. |
| `first_name_yomi` | string | No | Dependent first name phonetic reading. |
| `handicapped_type` | string ("ordinary_handicapped" | "special_handicapped" | "special_handicapped_living_together") | No | Dependent handicapped type. |
| `handicapped_image` | object | No | Dependent handicapped image. |
| `remittance_image1` | object | No | Dependent remittance image1. |
| `remittance_image2` | object | No | Dependent remittance image2. |
| `remittance_image3` | object | No | Dependent remittance image3. |
| `live_together_type` | string ("living_together" | "living_separately") | No | Dependent live together type. |
| `disqualified_reason` | string | No | Dependent disqualified reason. |
| `basic_pension_number` | string | No | Dependent basic pension number. |
| `soc_ins_qualified_at` | string | No | Dependent social insurance qualified date. |
| `tax_deduction_income` | integer | No | Dependent tax deduction income. |
| `tax_law_support_type` | string ("unsupported" | "unsupported_same_living_spouse" | "supported" | "special_spousal_exemption" | "unknown") | No | Dependent tax law support type. |
| `handicapped_note_type` | string | No | Dependent handicapped note type. |
| `international_student` | boolean | No | Dependent international student. |
| `remittance_to_relative` | integer | No | Dependent remittance to relative. |
| `soc_ins_disqualified_at` | string | No | Dependent social insurance disqualified date. |
| `disqualified_reason_type` | string ("death" | "divorce" | "employment" | "income_increase" | "aging_out_75" | "disability_certificate" | "others") | No | Dependent disqualified reason type. |
| `maternity_handbook_image` | object | No | Dependent maternity handbook image. |
| `soc_ins_qualified_reason` | string | No | Dependent social insurance qualified reason. |
| `basic_pension_number_image` | object | No | Dependent basic pension number image. |
| `tax_deduction_qualified_at` | string | No | Dependent tax deduction qualified date. |
| `international_student_image` | object | No | Dependent international student image. |
| `handicapped_note_delivery_at` | string | No | Dependent handicapped note delivery date. |
| `social_insurance_support_type` | string ("unsupported" | "supported" | "unknown") | No | Dependent social insurance support type. |
| `tax_deduction_disqualified_at` | string | No | Dependent tax deduction disqualified date. |
| `tax_deduction_qualified_reason` | string | No | Dependent tax deduction qualified reason. |
| `tax_deduction_disqualified_reason` | string | No | Dependent tax deduction disqualified reason. |
| `tax_deduction_disqualified_reason_type` | string ("death" | "divorce" | "employment" | "income_increase" | "others") | No | Dependent tax deduction disqualified reason type. |
| `spouse_dependent_disqualification_reason` | string | No | Dependent spouse dependent disqualification reason. |
| `spouse_dependent_disqualification_dead_at` | string | No | Dependent spouse dependent disqualification dead date. |
| `spouse_dependent_qualification_reason_type` | string ("joined_employee_ins" | "changed_soc_ins_to_mutual_aid" | "changed_mutual_aid_to_soc_ins" | "changed_mutual_aid_to_mutual_aid" | "marriage" | "retired" | "income_decrease" | "others") | No | Dependent spouse dependent qualification reason type. |
| `spouse_dependent_disqualification_reason_type` | string ("dead" | "others") | No | Dependent spouse dependent disqualification reason type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Grade

**Slug:** `SMARTHR_UPDATE_GRADE`

Update the supplied fields of a SmartHR grade by ID. 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Grade name. |
| `rank` | integer | No | Grade rank from 1 to 99999. |
| `grade_id` | string | Yes | ID of the SmartHR grade to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Job Category

**Slug:** `SMARTHR_UPDATE_JOB_CATEGORY`

Update the supplied fields of a SmartHR job category by ID. 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Job category name. |
| `job_category_id` | string | Yes | ID of the SmartHR job category to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Job Title

**Slug:** `SMARTHR_UPDATE_JOB_TITLE`

Update the supplied fields of a SmartHR job title by ID. 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Job title code. |
| `name` | string | No | Job title name. |
| `rank` | integer | No | Job title rank from 1 to 99999. |
| `job_title_id` | string | Yes | ID of the SmartHR job title to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Recruitment Type

**Slug:** `SMARTHR_UPDATE_RECRUITMENT_TYPE`

Update a SmartHR recruitment type by ID. 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Recruitment type name. |
| `recruitment_type_id` | string | Yes | ID of the SmartHR recruitment type to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Tax Withholding

**Slug:** `SMARTHR_UPDATE_TAX_WITHHOLDING`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Tax-withholding group name. |
| `year` | string ("H28" | "H29" | "H30" | "H31" | "R01" | "R02" | "R03" | "R04" | "R05" | "R06" | "R07" | "R08" | "R09") | No | Japanese era year printed on the tax-withholding slips. |
| `status` | string ("wip" | "fixed" | "importing") | No | Tax-withholding group status. |
| `tax_withholding_id` | string | Yes | ID of the sensitive SmartHR tax-withholding group to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Tax Withholding Slip

**Slug:** `SMARTHR_UPDATE_TAX_WITHHOLDING_SLIP`

Update a sensitive SmartHR tax-withholding slip. The full body is required: structured updates require the complete identity, payer, tax-year, and payment body, and sparse field updates are rejected by SmartHR. Confirmed slips cannot be updated, and switching between file-backed and field-backed data requires deleting and recreating the slip. The connected API access token must have the tax-withholding-slip resource Update permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | File for a file-backed tax-withholding slip. |
| `memo` | string | No | Slip notes. |
| `widow` | string | No | Widow-status string marker; SmartHR's Swagger does not enumerate accepted values. |
| `values` | array | No | SmartHR legacy ordered array. SmartHR does not document the item order; prefer the named fields. Use only when replaying a known provider-compatible payload. |
| `widower` | string | No | Widower-status string marker; SmartHR's Swagger does not enumerate accepted values. |
| `column_b` | string | No | Tax-table column B string marker; SmartHR's Swagger does not enumerate accepted values. |
| `underage` | string | No | Minor-status string marker; SmartHR's Swagger does not enumerate accepted values. |
| `foreigner` | string | No | Foreign-national string marker; SmartHR's Swagger does not enumerate accepted values. |
| `slip_type` | string | No | Tax-withholding slip type. SmartHR accepts '給与・賞与' for structured slips. |
| `employee_id` | string | Yes | ID of the employee associated with the slip. |
| `crew_birth_at` | string | No | Employee date of birth. |
| `crew_position` | string | No | Employee job title. |
| `single_parent` | string | No | Single-parent string marker; SmartHR's Swagger does not enumerate accepted values. |
| `special_widow` | string | No | Special-widow string marker; SmartHR's Swagger does not enumerate accepted values. |
| `crew_full_name` | string | No | Employee full name. |
| `payment_amount` | integer | No | Payment amount. |
| `disaster_victim` | string | No | Disaster-victim string marker; SmartHR's Swagger does not enumerate accepted values. |
| `owner_full_name` | string | No | Payer full name. |
| `working_student` | string | No | Working-student string marker; SmartHR's Swagger does not enumerate accepted values. |
| `mid_term_entered` | string | No | Mid-year employment-start string marker; SmartHR's Swagger does not enumerate accepted values. |
| `spouse_deduction` | string | No | String marker that a deductible spouse is present. SmartHR's Swagger does not enumerate accepted marker values. |
| `spouse_full_name` | string | No | Spouse full name. |
| `mid_term_resigned` | string | No | Mid-year resignation string marker; SmartHR's Swagger does not enumerate accepted values. |
| `other_handicapped` | string | No | Employee other-disability string marker; SmartHR's Swagger does not enumerate accepted values. |
| `resigned_by_death` | string | No | Death-related resignation string marker; SmartHR's Swagger does not enumerate accepted values. |
| `tax_withholding_id` | string | Yes | ID of the SmartHR tax-withholding group containing the slip. |
| `crew_full_name_yomi` | string | No | Employee full name in phonetic form. |
| `special_handicapped` | string | No | Employee special-disability string marker; SmartHR's Swagger does not enumerate accepted values. |
| `spouse_non_resident` | string | No | Deductible spouse non-resident category code. SmartHR's Swagger does not enumerate accepted code values. |
| `spouse_total_income` | integer | No | Spouse total income. |
| `crew_address_literal` | string | No | Employee address. |
| `spouse_deduction_sub` | string | No | String marker for the secondary deductible-spouse category. SmartHR's Swagger does not enumerate accepted marker values. |
| `dependent_1_full_name` | string | No | First dependent full name. |
| `other_dependent_count` | integer | No | Number of other dependents. |
| `spouse_full_name_yomi` | string | No | Spouse full name in phonetic form. |
| `basic_deduction_amount` | integer | No | Basic deduction amount. |
| `soc_ins_payment_amount` | integer | No | Social insurance payment amount. |
| `withholding_tax_amount` | integer | No | Withholding tax amount. |
| `elderly_dependent_count` | integer | No | Number of elderly dependents. |
| `tax_withholding_slip_id` | string | Yes | ID of the sensitive SmartHR tax-withholding slip to update. |
| `dependent_1_non_resident` | string ("0" | "1" | "00" | "01" | "02" | "03" | "04" | "10" | "11" | "20" | "21" | "30" | "31" | "40" | "41" | "50" | "51" | "60" | "61" | "70" | "71" | "80" | "81" | "90" | "91") | No | First dependent non-resident category. Use '0' or '1' for older tax-year formats; use one of 00, 01, 02, 03, 04, 10, 11, 20, 21, 30, 31, 40, 41, 50, 51, 60, 61, 70, 71, 80, 81, 90, or 91 for current tax-year formats. |
| `specific_dependent_count` | integer | No | Number of specific dependents. |
| `spouse_deduction_elderly` | string | No | String marker that the deductible spouse is elderly. SmartHR's Swagger does not enumerate accepted marker values. |
| `housing_loan_1_started_at` | string | No | First housing loan residence start date. |
| `housing_loan_2_started_at` | string | No | Second housing loan residence start date. |
| `life_ins_deduction_amount` | integer | No | Life insurance deduction amount. |
| `other_dependent_sub_count` | integer | No | Number of secondary other dependents. |
| `care_health_payment_amount` | integer | No | Nursing and medical insurance premium amount. |
| `dependent_1_full_name_yomi` | string | No | First dependent name in phonetic form. |
| `elderly_dependent_sub_count` | integer | No | Number of secondary elderly dependents. |
| `new_life_ins_payment_amount` | integer | No | New life insurance premium amount. |
| `non_resident_relative_count` | integer | No | Number of non-resident relatives. |
| `old_life_ins_payment_amount` | integer | No | Old life insurance premium amount. |
| `biz_establishment_tel_number` | string | No | Payer business establishment telephone number. |
| `housing_loan_deduction_count` | integer | No | Number of housing loan deductions. |
| `specific_dependent_sub_count` | integer | No | Number of secondary specific dependents. |
| `housing_loan_1_deduction_type` | string | No | First housing-loan special-deduction type code. SmartHR's provider docs do not enumerate code values. |
| `housing_loan_2_deduction_type` | string | No | Second housing-loan special-deduction type code. SmartHR's provider docs do not enumerate code values. |
| `housing_loan_deduction_amount` | integer | No | Housing loan deduction amount. |
| `under_16_years_dependent_count` | integer | No | Number of dependents under 16. |
| `earthquake_ins_deduction_amount` | integer | No | Earthquake insurance deduction amount. |
| `mid_term_entered_or_resigned_at` | string | No | Mid-year employment start or resignation date. |
| `national_pension_payment_amount` | integer | No | National pension insurance premium amount. |
| `spouse_special_deduction_amount` | integer | No | Special spouse deduction amount. |
| `biz_establishment_address_literal` | string | No | Payer business establishment address. |
| `other_handicapped_dependent_count` | integer | No | Number of other disabled dependents. |
| `specific_relative_dependent_count` | integer | No | Number of specific-relative dependents. |
| `income_adjustment_deduction_amount` | integer | No | Income adjustment deduction amount. |
| `special_handicapped_dependent_count` | integer | No | Number of special-disabled dependents. |
| `dependent_under_16_years_1_full_name` | string | No | First under-16 dependent full name. |
| `elderly_dependent_live_together_count` | integer | No | Number of elderly dependents living together. |
| `housing_loan_special_deduction_amount` | integer | No | Available housing loan special deduction amount. |
| `payment_after_income_deduction_amount` | integer | No | Payment after income deductions. |
| `specific_relative_dependent_sub_count` | integer | No | Number of secondary specific-relative dependents. |
| `dependent_under_16_years_1_non_resident` | string | No | First under-16 dependent non-resident category code. SmartHR's Swagger does not enumerate accepted code values. |
| `housing_loan_1_deduction_balance_amount` | integer | No | First housing loan year-end balance. |
| `housing_loan_2_deduction_balance_amount` | integer | No | Second housing loan year-end balance. |
| `new_personal_pension_ins_payment_amount` | integer | No | New personal pension insurance premium amount. |
| `old_personal_pension_ins_payment_amount` | integer | No | Old personal pension insurance premium amount. |
| `dependent_under_16_years_1_full_name_yomi` | string | No | First under-16 dependent name in phonetic form. |
| `old_long_term_property_ins_payment_amount` | integer | No | Old long-term casualty insurance premium amount. |
| `payment_after_emp_income_deduction_amount` | integer | No | Payment after employment income deductions. |
| `specific_relative_special_deduction_amount` | integer | No | Specific-relative special deduction amount. |
| `special_handicapped_dependent_live_together_count` | integer | No | Number of special-disabled dependents living together. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |