Skip to main content

Auto-sync Compensation Default Fields with an HRIS

Dianmarie
  • Updated

Before admins can create a compensation cycle, they must upload employee pay data to Lattice. There are two ways to upload employee pay data: sync compensation fields from your HRIS or upload via CSV Upload.  Once Compensation default fields are synced, employee compensation data will be available to view within the Employee Pay page. 

The following default fields are required when using Compensation:

  • Base pay amount
    • Expected value: number showing the annual rate for employees with Pay Type = "salary", or the hourly rate for employees with Pay Type = "hourly". 
  • Pay effective date
    • Expected value: date in format YYYY-MM-DD, for example "2024-01-01" 
  • Currency
    • Expected value: 3-letter currency code, for example "USD" or "GBP"
  • Pay Type
    • Expected value: exact text "salary" or "hourly" 

The following default fields are optional when using Compensation:

  • Variable Pay Amount
    • Expected value: number showing the annual variable pay rate in the employee's currency
    • This field is not available for employees with Pay Type = "hourly"
  • Bonus Amount
    • Expected value: number showing the bonus plan amount in the employee's currency (not as a percent)
    • This field is not available for employees with Pay Type = "hourly"

If applicable, variable pay or bonus amount should be uploaded as well before creating a cycle. Learn more in Key Terms for Compensation.

Before you start

  • Only super admins can view and edit user fields and therefore can set up HRIS sync for compensation field.
  • Lattice Compensation default fields are only available if your account has access to Lattice Compensation. 
  • Pay-related custom fields that are created outside of the Compensation default fields will not sync to Lattice Compensation.
  • HRIS integration must be set up before Compensation default fields can be synced. Learn more in Integrate Your HRIS with Lattice.
    • The equivalent default or custom HRIS field to the Compensation default field must already exist within your HRIS. Ensure the equivalent field exists and is up-to-date.

Sync Compensation default fields with an HRIS

The following steps are how to connect fields to Lattice compensation if you are connected to a direct HRIS integration. If you are updating Lattice data via SFTP and not a direct integration, mapping does not need to be done in Lattice. Instead, add the compensation fields as columns to the SFTP report in your external system.

  1. Integrate with your HRIS.
  2. Navigate to Admin > Settings > People > Fields. 
  3. Expand the Compensation fields section. 
  4. Link the required field Base pay amount. 
    •  Click Link to HRIS next to Base pay amount.
    • A field modal will appear –– Under HRIS field, choose the field currently available within your HRIS that will be imported and linked to the Base pay amount default field. 
    • Select Link field. 

      Not sure what fields to link? See HRIS Field Options for Auto-Syncing to Lattice Compensation for recommended field mapping.

  5. Repeat for additional fields. 
    • Note: Base pay amount, Currency, Pay effective date, and Pay type are required for compensation cycles. It is recommended that all four default fields are linked if possible or that missing values are uploaded via CSV.
  6. Manually sync your HRIS to import values into Lattice.
    • Navigate to Admin > Settings > Platform > Integrations.
    • Click Manual sync. 
  7. View employee pay data via the Employee Pay page. 

Related articles