The integration mentioned in this article is currently under development, and the details provided are subject to change. To stay updated on any modifications or enhancements, click the "Follow" button located at the top left corner of this article under the heading.
Who is Cintra?
Cintra, a prominent member of the Payroll Software and Services Group (PSSG), has been providing payroll software and services for over 40 years. Headquartered in the Northeast UK, Cintra serves over 1300 clients across various sectors, including education, retail, travel, manufacturing, and professional services. For more details, you can visit Cintra's official website.
What this article covers
This article outlines the functions and options available through API-based integration with Cintra in Humanforce Cloud. It is crucial to set up the integrations correctly to prevent data issues. If you require assistance or are unsure about setting up the integration, please reach out for help before starting to avoid additional fees for support packages.
What does the integration do?
The integration between Humanforce WFM and Cintra facilitates the transfer of crucial employee data, ensuring accuracy and efficiency in workforce management.
Here's what the integration accomplishes:
-
Employee Personal Details
-
Cintra → Humanforce WFM
- Newly created employees and updates made to the employee's details are sent to WFM in a bulk sync that can be scheduled or manually run through Integration Central (IC).
-
Humanforce WFM → Cintra
- New employees created in the WFM Onboarding module or Employee Management screen, create a new employee in Cintra.
- Note, an employee will not be active in Cintra until all payroll-specific fields are completed directly in Cintra.
- Note, WFM default values can be configured and applied to new profiles on initial import if that profile has no existing data for the corresponding field. (e.g. access level, clock in settings)
- Updates made to employee details from the Employee Management screen or via the Change Approval process will flow through to Cintra.
- New employees created in the WFM Onboarding module or Employee Management screen, create a new employee in Cintra.
-
Cintra → Humanforce WFM
-
Payroll Export
-
Humanforce WFM → Cintra
- Standard Payroll File - Variance Export
- Leave Payroll File - Absence Export
- These files are available for download in the WFM payroll screen, once a pay run has been processed through the Humanforce WFM Management>Timesheets>Payroll section, these files must be manually uploaded into Cintra. Instructions on how to process a pay run in Humanforce WFM can be found in this article ⭧How do I create a payrun in Humanforce?
-
Humanforce WFM → Cintra
- Leave Balances - Employee Leave Balances are handled separately.
- Employee Leave Balances cannot be transferred via the API, however, can be exported out of Cintra in a CSV and uploaded manually into ⭧Humanforce WFM through integration central.
If you require assistance with the creation of the leave balance file, please contact Cintra Support.
- Employee Leave Balances cannot be transferred via the API, however, can be exported out of Cintra in a CSV and uploaded manually into ⭧Humanforce WFM through integration central.
Prerequisites
Before proceeding with the integration, ensure that the following prerequisites are met:
- Humanforce Cloud Customer: Access to this integration is exclusive to Humanforce Cloud customers.
- API Credentials: Obtain API credentials from Cintra with comprehensive permissions to facilitate data exchange between the platforms.
- Source of Truth: Cintra serves as the primary repository for employee data, unless Humanforce WFM onboarding is used, in which case WFM becomes the source of truth.
- Change Approvals: The "Changes Require Approval" permission must be enabled for changes to flow via the Change Approvals page into Payroll.
Integration Setup
The step by step set up instructions for the Cintra integration can be found in this article ⭧Set up Cintra Payroll integration
API Documentation
Humanforce WFM uses its REST API to push and pull data between the systems. More information on the Humanforce REST API is available in this article ⭧Humanforce REST API Overview.
Integration Workflow
-
Prepare your data:
- Create Auxiliary Data:
- In WFM: Create Access Level, Clock-in Setting, Qualification Types, Visa Types, Employment Type, Location, Department, Role, Award Profiles and Area (if required) in WFM.
- In both systems: Create Public Holidays, Pay Rates, Pay Types and Leave Types. Create and match Gender, Title and Pay Company in both WFM and Cintra.
- Create or upload employee records in Humanforce WFM.
- Create Auxiliary Data:
-
Set Up Integration:
- Obtain API credentials for Cintra.
- Set up the integration in WFM > Integration Central. ⭧Learn how in this article.
- Test the connection and resolve any errors.
- Configure Mapping:
-
Review and Troubleshoot:
- Monitor the import log and address any errors for a successful data transfer.
Best Practices and Tips
- Ensure the External ID in WFM matches the People ID in Cintra before enabling integration to avoid duplication.
- Ensure auxiliary data matches between systems (Gender, Title, Employment Type, etc.).
- Double-check field mappings and configurations to avoid potential data inconsistencies.
- Regularly review import logs and address any errors or issues promptly.
Supported Data Mapping
Employee Details
Employee Connection
- Only employees assigned within the selected Employer and Payroll from Cintra will be imported.
- Only employees with active employment will be imported.
- The integration links profiles using People ID in Cintra and Externa ID in Humanforce WFM.
- If the values of these fields are different for an employee, the employee profile will not sync across systems.
- Changing other codes in Humanforce WFM, such as Employee Code and Payroll Code, won't impact profile syncing.
Available Integration Flows
Cintra → WFM | WFM → Cintra |
|
|
Integrated Data
The following tables will take you through which employee data fields can be transferred via the API.
Some fields are configurable in the integration configuration screen in WFM (Management>Advanced>Integration Central).
- Where field details are noted as "Summary Entity Model", ensure the values held in the auxiliary list match between systems.
Field Name HF WFM - tab.section. field name [api name] |
Field Name |
Integration Direction |
Important Notes Field Details |
Employment.Employment. Payroll Code* |
EmploymentId |
WFM→Cintra Cintra→WFM |
These codes match in the UI allowing a consistent code that identifies an employee to be tracked in both systems. 100 character max |
Other Info.Other Info. External ID |
People ID |
Cintra→WFM |
This is the unique identifier for the employee profile to sync between systems, this is the only code used when linking profiles for integration purposes. |
Personal Details.Personal. Title |
Title |
WFM→Cintra Cintra→WFM |
The Title in WFM must be configured to match the values in Cintra. string or null <= 4 characters |
Personal Details.Personal. First Name* |
FirstName* |
WFM→Cintra Cintra→WFM |
string <= 30 characters ^[A-Za-z [A-Za-z \\-]*$ |
Personal Details.Personal. Last Name* |
Surname* |
WFM→Cintra Cintra→WFM |
string <= 30 characters ^[A-Za-z [A-Za-z \\-]*$ |
Personal Details.Personal. Roster Name* |
knownAs |
WFM→Cintra Cintra→WFM |
Employee’s name as it will appear in the rostering screen. 15 character max |
Personal Details.Personal. Gender |
Gender* |
WFM→Cintra Cintra→WFM |
string <= 6 characters |
Personal Details.Personal. Birth Date [DateOfBirth] |
BirthDate* |
WFM→Cintra Cintra→WFM |
dd-mm-yyyy |
Personal Details.Contact. Phone |
homeTelephone |
WFM→Cintra Cintra→WFM |
20 character max |
Personal Details.Contact. Mobile |
mobileTelephone |
WFM→Cintra Cintra→WFM |
20 character max |
Personal Details.Address. Address 1 |
addressLine1 |
WFM→Cintra Cintra→WFM |
50 character max |
Personal Details.Address. Suburb |
addressLine3 |
WFM→Cintra Cintra→WFM |
50 character max |
Personal Details.Address. State |
addressLine4 |
WFM→Cintra Cintra→WFM |
50 character max |
Personal Details.Address. Post Code |
addressPostcode |
WFM→Cintra Cintra→WFM |
10 character max |
Personal Details.Address. Country |
addressCountry |
WFM→Cintra Cintra→WFM |
50 character max |
Personal Details.Contact. |
|
WFM→Cintra Cintra→WFM |
128 character max |
Employment.Employment. Employment Type |
employmentStatus |
WFM→Cintra Cintra→WFM |
Summary Entity Model |
Employment.Employment. Termination Date |
leavingDate |
WFM→Cintra Cintra→WFM |
dd-mm-yyyy |
Employment.Employment. Start Date* |
startdate |
WFM→Cintra Cintra→WFM |
dd-mm-yyyy |
Employment.Employment. Tax Id |
NI Number |
WFM→Cintra Cintra→WFM |
string or null <= 9 characters |
* Mandatory field
New Employee Defaults
The following fields allow once-off values to be selected for newly created employees.
Field Name - WFM tab.section.field name |
Field Details |
Personal Details.Personal.
|
|
Employment.Employment.
|
Summary Entity Model |
Employment.Employment.
|
|
Location, Department, Roles.Roles and Profiles.
|
Summary Entity Model |
* Mandatory field
Payroll Export
Standard Payroll File - Variance Export
Field Name |
Field Name |
Transfers |
Setup Requirements Field Details |
PayrollCode |
Employee Number |
Cintra→WFM |
WFM - Employees PayrollCode is mandatory and must match the Employee Number in Cintra.
|
PayType ExportCode |
Payment Code |
Cintra→WFM |
WFM - PayType ExportCode is mandatory and max 3 characters
|
PayType Name |
Payment Name |
Cintra→WFM |
WFM - PayType Name is optional with a max of 30 characters
|
payrunSummary. TimeStart |
Start Date |
Cintra→WFM |
WFM - Timesheet has start date
|
payrunSummary. TimeEnd |
End Date |
Cintra→WFM |
WFM - Timesheet has end date
|
Cost |
Amount |
Cintra→WFM |
WFM - Send Amount and skip both Units/rate if any of the below are enabled. Don't need to check Unit/hourly for Amount. Cintra - If Payment type is set up as Monetary, then amount is mandatory.
|
Value |
Units |
Cintra→WFM |
WFM - The most common setup required, used for Ordinary Hours, Overtime, Laundry/first aid allowance etc. Cintra - If Payment type is set up as Units * Rate, then Units are mandatory.
|
HourlyRate Multiplier |
Rate |
Cintra→WFM |
WFM - AsUnits = true Multiplier = Rate AsUnits = false HourlyRate = Rate If HourlyRate = 0 then skip sending rate Cintra - If passed, it will override the default Rate defined in CintraIQ.
|
* Mandatory field
Leave Payroll File - Absence Export
Field Name |
Field Name |
Transfers |
Field Details |
PayrollCode |
Employee Number* |
Cintra→WFM |
|
Pay Type ExportCode |
Absence code* |
Cintra→WFM |
|
payrunSummary. TimeStart(date) |
Start Date* |
Cintra→WFM |
”YYYY-MM-DD” |
payrunSummary. TimeEnd(date) |
End Date* |
Cintra→WFM |
”YYYY-MM-DD” |
NA |
Start Date Half* |
Cintra→WFM |
Mandatory - unless using hours |
NA |
End Date Half* |
Cintra→WFM |
Mandatory - unless using hours |
payrunSummary. TimeStart(time) |
Start Time* |
Cintra→WFM |
”HH:MM” Mandatory - unless using hours |
payrunSummary. TimeEnd(time) |
End Time* |
Cintra→WFM |
”HH:MM” Mandatory - unless using hours |
Difference in Start and End times minus the BreakTotalMins |
Duration |
Cintra→WFM |
”HH:MM” |
|
Absence Reason |
NA |
|
|
Notes |
NA |
|
* Mandatory field