Update Employee

Update employee information for a specific ID.

Options

Field Definition Type Required

Clear Empty Values?

Choose an option to update input values:

  • If No, keep an existing value if there's no new input value provided. Only fields with new input values are updated.

  • If Yes, clear an existing value even if no new input value is provided. All specified input fields are updated, even if there's no new value provided for a field.

    The following input fields can't be cleared, even if you select Yes for the Clear Empty Values? option. If you don't provide a new value, the existing value remains.

    • First Name
    • Last Name
    • First Name Yomi
    • Last Name Yomi
    • Gender
    • Employment Status
    • Business Establishment ID
    • Address
    • Resident Card Address
    • Emergency Contact Address
    • Bank Account Setting ID
    • First Time Employees Pension Plan Enrollment
    • Working Student Flag
    • Employment Income Flag
    • Business Income Flag
    • Dividend Income Flag
    • Real Estate Income Flag
Dropdown TRUE

Input

Field Definition Type Required

Employee

Employee ID

The unique identifier of the employee.

Text TRUE

Basic Information

User ID

The unique identifier of the user.

Text FALSE

Last Name

Employee family name.

Text FALSE

First Name

Employee first name.

Text FALSE

Last Name Yomi

Employee phonetic family name.

Text FALSE

First Name Yomi

Employee phonetic first name.

Text FALSE

Business Last Name

Business family name.

Text FALSE

Business First Name

Business first name.

Text FALSE

Business Last Name Yomi

Business phonetic family name.

Text FALSE

Business First Name Yomi

Business phonetic first name.

Text FALSE

Birth Date

Employee birth date. Use YYYY/MM/DD format.

Date & Time FALSE

Gender

Employee gender:

  • Male

  • Female

Dropdown FALSE

Email

Employee email.

Text FALSE

Employment Status

Employment Status

Employment status:

  • Employed

  • On Leave

  • Retired

Dropdown FALSE

Start Date

Employment start date. Use YYYY/MM/DD format.

Date & Time FALSE

Resigned Date

Employment end date. Use YYYY/MM/DD format.

Date & Time FALSE

Resignation Reason

Reason for leaving.

Text FALSE

Employment Information

Employee Number

Employee number.

Text FALSE

Business Establishment ID

Office ID.

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

Dropdown FALSE

Employment Type

Type of employment:

  • Board Member

  • Full Time

  • Contract Worker

  • Permatemp

  • Part Time

  • Outsourcing Contractor

  • Etc

The card displayes a maximum of 100 choices for this field.

Dropdown FALSE

Position

Employment position.

Text FALSE

Occupation

Employment occupation.

Text FALSE

Payment Period

Employment payment period:

  • Monthly

  • Hourly

  • Weekly

  • Daily

Dropdown FALSE

Departments

Departments

Registered department IDs.

List of Text FALSE

Current Address

Country Number

Country number (ISO 3166 numeric value). Required if the address is outside of Japan. Only provide value if the address is outside of Japan.

Text FALSE

Zip Code

Zip code. For example, 106-0041. Required if this is a Japanese address. Japanese zip code only. Don't provide a value if the address is outside of Japan.

Text FALSE

Prefecture

Administrative jurisdiction of Japan. Required for a Japanese address. Don't provide a value if the address is outside of Japan.

Dropdown FALSE

City

City. Required if any other address inputs are provided. Include City and State if the address is outside of Japan. For example, Seattle, WA. If the address is in Japan, only provide the city name. For example, Tokyo.

Text FALSE

Street

Street. Required if any other address inputs are provided.

Text FALSE

Building

Building. Corresponds to Address 2 input if the address is outside of Japan. For example, APT 200.

Text FALSE

Literal Yomi

Phonetic name. Only provide value if the address is within Japan.

Text FALSE

Telephone Number

Employees telephone number. For example, 03-0000-0000.

Text FALSE

Head of Household Name

Head of household.

Text FALSE

Head of Household Relationship

Relationship of head of household.

Text FALSE

Resident Card Address

Country Number

Country number (ISO 3166 numeric value). Required if this address is outside of Japan. Only provide a value if the address is outside of Japan.

Text FALSE

Zip Code

Zip code For example, 106-0041. Required if this is a Japanese address. Japanese zip code only. Don't provide a value if the address is outside of Japan.

Text FALSE

Prefecture

Administrative jurisdiction of Japan. Required if this is a Japanese address. Don't provide a value if the address is outside of Japan.

Dropdown FALSE

City

City. Required if any other address inputs are provided. Include City and State if the address is outside of Japan. For example, Seattle, WA. If the address is in Japan, only provide the city name. For example, Tokyo.

Text FALSE

Street

Street. Required if any other address inputs are provided.

Text FALSE

Building

Building. Corresponds to Address 2 input if address is outside of Japan. For example, APT 200.

Text FALSE

Literal Yomi

Phonetic name. Only provide value if the address is within Japan.

Text FALSE

Resident Card Address Head of Family

Head of household of residence card address.

Text FALSE

Resident Card Address Relation Name

Relationship to head of household residence card address.

Text FALSE

Commuting Allowance

Commute Route

Commuting route.

Text FALSE

Commuter Expense 1

Pass fee for commuting allowance 1.

Text FALSE

Commuter Expense Period 1

Duration of commuting allowance 1.

Dropdown FALSE

Commuter One-way Fare 1

One-way fare for commuting allowance 1.

Text FALSE

Commuter Expense 2

Pass fee for commuting allowance 2.

Text FALSE

Commuter Expense Period 2

Duration of commuting 2.

Dropdown FALSE

Commuter One-way Fare 2

One-way fare for commuting allowance 2.

Text FALSE

Emergency Contact

Emergency Contact Last Name

Family name of emergency contact.

Text FALSE

Emergency Contact First Name

First name of emergency contact.

Text FALSE

Emergency Contact Last Name Yomi

Phonetic family name of emergency contact.

Text FALSE

Emergency Contact First Name Yomi

Phonetic first name of emergency contact.

Text FALSE

Emergency Contact Relationship

Emergency contact relationship.

Text FALSE

Emergency Contact Telephone Number

Emergency contact telephone number. For example, 03-0000-0000.

Text FALSE

Country Number

Country number (ISO 3166 numeric value). Required if the address is outside of Japan. Only provide a value if the address is outside of Japan.

Text FALSE

Zip Code

Zip code. For example, 106-0041. Required if this is a Japanese address. Provide the Japanese zip code only. Don't provide a value if the address is outside of Japan.

Text FALSE

Prefecture

Administrative jurisdiction of Japan. Required if this is a Japanese address. Don't provide value if the address is outside of Japan.

Dropdown FALSE

City

City. Required if any other address inputs are provided. Include City and State if address is outside of Japan For example, Seattle, WA. If this is a Japanese address, only provide the city name For example, Tokyo.

Text FALSE

Street

Street name. Required if any other address inputs are provided.

Text FALSE

Building

Building. Corresponds to Address 2 input if the address is outside of Japan. For example, APT 200.

Text FALSE

Literal Yomi

Phonetic name. Only provide a value if this address is within Japan.

Text FALSE

Account Information

Bank Code

Bank code. For example, enter 0001 for Mizuho Bank.

Text FALSE

Bank Branch Code

Branch code. For example, enter 015 for Tsukiji.

Text FALSE

Account Type

Account type:

  • Savings

  • Checking

  • Deposit

Dropdown FALSE

Account Number

Bank account number. If the account number is fewer than 7 digits, add 0 at the beginning.

Text FALSE

Account Holder Name

Name of the bank account holder.

Text FALSE

Bank Account Setting ID

Account setting ID.

Text FALSE

Salary

Monthly Income Currency

Monthly income (currency).

Text FALSE

Monthly Income Goods

Monthly income (goods).

Text FALSE

Employment Contract Information

Contract Type

Employment contract type:

  • Permanent

  • Fixed Term

Dropdown FALSE

Contract Start Date

Employment Contract Start Date. Use YYYY/MM/DD format. Value is set to null if Permanent is selected for input Contract Type.

Date & Time FALSE

Contract End Date

Employment Contract End Date. Use YYYY/MM/DD format. Value is set to null if Permanent is selected for input Contract Type.

Date & Time FALSE

Contract Renewal Type

Type of employment contract renewal:

  • Renewal

  • Auto Renewal

  • None

Value is set to null if Permanent is selected for input Contract Type.

Dropdown FALSE

Foreign Residence Information

Foreign Resident Last Name

Foreign resident family name. Must be in all capital letters.

Text FALSE

Foreign Resident First Name

Foreign resident first name. Must be in all capital letters.

Text FALSE

Foreign Resident Middle Name

Foreign resident middle name. Must be in all capital letters.

Text FALSE

Foreign Resident Card Number

Residence card number.

Text FALSE

Nationality Code

Nationality code (ISO 3166 numeric value).

Text FALSE

Resident Status Type

Status of residence.

Dropdown FALSE

Unknown Status of Residence Reason

Reason for unknown status of residence. Enter value if Not Clear is selected for Resident Status Type.

Text FALSE

Period of Stay

Foreign residence period of stay. Use YYYY/MM/DD format.

Date & Time FALSE

Additional Activity Permission

Permission to engage in activity other than that permitted under the status of residence previously granted.

Dropdown FALSE

Dispatch/Contract Work Category

Dispatch or contract work category.

Dropdown FALSE

Employment Insurance

Employment Insurance Insured Number

Employment insurance insured number. This is the 11-digit insured person number written on the job separation slip For example, 1234-567890-9

Text FALSE

Employment Insurance Insured Number Unknown Reason

Reason for unknown employment insurance insured number. If you don't have an Employment Insurance Insured Number, select a reason:

  • No Work Experience

  • Never Enrolled

  • Unknown

Dropdown FALSE

Name of Company Enrolled in Employment Insurance

Name of company enrolled in employment insurance.

Text FALSE

Enrollment Start Date

Start date of employment insurance enrollment. Use YYYY/MM/DD format.

Date & Time FALSE

Enrollment End Date

End date of employment insurance enrollment. Use YYYY/MM/DD format.

Date & Time FALSE

Employment Insurance Eligibility Start Date

Start date of employment insurance eligibility. Use YYYY/MM/DD format.

Date & Time FALSE

Employment Insurance Eligibility End Date

End date of employment insurance eligibility. Use YYYY/MM/DD format.

Date & Time FALSE

Social Insurance

Welfare Pension Insurance Insured Person Reference Number

Welfare pension insurance insured person reference number. For example, 1234-123456. This is the 10-digit number printed on the pension handbook, basic pension number notification, Nenkin regular mail, national pension premium payment slip, or similar document. If you don't have a number, or if you don't know your number, leave the field blank and select a reason from the Unknown Basic Pension Number Reason input field. If you're a mid-career hire and don't know your pension number, contact your previous employer.

Text FALSE

Health Insurance Insured Reference Number

Health insurance insured reference number.

Text FALSE

Basic Pension Number

Basic pension number.

Text FALSE

First Time Employees Pension Plan Enrollment

Welfare pension first participation flag.

True/False FALSE

Unknown Basic Pension Number Reason

Reason for unknown basic pension number:

  • Non Pensionable

  • Unknown

Dropdown FALSE

First Employee Pension Plan Company Name

Name of the company that first enrolled in the employees pension plan. Enter if Unknown is selected for Unknown Basic Pension Number Reason.

Text FALSE

First Employee Pension Plan Company Address

Address if the company that first enrolled in the employees pension plan. Enter if Unknown is selected for Unknown Basic Pension Number Reason.

Text FALSE

First Employee Pension Plan Company Start Date

Enrollment start date of the company that first enrolled in the employees pension. Use YYYY/MM/DD format. Enter if Unknown is selected for Unknown Basic Pension Number Reason.

Date & Time FALSE

First Employee Pension Plan Company End Date

Enrollment end date of the company that first enrolled in the employees pension. Use YYYY/MM/DD format. Enter if Unknown is selected for Unknown Basic Pension Number Reason.

Date & Time FALSE

Last Employee Pension Plan Company Name

Name of the company that last enrolled in the employees pension plan. Enter if Unknown is selected for Unknown Basic Pension Number Reason.

Text FALSE

Last Employee Pension Plan Company Address

Address if the company that last enrolled in the employees pension plan. Enter if Unknown is selected for Unknown Basic Pension Number Reason.

Text FALSE

Last Employee Pension Plan Company Start Date

Enrollment start date of the company that last enrolled in the employees pension. Use YYYY/MM/DD format. Enter if Unknown is selected for Unknown Basic Pension Number Reason.

Date & Time FALSE

Last Employee Pension Plan Company End Date

Enrollment end date of the company that last enrolled in the employees pension. Use YYYY/MM/DD format. Enter if Unknown is selected for Unknown Basic Pension Number Reason.

Date & Time FALSE

Social Insurance Qualification Start Date

Start date for social insurance qualification. Use YYYY/MM/DD format.

Date & Time FALSE

Social Insurance Qualification End Date

End date for social insurance qualification. Use YYYY/MM/DD format.

Date & Time FALSE

Monthly Standard Income Revision Date

Monthly standard income revision date. Use YYYY/MM/DD format.

Date & Time FALSE

Standard Monthly Income for Health Insurance

Standard monthly income for health insurance.

Text FALSE

Standard Monthly Income for Employee Pension

Standard monthly income for employee pension.

Text FALSE

Spouse Information

Marital Status

Marital status.

True/False FALSE

Spouse Annual Income

Annual income for spouse.

Text FALSE

Tax Information

Tax Classification

Tax classification:

  • Column A

  • Column B

  • Column C

  • Reward

  • Non-Resident

  • No Tax

Dropdown FALSE

Disability Type

Disability type:

  • General Disability

  • Special Disability

Dropdown FALSE

Disability Certificate Type

Disability type certificate:

  • Physical Disability Certificate, Grade 1
  • Physical Disability Certificate, Grade 2
  • Physical Disability Certificate, Grade 3
  • Physical Disability Certificate, Grade 4
  • Physical Disability Certificate, Grade 5
  • Physical Disability Certificate, Grade 6
  • Mental Disability Certificate, Grade 1
  • Mental Disability Certificate, Grade 2
  • Mental Disability Certificate, Grade 3
  • Medical Rehabilitation, Notebook A
  • Medical Rehabilitation, Notebook B
Dropdown FALSE

Disability Certificate Type Other Reason

Other reason for disability type certificate. Enter if option Other is selected for input Disability Certificate Type.

Text FALSE

Disability Certificate Issuance Date

Issuance date of disability certificate. Use YYYY/MM/DD format.

Date & Time FALSE

Working Student Flag

Working student flag.

True/False FALSE

School Name

Working student school name.

Text FALSE

Date of Admission

Working student date of admission.

Date & Time FALSE

Student Income

Working student estimated income.

Text FALSE

Employment Income Flag

Employment income flag.

True/False FALSE

Business Income Flag

Business income flag.

True/False FALSE

Dividend Income Flag

Dividend income flag.

True/False FALSE

Real Estate Income Flag

Real estate income flag.

True/False FALSE

Widow/Single Parent Type

Widow or single parent.

Dropdown FALSE

Widow/Single Parent Reason

Widow or single parent reason:

  • Divorced

  • Bereavement

  • Unknown

  • Unmarried

Dropdown FALSE

Notes for Widows and Single Parents

Notes for widows and single parents.

Text FALSE

Custom Fields

Custom Field Name - (Custom Field Group Name)

User-defined employee fields. The card displays a maximum of 100 choices for this field.

Various

FALSE

Output

Field Definition Type

Status Code

Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:

  • A 201 Created status code indicates success where a new resource was created.
  • A 403 Forbidden error indicates that the HTTP request wasn't processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

Number