Read Employee

Retrieve employee information from SmartHR using a specific ID.

Input

Field Definition Type Required

Employee

Employee ID The unique identifier of the employee.

Text

TRUE

Output

Field Definition Type

Basic Information

Employee ID The unique identifier of the employee.

Text
User ID The unique identifier of the user.

Text
Last Name Employee family name.

Text
First Name Employee first name.

Text
Last Name Yomi Employee phonetic family name.

Text
First Name Yomi Employee phonetic first name.

Text
Business Last Name Business family name.

Text
Business First Name Business first name.

Text
Business Last Name Yomi Business phonetic family name.

Text
Business First Name Yomi Business phonetic first name.

Text
Birth Date Employee birth date.

Date & Time
Gender Employee gender.

Text
Email Employee email.

Text
Profile Images Employee profile images. Object (List)
Identity Card Image 1 First document for employee identity verification.

Object
Identity Card Image 2 Second document for employee identity verification.

Object
Created At Date created.

Date & Time
Updated At Last updated.

Date & Time

Employment Status

Employment Status Employment status.

Text
Start Date Employment start date.

Date & Time
Resigned Date Employment end date.

Date & Time
Resignation Reason Reason for leaving.

Text

Employment Information

Employee Number Employee number.

Text
Business Establishment ID Office ID.

Text
Employment Type

Type of employment.

  • ID (Text) - Employment type

  • ID Name (Text) - Employment type name

  • Preset Type (Type) - Employment type

Object
Position Employment position.

Text
Occupation Employment occupation.

Text
Payment Period

Employment payment period.

  • ID (Text) - Payment period id

  • Name (Text) - Payment period name

  • Period Type (Text) - Payment period type

Object

Departments

Department

Department name.

Note: Only the first registered department name is returned.

Text
Departments

Registered departments. The card displays a maximum of 100 choices for this field.

  • ID (Text) - Department ID

  • Name (Text) - Department name

  • Position (Text) - Department position

  • Code (Text) - Department code

  • Parent (Object) - Parent Department

 Object (List)

Current Address

Address

Employee's current address.

  • Country Number (Text) - Country number (ISO 3166 - numeric value)

  • Zip Code (Text) - Zip code

  • Prefecture (Text) - Administrative jurisdiction of Japan

  • City (Text) - City

  • Street (Text) - Street

  • Building (Text) - Building

  • Literal Yomi (Text) - Phonetic name

Object
Address Image Document confirming current address.

Object
Telephone Number Employee's telephone number.

Text
Head of Household Name Head of household.

Text
Head of Household Relationship Relationship of head of household.

Text

Resident Card Address

Resident Card Address

Residence card address.

  • Country Number (Text) - Country number (ISO 3166 - numeric value)

  • Zip Code (Text) - Zip code

  • Prefecture (Text) - Administrative jurisdiction of Japan

  • City (Text) - City

  • Street (Text) - Street

  • Building (Text) - Building

  • Literal Yomi (Text) - Phonetic name

Object
Resident Card Address Head of Family Head of household of residence card address.

Text
Resident Card Address Relation Name Relation of head of household residence card address.

Text

Curriculum Vitae

Resume 1 Employee resume 1.

Object
Resume 2 Employee resume 2.

Object

Commuting Allowance

Commute Route Commuting route.

Text
Commuter Expense 1 Pass fee for commuting allowance 1.

Number
Commuter Expense Period 1 Period of commuting allowance 1.

Text
Commuter One-way Fare 1 One-way fare for commuting allowance 1.

Number
Commuter Expense 2 Pass fee for commuting allowance 2.

Number
Commuter Expense Period 2 Period of commuting allowance 2.

Text
Commuter One-way Fare 2 One-way fare for commuting allowance 2.

Number

Emergency Contact

Emergency Contact Last Name Family name of emergency contact.

Text
Emergency Contact First Name First name of emergency contact.

Text
Emergency Contact Last Name Yomi Phonetic family name of emergency contact.

Text
Emergency Contact First Name Yomi Phonetic first name of emergency contact.

Text
Emergency Contact Relationship Relationship to emergency contact.

Text
Emergency Contact Telephone Number Telephone number of emergency contact.

Text
Emergency Contact Address

Address of emergency contact.

  • Country Number (Text) - Country number (ISO 3166 - numeric value)

  • Zip Code (Text) - Zip code

  • Prefecture (Text) - Administrative jurisdiction of Japan

  • City (Text) - City

  • Street (Text) - Street

  • Building (Text) - Building

  • Literal Yomi (Text) - Phonetic name

Object

Account Information

Bank Accounts

Bank account information.

  • Bank Code (Text) - Bank code. For example, enter 0001 for Mizuho Bank

  • Bank Branch Code (Text) - Branch code. For example, enter 015 for Tsukiji

  • Account Type (Text) - Account type

  • Account Number (Text) - Bank account number

  • Account Holder Name (Text) - Bank account holder name

  • Bankbook Image (Object) - Document confirming bank account

  • Bank Account Setting ID (Text) - Account setting ID
 Object (List)

Salary

Monthly Income Currency Monthly income (currency).

Number
Monthly Income Goods Monthly income (goods).

Number

Employment Contract Information

Contract Type Employment contract type.

Text
Contract Start Date Start date of employment contract.

Date & Time
Contract End Date End date of employment contract.

Date & Time
Contract Renewal Type Type of employment contract renewal.

Text

Foreign Residence Information

Foreign Resident Last Name Foreign resident family name.

Text
Foreign Resident First Name Foreign resident first name.

Text
Foreign Resident Middle Name Foreign resident middle name.

Text
Foreign Resident Card Number Residence card number.

Text
Nationality Code Nationality code (ISO 3166 - numeric value).

Text
Resident Status Type Status of residence.

Text
Unknown Status of Residence Reason Reason for unknown status of residence.

Text
Period of Stay Foreign residence period of stay.

Date & Time
Additional Activity Permission Permission to engage in activity other than that permitted under the status of residence previously granted.

Text
Dispatch/Contract Work Category Dispatch or contract work category.

Text
Foreign Resident Card Image 1 First image of residence card.

Object
Foreign Resident Card Image 2 Second image of residence card.

Object

Employment Insurance

Employment Insurance Insured Number Employment insurance insured number.

Text
Employment Insurance Insured Number Image Image of employment insurance insured number.

Object
Employment Insurance Insured Number Unknown Reason Reason for unknown employment insurance insured number.

Text
Name of Company Enrolled in Employment Insurance Name of company enrolled in employment insurance.

Text
Enrollment Start Date Start date for employment insurance enrollment.

Date & Time
Enrollment End Date End date for employment insurance enrollment.

Date & Time
Employment Insurance Eligibility Start Date Start date for employment insurance eligibility.

Date & Time
Employment Insurance Eligibility End Date End date for employment insurance eligibility.

Date & Time

Social Insurance

Welfare Pension Insurance Insured Person Reference Number Welfare pension insurance insured person reference number.

Number
Health Insurance Insured Reference Number Health insurance insured reference number.

Number
Basic Pension Number Basic pension number.

Number
Basic Pension Number Image Basic pension number attached image.

Object
First Time Employees Pension Plan Enrollment Welfare pension first participation flag.

True/False
Unknown Basic Pension Number Reason Reason for unknown basic pension number.

Text
First Employee Pension Plan Company Name Name of the company that first enrolled in the employees pension plan.

Text
First Employee Pension Plan Company Address Address if the company that first enrolled in the employees pension plan.

Text
First Employee Pension Plan Company Start Date Enrollment start date of the company that first enrolled in the employees pension.

Date & Time
First Employee Pension Plan Company End Date Enrollment end date of the company that first enrolled in the employees pension.

Date & Time
Last Employee Pension Plan Company Name Name of the company that last enrolled in the employees pension plan.

Text
Last Employee Pension Plan Company Address Address if the company that last enrolled in the employees pension plan.

Text
Last Employee Pension Plan Company Start Date Enrollment start date of the company that last enrolled in the employees pension.

Date & Time
Last Employee Pension Plan Company End Date Enrollment end date of the company that last enrolled in the employees pension.

Date & Time
Social Insurance Qualification Start Date Start date for social insurance qualification.

Date & Time
Social Insurance Qualification End Date End date for social insurance qualification.

Date & Time
Monthly Standard Income Revision Date Monthly standard income revision date.

Date & Time
Standard Monthly Income for Health Insurance Standard monthly income for health insurance.

Number
Standard Monthly Income for Employee Pension Standard monthly income for employee pension.

Number

Spouse Information

Marital Status Marital status.

True/False
Spouse Annual Income Annual income of spouse.

Number

Tax Information

Tax Classification Tax classification.

Text
Disability Type Disability type.

Text
Disability Certificate Type Disability type certificate.

Text
Disability Certificate Issuance Date Issuance date of disability certificate.

Date & Time
Disability Image Handbook image of person who has a disability.

Object
Working Student Flag Working student flag.

True/False
School Name Working student school name.

Text
Student Card Image Image of student ID card.

Object
Date of Admission Working student date of admission.

Date & Time
Student Income Working student estimated income.

Number
Employment Income Flag Employment income flag.

True/False
Business Income Flag Business income flag.

True/False
Dividend Income Flag Dividend income flag.

True/False
Real Estate Income Flag Real estate income flag.

True/False
Widow/Single Parent Type Widow or single parent type.

Text
Widow/Single Parent Reason Widow or single parent reason.

Text
Notes for Widows and Single Parents Notes for widows and single parents.

Text

Custom Fields

Custom Field Group Name

User-defined employee fields. Custom fields are grouped by custom field group name. The card displays a maximum of 100 choices for this field.

  • ID (Text) - custom field identifier

  • Name (Text) - custom field name

  • Value (Various) - value associated to custom field

  • Type (Text) - custom field type

 Object (List)

Related topics

SmartHR connector

Workflow elements

SmartHR API documentation