Overview
The Company Policies API enables you to manage pay rule policy assignments for users. Pay rule policies define how employee work hours are calculated for payroll, including overtime rules, shift differentials, and other compensation factors.
Key Concepts
Pay Rule Policies
Pay rule policies are configurations that determine:
- Overtime calculation rules
- Shift differentials and premiums
- Regular vs overtime hour thresholds
- Additional hourly rate conditions
Policy Assignments
Each user can be assigned to a pay rule policy with an effective date. When assigning a policy:
- The effective date determines when the policy takes effect
- If the new effective date is earlier than an existing assignment, the old assignment is replaced
- Historical assignments affect payroll calculations retroactively
Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /company-policies/v1/pay-rule-policies | Get all pay rule policies |
| PUT | /company-policies/v1/pay-rule-policies/{payRulePolicyId}/assignments | Assign user to policy |
Authentication
All endpoints require authentication via API key or OAuth 2.0.
Required Scopes
| Scope | Operations |
|---|---|
| company_policies.read | GET pay rule policies |
| company_policies.write | PUT policy assignments |
Use Cases
Onboarding New Employees
Automatically assign new hires to the appropriate pay rule policy based on their role or department.
Policy Updates
When company policies change, bulk-update user assignments with a new effective date.
Department Transfers
When employees transfer between departments, update their pay rule policy to match the new role's compensation structure.
Guide Pages
| Page | Description |
|---|---|
| Pay Rule Policies | List and assign pay rule policies |
Updated 11 days ago
