A Tenant (also called an Organization) is the top-level container for one or more companies (Payrolls).
- Contains: one or more Payrolls. The API allows several Payrolls under one Tenant, but only one is currently supported in practice. As a platform customer, create one Tenant per company customer of yours.
- Access: managed by Users with the appropriate role, invited by email
- Renaming: possible any time via PUT
/tenants/{orgId}(UpdateTenant), which lets you change the tenant's identifier - Deletion: ⚠ permanent possible via DELETE
/tenants/{orgId}(only for owners of that tenant) - a hard delete of the tenant and all its data, not a soft delete, with no recovery afterwards - Deactivating: no supported "pause" toggle exists - the only tenant-level lifecycle action is the permanent delete above. If you just want to stop new calculations, simply stop reporting case changes and don't close further periods
API Endpoints
| What | Call |
|---|---|
| List tenants | GET /tenants |
| Create a tenant | POST /tenants |
| Get a tenant | GET /tenants/{orgId} |
| Update a tenant (e.g. rename) | PUT /tenants/{orgId} |
| Delete a tenant | DELETE /tenants/{orgId} |