Skip to main content
SmartHR logo
  • Category: human resources
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 117
  • Triggers: 0
  • Slug: SMARTHR
  • Version: 20261101_00

Tools

Slug: SMARTHR_BULK_CREATE_PAYSLIPSCreate up to 100 sensitive payslip entries in one SmartHR payroll group. The connected API access token must have payroll Update permission and any applicable employee-field Update permissions.

Input Parameters

array
required
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.
string
required
Payroll group ID in which to create the sensitive payslips.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_DEPARTMENTCreate a SmartHR department. The connected API access token must have the department resource Update permission.

Input Parameters

string
Department code.
string
required
Department name. SmartHR does not allow forward slashes (/).
integer
Department position. SmartHR assigns one when omitted.
string
Parent department ID.
string
Company ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_EMPLOYEECreate an employee using the documented SmartHR employee fields. The connected API token must have employee resource and field Update permissions.

Input Parameters

string
Employee email.
string
Employee grade.
string ("male" | "female")
Employee gender.
string ("kou" | "otsu" | "hei" | "reward" | "non_resident" | "no_taxation_required")
Employee taxation category.
object
Employee address.
object
Employee resume1.
object
Employee resume2.
string
Employee user ID.
string
Employee birth date.
string
Employee employment code.
string ("board_member" | "full_timer" | "contract_worker" | "permatemp" | "part_timer" | "outsourcing_contractor" | "etc")
Employee employment type.
string
Employee position.
string
Employee last name.
array
Employee positions.
string
Employee department.
string ("employed" | "absent" | "retired")
Employee employment status.
string
Employee entered date.
string
Employee first name.
string
Employee occupation.
string
Employee telephone number.
string
Employee widow memo.
string ("widow" | "single_parent")
Employee widow type.
string
Employee enrolled date.
string
Employee resigned date.
string
Employee school name.
string
Employee job category.
object
Employee address image.
array
Employee bank accounts.
string ("unlimited" | "fixed_term")
Employee contract type.
array
Employee custom fields.
boolean
Employee having spouse.
object
Employee profile image.
array
Employee department IDs.
string
Employee last name phonetic reading.
string
Employee last workplace.
string
Employee contract end on.
string
Employee first name phonetic reading.
string
Employee first workplace.
string
Employee resident end date.
string
Employee resigned reason.
string ("ordinary_handicapped" | "special_handicapped")
Employee handicapped type.
string
Employee nationality code.
string
Employee recruitment type.
string
Employee contract start on.
object
Employee emergency address.
object
Employee handicapped image.
string
Employee payment period ID.
string ("divorce" | "bereavement" | "missing" | "unmarried")
Employee widow reason type.
string
Employee business last name.
string
Employee employment type ID.
boolean
Employee estate income flag.
string
Employee previous workplace.
object
Employee student card image.
string
Employee business first name.
string
Employee emergency last name.
integer
Employee monthly base salary.
string
Employee basic pension number.
string
Employee business establishment ID.
boolean
Employee business income flag.
string ("commutation_period_1_month" | "commutation_period_3_month" | "commutation_period_6_month")
Employee commutation 1 period.
string ("commutation_period_1_month" | "commutation_period_3_month" | "commutation_period_6_month")
Employee commutation 2 period.
boolean
Whether the employee has dividend income.
string
Employee emergency first name.
string
Employee emergency telephone number.
string
Employee employment insurance qualified date.
object
Employee identity card image1.
object
Employee identity card image2.
integer
Employee monthly income goods.
string
Employee resident status type.
string
Employee social insurance qualified date.
integer
Employee spouse yearly income.
boolean
Employee working student flag.
string
Employee address relation name.
string ("renewal" | "none" | "auto_renewal")
Employee contract renewal type.
string
Employee handicapped note type.
object
Employee resident card address.
string
Employee address head of family.
integer
Employee commutation 1 expenses.
integer
Employee commutation 2 expenses.
boolean
Employee employment income flag.
string
Employee last employment end on.
string ("other_be_workable" | "others")
Dispatch or contract-work category.
integer
Employee working student income.
string
Employee business last name phonetic reading.
integer
Employee child care contribution.
string
Employee emergency relation name.
string
Employee employment insurance disqualified date.
string
Employee first employment end on.
integer
Employee monthly income currency.
string
Employee social insurance disqualified date.
string
Employee business first name phonetic reading.
string
Employee emergency last name phonetic reading.
string
Employee last employment start on.
string
Employee nearest station and line.
integer
Employee commutation 1 single fare.
integer
Employee commutation 2 single fare.
string
Employee emergency first name phonetic reading.
string
Employee first employment start on.
object
Employee basic pension number image.
string
Employee foreign resident last name.
string
Employee previous employment end on.
string
Employee foreign resident first name.
string
Employee last workplace address text.
integer
Employee monthly standard income health.
integer
Employee monthly standard income pension.
string
Employee first workplace address text.
object
Employee foreign resident card image1.
object
Employee foreign resident card image2.
string
Employee foreign resident card number.
string
Employee foreign resident middle name.
string
Employee handicapped note delivery date.
string
Employee previous employment start on.
string
Employee resident status other reason.
string
Employee employment insurance insured person number.
string ("permitted" | "none")
Employee having ex activity permission.
string
Employee health insurance qualified date.
integer
Employee health insurance insured person number.
integer
Employee social insurance insured person number.
integer
Employee care insurance premium company.
integer
Employee child care support fund company.
string
Employee health insurance disqualified date.
integer
Employee health insurance premium company.
integer
Employee care insurance premium individual.
integer
Employee child care support fund individual.
string ("rate" | "fixed")
Employee insurance premium calculation type.
string
Employee monthly standard income updated date.
object
Employee employment insurance insured person number image.
boolean
Employee first enrolling in employment pension insurance flag.
integer
Employee health insurance premium individual.
string
Employee resident card address relation name.
string
Employee resident card address head of family.
string ("non_pensionable" | "unknown")
Employee basic pension number unknown reason type.
string
Employee employees pension insurance qualified date.
string
Employee employees pension insurance disqualified date.
integer
Employee employees pension insurance premium company.
integer
Employee employees pension insurance premium individual.
string ("no_work_experience" | "never_joined" | "unknown")
Employee employment insurance insured person number unknown reason type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_EMPLOYEE_CUSTOM_FIELD_TEMPLATECreate an employee custom-field template. The connected API token must have the custom employee field resource Update permission.

Input Parameters

string
Input hint.
string
required
Custom employee field name.
string ("date" | "decimal" | "enum" | "file" | "string" | "text")
required
Input type.
integer
Decimal precision.
array
Dropdown elements. Only applicable when type is ‘enum’.
string
required
ID of the custom employee field group.
integer
required
Custom employee field position.
boolean
Whether numbers display with thousands separators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUPCreate an employee custom-field template group.

Input Parameters

string
required
Custom employee field group name.
integer
Group position.
string ("read_and_update" | "hidden" | "read_and_update_values" | "read_and_update_only_origin")
Access type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_EMPLOYEE_DEPENDENTCreate a dependent for one employee using the documented family fields. The connected API token must have the required family and employee-field Update permissions.

Input Parameters

string
Dependent job.
string
Dependent code.
string ("male" | "female")
required
Dependent gender.
integer
Dependent income.
object
Dependent address.
string
required
Dependent birth date.
string
Dependent moved date.
boolean
Dependent is spouse.
string
required
Dependent last name.
string
required
Dependent first name.
string
Dependent telephone number.
string
required
SmartHR employee ID.
string
required
Dependent relation ID.
array
Dependent custom fields.
object
Dependent kinship image.
string
Dependent last name phonetic reading.
integer
Dependent monthly income.
string
Dependent first name phonetic reading.
string ("ordinary_handicapped" | "special_handicapped" | "special_handicapped_living_together")
Dependent handicapped type.
object
Dependent handicapped image.
object
Dependent remittance image1.
object
Dependent remittance image2.
object
Dependent remittance image3.
string ("living_together" | "living_separately")
required
Dependent live together type.
string
Dependent disqualified reason.
string
Dependent basic pension number.
string
Dependent social insurance qualified date.
integer
Dependent tax deduction income.
string ("unsupported" | "unsupported_same_living_spouse" | "supported" | "special_spousal_exemption" | "unknown")
Dependent tax law support type.
string
Dependent handicapped note type.
boolean
Dependent international student.
integer
Dependent remittance to relative.
string
Dependent social insurance disqualified date.
string ("death" | "divorce" | "employment" | "income_increase" | "aging_out_75" | "disability_certificate" | "others")
Dependent disqualified reason type.
object
Dependent maternity handbook image.
string
Dependent social insurance qualified reason.
object
Dependent basic pension number image.
string
Dependent tax deduction qualified date.
object
Dependent international student image.
string
Dependent handicapped note delivery date.
string ("unsupported" | "supported" | "unknown")
Dependent social insurance support type.
string
Dependent tax deduction disqualified date.
string
Dependent tax deduction qualified reason.
string
Dependent tax deduction disqualified reason.
string ("death" | "divorce" | "employment" | "income_increase" | "others")
Dependent tax deduction disqualified reason type.
string
Dependent spouse dependent disqualification reason.
string
Dependent spouse dependent disqualification dead date.
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")
Dependent spouse dependent qualification reason type.
string ("dead" | "others")
Dependent spouse dependent disqualification reason type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_EMPLOYMENT_TYPECreate a SmartHR employment type. The connected API access token must have the employment type resource Update permission.

Input Parameters

string
Employment type code.
string
required
Employment type name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_GRADECreate a SmartHR grade. The connected API access token must have the grade resource Update permission.

Input Parameters

string
Grade name.
integer
Grade rank from 1 to 99999.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_JOB_CATEGORYCreate a SmartHR job category. The connected API access token must have the job category resource Update permission.

Input Parameters

string
Job category name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_JOB_TITLECreate a SmartHR job title. The connected API access token must have the job title resource Update permission.

Input Parameters

string
Job title code.
string
Job title name.
integer
Job title rank from 1 to 99999.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_PAYROLLCreate a sensitive SmartHR payroll group. The connected API access token must have payroll Update permission.

Input Parameters

string
required
Payment date.
string ("salary" | "bonus")
required
Payment type.
string
required
Payroll group name shown to employees.
string
required
End date of the payroll period.
string
required
Payroll group name shown to administrators.
string
required
Start date of the payroll period.
string ("as_is" | "force_sexagesimal" | "force_decimal")
required
Numeral-system handling mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_PAYSLIPCreate 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

string
Optional payslip notes.
array
required
Payslip item names and their string-form values.
string
Optional company ID associated with the payslip.
string
required
Payroll group ID in which to create the sensitive payslip.
string
required
Employee ID for the payslip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_RECRUITMENT_TYPECreate a SmartHR recruitment type. The connected API access token must have the recruitment type resource Update permission.

Input Parameters

string
required
Recruitment type name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_TAX_WITHHOLDINGCreate a sensitive SmartHR tax-withholding group in the unconfirmed state. The connected API access token must have tax-withholding-group Update permission.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_TAX_WITHHOLDING_SLIPCreate a file-backed or field-backed sensitive tax-withholding slip for an employee in one SmartHR tax-withholding group. The connected API access token must have the tax-withholding-slip resource and applicable employee-field Update permissions.

Input Parameters

object
File for a file-backed tax-withholding slip.
string
Slip notes.
string
Widow-status string marker; SmartHR’s Swagger does not enumerate accepted values.
array
SmartHR legacy ordered array. SmartHR does not document the item order; prefer the named fields. Use only when replaying a known provider-compatible payload.
string
Widower-status string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Tax-table column B string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Minor-status string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Foreign-national string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Tax-withholding slip type. SmartHR accepts ‘給与・賞与’ for structured slips.
string
Company ID to associate with the tax-withholding slip.
string
required
Employee ID for the tax-withholding slip.
string
Employee date of birth.
string
Employee job title.
string
Single-parent string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Special-widow string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Employee full name.
integer
Payment amount.
string
Disaster-victim string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Payer full name.
string
Working-student string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Mid-year employment-start string marker; SmartHR’s Swagger does not enumerate accepted values.
string
String marker that a deductible spouse is present. SmartHR’s Swagger does not enumerate accepted marker values.
string
Spouse full name.
string
Mid-year resignation string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Employee other-disability string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Death-related resignation string marker; SmartHR’s Swagger does not enumerate accepted values.
string
required
Tax-withholding group ID in which to create the sensitive slip.
string
Employee full name in phonetic form.
string
Employee special-disability string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Deductible spouse non-resident category code. SmartHR’s Swagger does not enumerate accepted code values.
integer
Spouse total income.
string
Employee address.
string
String marker for the secondary deductible-spouse category. SmartHR’s Swagger does not enumerate accepted marker values.
string
First dependent full name.
integer
Number of other dependents.
string
Spouse full name in phonetic form.
integer
Basic deduction amount.
integer
Social insurance payment amount.
integer
Withholding tax amount.
integer
Number of elderly dependents.
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")
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.
integer
Number of specific dependents.
string
String marker that the deductible spouse is elderly. SmartHR’s Swagger does not enumerate accepted marker values.
string
First housing loan residence start date.
string
Second housing loan residence start date.
integer
Life insurance deduction amount.
integer
Number of secondary other dependents.
integer
Nursing and medical insurance premium amount.
string
First dependent name in phonetic form.
integer
Number of secondary elderly dependents.
integer
New life insurance premium amount.
integer
Number of non-resident relatives.
integer
Old life insurance premium amount.
string
Payer business establishment telephone number.
integer
Number of housing loan deductions.
integer
Number of secondary specific dependents.
string
First housing-loan special-deduction type code. SmartHR’s provider docs do not enumerate code values.
string
Second housing-loan special-deduction type code. SmartHR’s provider docs do not enumerate code values.
integer
Housing loan deduction amount.
integer
Number of dependents under 16.
integer
Earthquake insurance deduction amount.
string
Mid-year employment start or resignation date.
integer
National pension insurance premium amount.
integer
Special spouse deduction amount.
string
Payer business establishment address.
integer
Number of other disabled dependents.
integer
Number of specific-relative dependents.
integer
Income adjustment deduction amount.
integer
Number of special-disabled dependents.
string
First under-16 dependent full name.
integer
Number of elderly dependents living together.
integer
Available housing loan special deduction amount.
integer
Payment after income deductions.
integer
Number of secondary specific-relative dependents.
string
First under-16 dependent non-resident category code. SmartHR’s Swagger does not enumerate accepted code values.
integer
First housing loan year-end balance.
integer
Second housing loan year-end balance.
integer
New personal pension insurance premium amount.
integer
Old personal pension insurance premium amount.
string
First under-16 dependent name in phonetic form.
integer
Old long-term casualty insurance premium amount.
integer
Payment after employment income deductions.
integer
Specific-relative special deduction amount.
integer
Number of special-disabled dependents living together.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_USER_SAML_CONFIGURATIONCreate 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

string
required
SmartHR user ID whose SAML configuration to create.
string
required
User identifier for the linked identity provider account.
boolean
required
Whether to enable the SAML account when it is created.
string
required
SmartHR user ID to associate with the SAML account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_CREATE_WEBHOOKCreate a SmartHR webhook configuration for future employee and dependent events. Matching events can send data to the configured destination, so confirm the URL, event selections, payload exposure, and secret token before calling. The connected API access token must have the webhook resource Update permission.

Input Parameters

string
Webhook notification destination URL.
string ("read_and_update" | "hidden" | "read_and_update_only_origin")
Webhook access type.
string
Webhook description.
string
Date on which to disable the webhook.
boolean
required
Whether to notify when an employee record is created.
boolean
required
Whether to notify when an employee record is deleted.
boolean
required
Whether to notify when an employee record is updated.
string
Secret token SmartHR includes with webhook deliveries.
boolean
required
Whether to notify when employee records are imported.
boolean
Whether webhook deliveries should contain only the changed record ID.
boolean
required
Whether to notify when a dependent record is created.
boolean
required
Whether to notify when a dependent record is deleted.
boolean
required
Whether to notify when a dependent record is updated.
boolean
required
Whether to notify when dependent records are imported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_DEPARTMENTDeprecated: delete a SmartHR department by ID. Prefer SMARTHR_DISCONTINUE_DEPARTMENT because SmartHR no longer recommends department deletion. Deletion requires the department resource Update permission and fails when the department or a child department has a scheduled employee update whose effective date has not arrived.

Input Parameters

string
required
SmartHR department ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_EMPLOYEEPermanently delete one employee by SmartHR employee ID. This requires the employee resource Update permission on the connected access token.

Input Parameters

string
required
SmartHR employee ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_EMPLOYEE_CUSTOM_FIELD_TEMPLATEDelete 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

string
required
Custom employee field template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUPDelete one employee custom-field template group by ID. This also permanently deletes every custom-field template in the group and all values set for those templates. SmartHR rejects deletion when a group field has a scheduled employee update whose effective date has not arrived.

Input Parameters

string
required
Custom employee field group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_EMPLOYEE_DEPENDENTPermanently delete one dependent and their sensitive family data from an employee record. This cannot be undone.

Input Parameters

string
required
SmartHR employee ID.
string
required
SmartHR dependent ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_EMPLOYMENT_TYPEDelete one SmartHR employment type by ID. SmartHR does not allow deletion of a system-standard employment type or one referenced by a scheduled employee update whose effective date has not arrived. The connected API access token must have the employment type resource Update permission.

Input Parameters

string
required
SmartHR employment type ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_GRADEDelete 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

string
required
SmartHR grade ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_JOB_CATEGORYDelete 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

string
required
SmartHR job category ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_JOB_TITLEDelete 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

string
required
SmartHR job title ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_PAYROLLPermanently delete one sensitive SmartHR payroll group by ID. The connected API access token must have the payroll resource Update permission.

Input Parameters

string
required
SmartHR payroll group ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_PAYSLIPPermanently 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

string
required
SmartHR payroll group ID containing the payslip.
string
required
SmartHR payslip ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_RECRUITMENT_TYPEDelete one SmartHR recruitment type by ID. A recruitment type referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the recruitment type resource Update permission.

Input Parameters

string
required
SmartHR recruitment type ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_TAX_WITHHOLDINGPermanently 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

string
required
SmartHR tax-withholding group ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_TAX_WITHHOLDING_SLIPPermanently delete one sensitive SmartHR tax-withholding slip from its tax-withholding group. The connected API access token must have the tax-withholding-slip resource Update permission, and employee fields may also require Update permission.

Input Parameters

string
required
SmartHR tax-withholding group ID containing the slip.
string
required
SmartHR tax-withholding slip ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_USER_SAML_CONFIGURATIONDelete 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

string
required
SmartHR user ID whose SAML configuration to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DELETE_WEBHOOKPermanently delete one SmartHR webhook configuration by ID. The connected API access token must have the webhook resource Update permission.

Input Parameters

string
required
SmartHR webhook ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DISABLE_USER_SAML_CONFIGURATIONDisable 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

string
required
SmartHR user ID whose SAML configuration to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DISCONTINUE_DEPARTMENTIrreversibly discontinue one SmartHR department as of its final active date. The date must be in the past. SmartHR rejects discontinuation when a scheduled employee update references this department or a descendant; the connected access token must have department Update permission.

Input Parameters

string
required
SmartHR department ID to discontinue.
string
required
The department’s final active date in YYYY-MM-DD format. SmartHR accepts only a date in the past.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_DOWNLOAD_BATCH_JOB_ATTACHMENTDownload a SmartHR batch-job attachment as an offloaded file reference, with a maximum download size of 100,000,000 bytes. SmartHR deletes the provider attachment five minutes after it is retrieved, so use the returned reference for subsequent work.

Input Parameters

string
required
Batch-job attachment ID returned by a SmartHR batch job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_ENABLE_USER_SAML_CONFIGURATIONEnable 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

string
required
SmartHR user ID whose SAML configuration to enable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_FINALIZE_PAYROLLFinalize one sensitive SmartHR payroll group. The connected API access token must have the payroll-group resource Update permission.

Input Parameters

string
required
SmartHR payroll group ID to finalize.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_BATCH_JOBGet one SmartHR background batch job by ID, optionally embedding its attachments. The access token needs the corresponding resource Reference permission.

Input Parameters

string
Set to ‘attachments’ to include batch job attachments in the response.
string
required
SmartHR background batch job ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_DEPARTMENTGet one SmartHR department by its department ID.

Input Parameters

string
required
SmartHR department ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_EMPLOYEEGet 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

string
Comma-separated names of employee fields to return.
string
required
SmartHR employee ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_EMPLOYEE_CUSTOM_FIELD_TEMPLATEGet one employee custom-field template by ID. Set embed to group to include the custom field group that contains the template.

Input Parameters

string
Set to ‘group’ to include the template’s custom field group.
string
required
Custom employee field template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUPGet one employee custom-field template group by ID. Set embed to templates to include the custom field templates belonging to the group.

Input Parameters

string
Set to ‘templates’ to include the custom field templates in the group.
string
required
Custom employee field group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_EMPLOYEE_DEPENDENTGet one dependent belonging to an employee.

Input Parameters

string
required
SmartHR employee ID.
string
required
SmartHR dependent ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_EMPLOYEE_INPUT_FORMGet one SmartHR employee information-collection form by ID, preserving its nested field groups, fields, and embedded custom-field definitions.

Input Parameters

string
Set to ‘mail_format’ to embed the mail format linked to the form.
string
required
Employee information-collection form ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_EMPLOYMENT_TYPEGet one SmartHR employment type by its employment type ID.

Input Parameters

string
required
SmartHR employment type ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_GRADEGet one SmartHR grade by its grade ID.

Input Parameters

string
required
SmartHR grade ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_JOB_CATEGORYGet one SmartHR job category by its job category ID.

Input Parameters

string
required
SmartHR job category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_JOB_TITLEGet one SmartHR job title by its job title ID.

Input Parameters

string
required
SmartHR job title ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_MAIL_FORMATGet one SmartHR mail format by ID, optionally embedding the employee information-collection forms that use it.

Input Parameters

string
Set to ‘crew_input_forms’ to embed forms that use this mail format.
string
required
SmartHR mail format ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_PAYMENT_PERIODGet one SmartHR payroll payment period by its payment period ID.

Input Parameters

string
required
SmartHR payment period ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_PAYROLLGet one sensitive SmartHR payroll group by ID. The access token needs payroll Reference permission, and returned data may contain sensitive financial information.

Input Parameters

string
required
SmartHR payroll group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_PAYSLIPGet 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

string
Set to company to embed the payslip’s company details.
string
required
SmartHR payroll group ID containing the payslip.
string
required
SmartHR payslip ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_RECRUITMENT_TYPEGet one SmartHR recruitment type by its recruitment type ID.

Input Parameters

string
required
SmartHR recruitment type ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_TAX_WITHHOLDINGGet one highly sensitive SmartHR tax-withholding group by ID. The access token needs tax-withholding-group Reference permission.

Input Parameters

string
required
SmartHR tax-withholding group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_TAX_WITHHOLDING_SLIPGet 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

string
Set to company to embed the slip’s full company details.
string
required
SmartHR tax-withholding slip ID.
string
required
SmartHR tax-withholding group ID containing the slip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_USERGet one SmartHR user account by user ID with an optional related object embedded in the response.

Input Parameters

string
required
SmartHR user ID.
string ("crew" | "biz_establishment" | "biz_establishment_company" | "department_company")
Related object to embed in the user response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_USER_SAML_CONFIGURATIONGet the SAML SSO account configuration for one SmartHR user. This endpoint requires the tenant’s SAML/SSO option to be enabled.

Input Parameters

string
required
SmartHR user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_GET_WEBHOOKGet one SmartHR webhook configuration by webhook ID.

Input Parameters

string
required
SmartHR webhook ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_INVITE_EMPLOYEESend 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

string
required
SmartHR employee ID to invite.
string
required
SmartHR user ID of the administrator sending the invitation.
string
Employee information collection form ID to use for the invitation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_BANK_ACCOUNT_SETTINGSList one page of SmartHR bank-account setting definitions. This does not return employee bank-account values.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_BATCH_JOBSList one page of SmartHR background batch jobs. Optionally embed attachment metadata for each job.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_BUSINESS_ESTABLISHMENTSList one page of SmartHR business establishments, optionally embedding the social insurance representative, labor insurance representative, or company.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_COMPANIESList one page of SmartHR companies with an optional embedded owner.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_DEPARTMENTSList one page of SmartHR departments using the documented code and sort filters. Returns hierarchy and company details when present.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_DEPENDENT_CUSTOM_FIELD_TEMPLATESList one page of SmartHR custom-field templates for employee dependents.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_DEPENDENT_RELATIONSList one page of configured SmartHR dependent relationship types.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUPSList one page of employee custom-field template groups. Set embed to templates to include the custom fields belonging to each group.

Input Parameters

integer
Page of custom-field template groups to fetch. Ignored when cursor is supplied.
string
Set to ‘templates’ to include each group’s custom-field templates.
string
Continuation cursor returned by a previous call. Omit for the first page.
integer
Number of custom-field template groups to return per page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_EMPLOYEE_CUSTOM_FIELD_TEMPLATESList one page of SmartHR employee custom-field templates. Set embed to group to include each template’s custom-field group.

Input Parameters

integer
Page of custom field templates to fetch. Ignored when cursor is supplied.
string
Set to ‘group’ to embed each template’s custom field group.
string
Continuation cursor returned by a previous call. Omit for the first page.
integer
Number of custom field templates to return per page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_EMPLOYEE_DEPENDENTSList 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

integer
Page of dependents to fetch. Ignored when cursor is supplied.
string
Continuation cursor returned by a previous call. Omit for the first page.
integer
Number of dependents to return per page (1-100).
string
required
SmartHR employee ID whose dependents to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_EMPLOYEE_INPUT_FORMSList 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

integer
Page of employee input forms to fetch. Ignored when cursor is supplied.
string
Set to ‘mail_format’ to embed the mail format linked to each form.
string
Continuation cursor returned by a previous call. Omit for the first page.
integer
Number of employee input forms to return per page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_EMPLOYEE_MATERNITY_CHILDCARE_LEAVESList one page of sensitive maternity and childcare leave records for a SmartHR employee. The access token needs leave-record Reference permission.

Input Parameters

integer
Page of leave records to fetch. Ignored when cursor is supplied.
string
Continuation cursor returned by a previous call. Omit for the first page.
integer
Number of leave records to return per page (1-100).
string
required
SmartHR employee ID whose maternity and childcare leave records to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_EMPLOYEESList one page of employees matching SmartHR’s documented employee filters. Employee records contain sensitive HR data; use fields to request only the attributes needed.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_EMPLOYMENT_TYPESList one page of SmartHR employment types.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_GRADESList one page of SmartHR grades.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_JOB_CATEGORIESList one page of SmartHR job categories.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_JOB_TITLESList one page of SmartHR job titles using the documented sort option.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_MAIL_FORMATSList one page of SmartHR mail formats. Set embed to crew_input_forms to include the employee input forms linked to each format.

Input Parameters

integer
Page of mail formats to fetch. Ignored when cursor is supplied.
string
Set to ‘crew_input_forms’ to embed linked employee input forms.
string
Continuation cursor returned by a previous call. Omit for the first page.
integer
Number of mail formats to return per page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_PAYMENT_PERIODSList one page of SmartHR payroll payment periods.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_PAYROLLSList one page of sensitive SmartHR payroll groups using payment-date and payment-type filters. The access token needs payroll Reference permission.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_PAYSLIPSList 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_RECRUITMENT_TYPESList one page of SmartHR recruitment types.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_TAX_WITHHOLDINGSList one page of sensitive SmartHR tax-withholding groups. The access token needs tax-withholding-group Reference permission.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_TAX_WITHHOLDING_SLIPSList 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_USERSList one page of SmartHR user accounts with the documented sort and embed options, invitation status, role, and email-delivery status.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_LIST_WEBHOOKSList one page of SmartHR webhook configurations.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_PARTIALLY_UPDATE_DEPARTMENTPartially update a SmartHR department by ID. The connected API access token must have the department resource Update permission.

Input Parameters

string
Department code.
string
required
Department name. SmartHR does not allow forward slashes (/).
integer
Department position.
string
Parent department ID.
string
Company ID.
string
required
SmartHR department ID of the department to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_PARTIALLY_UPDATE_EMPLOYEE_CUSTOM_FIELD_TEMPLATEPartially 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

string
Input hint.
string
Custom employee field name.
string ("date" | "decimal" | "enum" | "file" | "string" | "text")
Input type.
integer
Decimal precision.
array
Dropdown elements. Only applicable when type is ‘enum’.
string
ID of the custom employee field group.
integer
Custom employee field position.
string
required
Custom employee field template ID.
boolean
Whether numbers display with thousands separators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_PARTIALLY_UPDATE_EMPLOYMENT_TYPEPartially update a SmartHR employment type by ID. SmartHR does not allow renaming a system preset employment type or updating an employment type used by a pending future-dated employee update. The connected API access token must have the employment type resource Update permission.

Input Parameters

string
Employment type code.
string
required
Employment type name.
string
required
SmartHR employment type ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_PARTIALLY_UPDATE_PAYROLLPartially 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

string
required
ID of the sensitive SmartHR payroll group to update.
string
required
Payroll group name shown to employees.
string
required
Payroll group name shown to SmartHR administrators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_PARTIALLY_UPDATE_USER_SAML_CONFIGURATIONPartially 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

string
required
SmartHR user ID whose SAML configuration to update.
string
required
User identifier for the linked identity provider account.
boolean
required
Whether the user’s SAML account is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_PARTIALLY_UPDATE_WEBHOOKPartially update a SmartHR webhook by ID. Changing its destination or event selections can redirect future employee and dependent data externally, so confirm them before calling. The connected API access token must have the webhook resource Update permission.

Input Parameters

string
Webhook notification destination URL.
string
required
SmartHR webhook ID.
string ("read_and_update" | "hidden" | "read_and_update_only_origin")
Webhook access type.
string
Webhook description.
string
Date on which the webhook is disabled.
boolean
Whether to notify when employee information is created.
boolean
Whether to notify when employee information is deleted.
boolean
Whether to notify when employee information is updated.
string
Secret token included with webhook notifications.
boolean
Whether to notify when employee information is imported.
boolean
Whether webhook notifications contain only the changed record ID.
boolean
Whether to notify when dependent information is created.
boolean
Whether to notify when dependent information is deleted.
boolean
Whether to notify when dependent information is updated.
boolean
Whether to notify when dependent information is imported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_PUBLISH_PAYROLLIrreversibly publish one sensitive SmartHR payroll group immediately or at a scheduled time within one month, optionally notifying employees. The connected API access token must have payroll Update permission.

Input Parameters

string
required
SmartHR payroll group ID to publish.
string
Optional scheduled publication time. It cannot be in the past and must be within one month; omit it to publish immediately.
boolean
Whether SmartHR should notify employees when publishing. Omit it to publish without notification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_REMOVE_EMPLOYEE_DEPARTMENTSRemove 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

string
required
SmartHR employee ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_REOPEN_PAYROLLReopen 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

string
required
SmartHR payroll group ID to reopen.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_REPLACE_DEPARTMENTReplace 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

string
Department code. Omitting it deletes the current value.
string
required
Department name. SmartHR does not allow forward slashes (/).
integer
required
Department position. SmartHR requires this field for PUT updates.
string
Parent department ID. Omitting it deletes the current value.
string
Company ID. Omitting it deletes the current value.
string
required
ID of the SmartHR department to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_REPLACE_EMPLOYEE_CUSTOM_FIELD_TEMPLATEReplace an employee custom-field template through the documented PUT operation. Omitted optional attributes are deleted; use the PATCH action to preserve attributes that are not being changed. Existing dropdown elements omitted from elements are also deleted.

Input Parameters

string
required
Custom employee field template ID.
string
Input hint.
string
required
Custom employee field name.
string ("date" | "decimal" | "enum" | "file" | "string" | "text")
required
Input type.
integer
Decimal precision.
array
Dropdown elements. Only applicable when type is ‘enum’.
string
required
ID of the custom employee field group.
integer
required
Custom employee field position.
boolean
Whether numbers display with thousands separators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_REPLACE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUPReplace an employee custom-field template group through the documented PUT operation. Omitted optional attributes are deleted; use the PATCH action to preserve attributes that are not being changed.

Input Parameters

string
required
Employee custom-field template group ID.
string
required
Employee custom-field template group name.
integer
Display position of the group.
string ("read_and_update" | "hidden" | "read_and_update_values" | "read_and_update_only_origin")
Access policy that controls whether and how employees can view or update values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_REPLACE_EMPLOYMENT_TYPEReplace a SmartHR employment type through PUT. Attributes omitted from the PUT contract are deleted; use the partial-update action to preserve them. System-standard employment types and employment types used by pending employee updates cannot be changed.

Input Parameters

string
required
Employment type ID.
string
required
Employment type name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_REPLACE_GRADEReplace a SmartHR grade by ID using full PUT semantics. The PUT contract allows name and rank to be omitted. Grades used by pending future-dated employee updates cannot be changed. The connected API access token must have the grade resource Update permission.

Input Parameters

string
Grade name.
integer
Grade rank from 1 to 99999.
string
required
ID of the SmartHR grade to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_REPLACE_JOB_CATEGORYReplace a SmartHR job category by ID using full PUT semantics. The PUT contract allows name to be omitted. Job categories used by pending future-dated employee updates cannot be changed. The connected API access token must have the job category resource Update permission.

Input Parameters

string
Job category name.
string
required
ID of the SmartHR job category to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_REPLACE_JOB_TITLEReplace a SmartHR job title by ID using full PUT semantics. The PUT contract allows name and rank to be omitted. Job titles used by pending future-dated employee updates cannot be changed. The connected API access token must have the job title resource Update permission.

Input Parameters

string
Job title name.
integer
Job title rank from 1 to 99999.
string
required
ID of the SmartHR job title to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_REPLACE_RECRUITMENT_TYPEReplace a SmartHR recruitment type by ID using full PUT semantics. Name is required for the complete replacement. Recruitment types used by pending future-dated employee updates cannot be changed. The connected API access token must have the recruitment type resource Update permission.

Input Parameters

string
required
Recruitment type name.
string
required
ID of the SmartHR recruitment type to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_REPLACE_TAX_WITHHOLDINGReplace a sensitive SmartHR tax-withholding group by ID using full PUT semantics. Name, status, and year are all required for the complete replacement. Finalized tax withholdings cannot be updated. The connected API access token must have the tax-withholding-group resource Update permission.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_REPLACE_WEBHOOKReplace a SmartHR webhook through PUT. Omitted optional attributes are deleted; use the partial-update action to preserve attributes that are not being changed. Changing its destination or event selections can redirect future employee and dependent data externally, so confirm them before calling.

Input Parameters

string
required
Webhook ID.
string
required
Webhook destination URL.
string ("read_and_update" | "hidden" | "read_and_update_only_origin")
Webhook access type.
string
Webhook description.
string
Date when the webhook is disabled.
boolean
required
Whether to notify when employee information is created.
boolean
required
Whether to notify when employee information is deleted.
boolean
required
Whether to notify when employee information is updated.
string
Secret token attached to outbound webhook deliveries.
boolean
required
Whether to notify when employee information is imported.
boolean
Whether webhook deliveries include only changed data IDs.
boolean
required
Whether to notify when dependent information is created.
boolean
required
Whether to notify when dependent information is deleted.
boolean
required
Whether to notify when dependent information is updated.
boolean
required
Whether to notify when dependent information is imported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_START_DEPENDENT_IMPORT_JOBStart an asynchronous SmartHR dependent-data import from a Base64-encoded CSV or Excel file. This creates a background job that processes sensitive family HR data; the connected API access token must have the corresponding resource and employee-field Update permissions.

Input Parameters

object
required
Sensitive dependent-data file to import asynchronously.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_START_EMPLOYEE_EXPORT_JOBStart a SmartHR background job that exports employee information using an existing custom download format. A successful 201 response only confirms that the asynchronous job was registered; use the batch-job actions to monitor it and retrieve any resulting attachment. The connected access token must have the required resource and employee-field Update permissions.

Input Parameters

string
required
ID of an existing SmartHR custom employee download format to use for the export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_START_EMPLOYEE_IMPORT_JOBStart a SmartHR background job that inserts or updates employees from a sensitive base64-encoded CSV or Excel file. The connected API access token must have the required resource and employee-field Update permissions.

Input Parameters

object
required
Sensitive employee data file to process asynchronously.
string ("insert" | "update")
required
Whether the import inserts new employees or updates existing employees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_UPDATE_EMPLOYEEUpdate the supplied documented fields of one employee by SmartHR employee ID.

Input Parameters

string
required
SmartHR employee ID of the employee to update.
string
Employee email.
string
Employee grade.
string ("male" | "female")
Employee gender.
string ("kou" | "otsu" | "hei" | "reward" | "non_resident" | "no_taxation_required")
Employee taxation category.
object
Employee address.
object
Employee resume1.
object
Employee resume2.
string
Employee user ID.
string
Employee birth date.
string
Employee employment code.
string ("board_member" | "full_timer" | "contract_worker" | "permatemp" | "part_timer" | "outsourcing_contractor" | "etc")
Employee employment type.
string
Employee position.
string
Employee last name.
array
Employee positions.
string
Employee department.
string ("employed" | "absent" | "retired")
Employee employment status.
string
Employee entered date.
string
Employee first name.
string
Employee occupation.
string
Employee telephone number.
string
Employee widow memo.
string ("widow" | "single_parent")
Employee widow type.
string
Employee enrolled date.
string
Employee resigned date.
string
Employee school name.
string
Employee job category.
object
Employee address image.
array
Employee bank accounts.
string ("unlimited" | "fixed_term")
Employee contract type.
array
Employee custom fields.
boolean
Employee having spouse.
object
Employee profile image.
array
Employee department IDs.
string
Employee last name phonetic reading.
string
Employee last workplace.
string
Employee contract end on.
string
Employee first name phonetic reading.
string
Employee first workplace.
string
Employee resident end date.
string
Employee resigned reason.
string ("ordinary_handicapped" | "special_handicapped")
Employee handicapped type.
string
Employee nationality code.
string
Employee recruitment type.
string
Employee contract start on.
object
Employee emergency address.
object
Employee handicapped image.
string
Employee payment period ID.
string ("divorce" | "bereavement" | "missing" | "unmarried")
Employee widow reason type.
string
Employee business last name.
string
Employee employment type ID.
boolean
Employee estate income flag.
string
Employee previous workplace.
object
Employee student card image.
string
Employee business first name.
string
Employee emergency last name.
integer
Employee monthly base salary.
string
Employee basic pension number.
string
Employee business establishment ID.
boolean
Employee business income flag.
string ("commutation_period_1_month" | "commutation_period_3_month" | "commutation_period_6_month")
Employee commutation 1 period.
string ("commutation_period_1_month" | "commutation_period_3_month" | "commutation_period_6_month")
Employee commutation 2 period.
boolean
Whether the employee has dividend income.
string
Employee emergency first name.
string
Employee emergency telephone number.
string
Employee employment insurance qualified date.
object
Employee identity card image1.
object
Employee identity card image2.
integer
Employee monthly income goods.
string
Employee resident status type.
string
Employee social insurance qualified date.
integer
Employee spouse yearly income.
boolean
Employee working student flag.
string
Employee address relation name.
string ("renewal" | "none" | "auto_renewal")
Employee contract renewal type.
string
Employee handicapped note type.
object
Employee resident card address.
string
Employee address head of family.
integer
Employee commutation 1 expenses.
integer
Employee commutation 2 expenses.
boolean
Employee employment income flag.
string
Employee last employment end on.
string ("other_be_workable" | "others")
Dispatch or contract-work category.
integer
Employee working student income.
string
Employee business last name phonetic reading.
integer
Employee child care contribution.
string
Employee emergency relation name.
string
Employee employment insurance disqualified date.
string
Employee first employment end on.
integer
Employee monthly income currency.
string
Employee social insurance disqualified date.
string
Employee business first name phonetic reading.
string
Employee emergency last name phonetic reading.
string
Employee last employment start on.
string
Employee nearest station and line.
integer
Employee commutation 1 single fare.
integer
Employee commutation 2 single fare.
string
Employee emergency first name phonetic reading.
string
Employee first employment start on.
object
Employee basic pension number image.
string
Employee foreign resident last name.
string
Employee previous employment end on.
string
Employee foreign resident first name.
string
Employee last workplace address text.
integer
Employee monthly standard income health.
integer
Employee monthly standard income pension.
string
Employee first workplace address text.
object
Employee foreign resident card image1.
object
Employee foreign resident card image2.
string
Employee foreign resident card number.
string
Employee foreign resident middle name.
string
Employee handicapped note delivery date.
string
Employee previous employment start on.
string
Employee resident status other reason.
string
Employee employment insurance insured person number.
string ("permitted" | "none")
Employee having ex activity permission.
string
Employee health insurance qualified date.
integer
Employee health insurance insured person number.
integer
Employee social insurance insured person number.
integer
Employee care insurance premium company.
integer
Employee child care support fund company.
string
Employee health insurance disqualified date.
integer
Employee health insurance premium company.
integer
Employee care insurance premium individual.
integer
Employee child care support fund individual.
string ("rate" | "fixed")
Employee insurance premium calculation type.
string
Employee monthly standard income updated date.
object
Employee employment insurance insured person number image.
boolean
Employee first enrolling in employment pension insurance flag.
integer
Employee health insurance premium individual.
string
Employee resident card address relation name.
string
Employee resident card address head of family.
string ("non_pensionable" | "unknown")
Employee basic pension number unknown reason type.
string
Employee employees pension insurance qualified date.
string
Employee employees pension insurance disqualified date.
integer
Employee employees pension insurance premium company.
integer
Employee employees pension insurance premium individual.
string ("no_work_experience" | "never_joined" | "unknown")
Employee employment insurance insured person number unknown reason type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_UPDATE_EMPLOYEE_CUSTOM_FIELD_TEMPLATE_GROUPUpdate one or more supplied fields of an employee custom-field template group.

Input Parameters

string
required
Employee custom-field template group ID.
string
Employee custom-field template group name.
integer
Display position of the group.
string ("read_and_update" | "hidden" | "read_and_update_values" | "read_and_update_only_origin")
Access policy that controls whether and how employees can view or update values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_UPDATE_EMPLOYEE_DEPENDENTUpdate the supplied fields of one dependent belonging to an employee.

Input Parameters

string
required
Dependent id.
string
Dependent job.
string
Dependent code.
string ("male" | "female")
Dependent gender.
integer
Dependent income.
object
Dependent address.
string
Dependent birth date.
string
Dependent moved date.
boolean
Dependent is spouse.
string
Dependent last name.
string
Dependent first name.
string
Dependent telephone number.
string
required
SmartHR employee ID.
string
Dependent relation ID.
array
Dependent custom fields.
object
Dependent kinship image.
string
Dependent last name phonetic reading.
integer
Dependent monthly income.
string
Dependent first name phonetic reading.
string ("ordinary_handicapped" | "special_handicapped" | "special_handicapped_living_together")
Dependent handicapped type.
object
Dependent handicapped image.
object
Dependent remittance image1.
object
Dependent remittance image2.
object
Dependent remittance image3.
string ("living_together" | "living_separately")
Dependent live together type.
string
Dependent disqualified reason.
string
Dependent basic pension number.
string
Dependent social insurance qualified date.
integer
Dependent tax deduction income.
string ("unsupported" | "unsupported_same_living_spouse" | "supported" | "special_spousal_exemption" | "unknown")
Dependent tax law support type.
string
Dependent handicapped note type.
boolean
Dependent international student.
integer
Dependent remittance to relative.
string
Dependent social insurance disqualified date.
string ("death" | "divorce" | "employment" | "income_increase" | "aging_out_75" | "disability_certificate" | "others")
Dependent disqualified reason type.
object
Dependent maternity handbook image.
string
Dependent social insurance qualified reason.
object
Dependent basic pension number image.
string
Dependent tax deduction qualified date.
object
Dependent international student image.
string
Dependent handicapped note delivery date.
string ("unsupported" | "supported" | "unknown")
Dependent social insurance support type.
string
Dependent tax deduction disqualified date.
string
Dependent tax deduction qualified reason.
string
Dependent tax deduction disqualified reason.
string ("death" | "divorce" | "employment" | "income_increase" | "others")
Dependent tax deduction disqualified reason type.
string
Dependent spouse dependent disqualification reason.
string
Dependent spouse dependent disqualification dead date.
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")
Dependent spouse dependent qualification reason type.
string ("dead" | "others")
Dependent spouse dependent disqualification reason type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_UPDATE_GRADEUpdate 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

string
Grade name.
integer
Grade rank from 1 to 99999.
string
required
ID of the SmartHR grade to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_UPDATE_JOB_CATEGORYUpdate 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

string
Job category name.
string
required
ID of the SmartHR job category to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_UPDATE_JOB_TITLEUpdate 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

string
Job title code.
string
Job title name.
integer
Job title rank from 1 to 99999.
string
required
ID of the SmartHR job title to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_UPDATE_RECRUITMENT_TYPEUpdate 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

string
required
Recruitment type name.
string
required
ID of the SmartHR recruitment type to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_UPDATE_TAX_WITHHOLDINGUpdate the supplied fields of a sensitive SmartHR tax-withholding group by ID. SmartHR does not allow updates after the group is fixed. The connected API access token must have the tax-withholding-group resource Update permission.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTHR_UPDATE_TAX_WITHHOLDING_SLIPUpdate a sensitive SmartHR tax-withholding slip using a file, legacy values, or a complete set of required structured fields. Confirmed slips cannot be updated, switching between file-backed and field-backed data requires deleting and recreating the slip, and the access token must have tax-withholding-slip Update permission.

Input Parameters

object
File for a file-backed tax-withholding slip.
string
Slip notes.
string
Widow-status string marker; SmartHR’s Swagger does not enumerate accepted values.
array
SmartHR legacy ordered array. SmartHR does not document the item order; prefer the named fields. Use only when replaying a known provider-compatible payload.
string
Widower-status string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Tax-table column B string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Minor-status string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Foreign-national string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Tax-withholding slip type. SmartHR accepts ‘給与・賞与’ for structured slips.
string
required
ID of the employee associated with the slip.
string
Employee date of birth.
string
Employee job title.
string
Single-parent string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Special-widow string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Employee full name.
integer
Payment amount.
string
Disaster-victim string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Payer full name.
string
Working-student string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Mid-year employment-start string marker; SmartHR’s Swagger does not enumerate accepted values.
string
String marker that a deductible spouse is present. SmartHR’s Swagger does not enumerate accepted marker values.
string
Spouse full name.
string
Mid-year resignation string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Employee other-disability string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Death-related resignation string marker; SmartHR’s Swagger does not enumerate accepted values.
string
required
ID of the SmartHR tax-withholding group containing the slip.
string
Employee full name in phonetic form.
string
Employee special-disability string marker; SmartHR’s Swagger does not enumerate accepted values.
string
Deductible spouse non-resident category code. SmartHR’s Swagger does not enumerate accepted code values.
integer
Spouse total income.
string
Employee address.
string
String marker for the secondary deductible-spouse category. SmartHR’s Swagger does not enumerate accepted marker values.
string
First dependent full name.
integer
Number of other dependents.
string
Spouse full name in phonetic form.
integer
Basic deduction amount.
integer
Social insurance payment amount.
integer
Withholding tax amount.
integer
Number of elderly dependents.
string
required
ID of the sensitive SmartHR tax-withholding slip to update.
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")
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.
integer
Number of specific dependents.
string
String marker that the deductible spouse is elderly. SmartHR’s Swagger does not enumerate accepted marker values.
string
First housing loan residence start date.
string
Second housing loan residence start date.
integer
Life insurance deduction amount.
integer
Number of secondary other dependents.
integer
Nursing and medical insurance premium amount.
string
First dependent name in phonetic form.
integer
Number of secondary elderly dependents.
integer
New life insurance premium amount.
integer
Number of non-resident relatives.
integer
Old life insurance premium amount.
string
Payer business establishment telephone number.
integer
Number of housing loan deductions.
integer
Number of secondary specific dependents.
string
First housing-loan special-deduction type code. SmartHR’s provider docs do not enumerate code values.
string
Second housing-loan special-deduction type code. SmartHR’s provider docs do not enumerate code values.
integer
Housing loan deduction amount.
integer
Number of dependents under 16.
integer
Earthquake insurance deduction amount.
string
Mid-year employment start or resignation date.
integer
National pension insurance premium amount.
integer
Special spouse deduction amount.
string
Payer business establishment address.
integer
Number of other disabled dependents.
integer
Number of specific-relative dependents.
integer
Income adjustment deduction amount.
integer
Number of special-disabled dependents.
string
First under-16 dependent full name.
integer
Number of elderly dependents living together.
integer
Available housing loan special deduction amount.
integer
Payment after income deductions.
integer
Number of secondary specific-relative dependents.
string
First under-16 dependent non-resident category code. SmartHR’s Swagger does not enumerate accepted code values.
integer
First housing loan year-end balance.
integer
Second housing loan year-end balance.
integer
New personal pension insurance premium amount.
integer
Old personal pension insurance premium amount.
string
First under-16 dependent name in phonetic form.
integer
Old long-term casualty insurance premium amount.
integer
Payment after employment income deductions.
integer
Specific-relative special deduction amount.
integer
Number of special-disabled dependents living together.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not