Skip to main content

After this article

You will be able to connect Square Payroll to Lumos as an HRIS integration to sync your employee records.

Capabilities

As a Merge.dev-brokered HRIS integration, Lumos reconciles account status from the HRIS user status: Active → Active. Inactive → Suspended. Pending → Staged. Deleted (no longer returned) → Deprovisioned. When Square Payroll is the User Source, employment status is reconciled separately: Active → Active. Inactive → Inactive. Pending → Staged. Deleted → Inactive. Attribute support varies by app. Lumos is currently unable to pull in roles for this integration.

Required plan and roles

  • Square Payroll role: the OAuth connection must be authorized by an Admin of your Square Payroll account.
  • Permission scoping: this is a read-only HRIS integration, Lumos syncs employee data but does not provision or deprovision anything in Square Payroll.

Read-only access vs provisioning

Is read-only possible? Yes, and it’s the only mode. This is a read-only HRIS integration, Lumos syncs employee data but does not provision or deprovision anything in Square Payroll. What read-only requires. An OAuth connection authorized by an Admin of your Square Payroll account. Follow the steps below to connect through Square’s own login flow, no token or key needs to be created in advance. Watch out for. Lumos is currently unable to pull in roles for this integration, only employee account records sync.

Instructions

Phase 1: Prepare Square Payroll
  1. Make sure you can log in to Square Payroll as an Admin. The connection is authorized through Square’s own login flow, so no token or key needs to be created in advance.
Phase 2: Connect in Lumos
  1. Find the Square Payroll card in your Lumos integrations (reconnect an existing card or add a new one).
  2. Click Connect.
  3. Follow the prompts in the popup window, completing all actions as an Admin.

Troubleshooting

Roles do not appear in Lumos. This is a known limitation: the Square Payroll integration cannot sync roles. Only employee account data is available.