Skip to main content

Cartus Integration

Written by Carlo Arazas


The Cartus integration allows integration for Immigration, Move Management, and Destination Services.

Connecting Cartus to Workia

Click on your Profile icon on the top right corner to open the drop-down menu, hover over "Settings" and click on the Connections setting to open the Connections screen.

On the Connections screen, look for Cartus and click Connect.

Once you have opened the connection settings screen, you will be prompted to input the Supplier Connection Key. Click Connect to proceed with the connection!

šŸ’”Note: This connection needs a key. If you do not have one, you can contact [email protected] to request one.

Initiating a Cartus service

Once the connection is successfully established, you can initiate Cartus services directly from your case record.

When initiating a specific service, key details such as employee information, passport data, case specifics, and, if applicable, spouse and dependent details, are mapped and sent to Cartus.

Below is a list of available fields. Mandatory fields are marked with an asterisk (*) and must be completed for the service to work.

Employee

  • First Name*

  • Middle Name

  • Last Name*

  • Preferred Name

  • Marital Status

  • Gender

  • Primary Citizenship

  • Email

  • Birth Date

  • Hire Date

  • Employee ID

  • System Number

Assignment

  • Policy

  • Case Type

  • Relocation Reason

  • Status

  • Effective Date

  • Scheduled End Date

  • Origin City

  • Origin State/Province

  • Origin Country

  • Origin Job Title

  • Origin Salary Grade

  • Destination City

  • Destination State/Province

  • Destination Country

  • Destination Job Title

  • Destination Salary Grade

  • Assignment Number

  • Owner

Assignment Cost Center

  • Billing Code

  • Home Cost Center

  • Host Cost Center

  • Other Cost Center

  • Home Legal Entity

  • Host Legal Entity

Assignment Mailing Address

  • Address Line 1*

  • City*

  • State/Province Code

  • Postal Code*

  • Country Code*

Assignment Compensation Salary

  • Annual Base Pay

  • Base Pay Currency

Assignment Family Size

  • Home Family Size

  • Host Family Size

Spouse/Domestic Partner

  • First Name

  • Middle Name

  • Last Name

  • Gender

  • Citizenship Country Code

  • Relationship

  • Birth Date

  • Status

Documents

  • Case Documents

  • Service Documents

  • Passport Documents

  • Dependent Documents

HRIS Integration Updates to Cases

Employee-level fields

These live on the employee record itself, not on any individual case

  • First Name, Middle Name, Last Name

  • Gender

  • Marital Status

  • Employee Number

  • Date of Birth

  • Employee Address (Country)

  • Phone Number

  • Email

  • Annual Base Salary, Base Pay Effective Date, Base Pay Currency

  • Hire Date

  • Employee Status

  • Termination Date

šŸ’”Note: When HRIS updates one of these, it updates the employee record directly, so the change shows up on all of that employee's cases, regardless of case status.

Case-level fields

These are tied to the specific case, not the employee as a whole:

  • Home Legal Entity, Host Legal Entity

  • Home Cost Center, Host Cost Center

  • Bonus Amount, Bonus Currency

  • Job Grade

  • Job Title

šŸ’”Note: These update on all of the employee's active cases, but not on cases that are completed, cancelled, or repatriated. So if an employee has one active case and one completed case, a new Cost Center would update the active case only — the completed case stays as it was.

Did this answer your question?