v1
latestOpenAPI 3.1.02026-07-242735131.1 MBSandbox
Activate Global Payroll for a legal entity
Enables the Global Payroll product on a legal entity so that GP employees can be created against it.
Performs three idempotent steps:
- Adds the Global Payroll product to the company.
- Flips global_payroll_enabled on the legal entity's settings.
- Ensures a Global Payroll pricing plan exists for the legal entity's country.
This endpoint is only available in Sandbox, otherwise it will respond with a 404.
post/v1/sandbox/companies/{company_id}/legal-entities/{legal_entity_id}/activate-global-payroll
Path parameters
company_idstring required
Company ID
legal_entity_idstring required
Legal Entity ID to activate Global Payroll on
Response
Success
Example response
{
"data": {
"status": "ok"
}
}