Added
Pay Rule Policies: Compose, list assignments, and unassign
1 day ago by ReadMe API
You can now compose pay rule policies and unassign employees through the Company Policies API, not only list policies and assign a user.
A pay rule policy is the pay structure Time Clock uses: regular hours plus overtime, premiums, and differentials. Create the reusable rules in the dashboard. Use these endpoints to see what a policy contains, add or remove a rule, list who is on it, and take someone off. The Connecteam agent uses the same surface to help admins attach the right pay structure during setup.
New Endpoints
GET /company-policies/v1/pay-rules— List reusable pay rules in the accountPUT /company-policies/v1/pay-rule-policies/{payRulePolicyId}/pay-rules/{payRuleId}— Add an existing pay rule to a policyDELETE /company-policies/v1/pay-rule-policies/{payRulePolicyId}/pay-rules/{payRuleId}— Remove a pay rule from a policyGET /company-policies/v1/pay-rule-policies/{payRulePolicyId}/assignments— List assignments in effect on a dateDELETE /company-policies/v1/pay-rule-policies/{payRulePolicyId}/assignments/{assignmentId}— Remove one assignment
Updates to existing endpoints
GET /company-policies/v1/pay-rule-policiesnow returnsisDefaultForNewUsersandpayRules(idandname). Existingidandnamefields are unchanged.PUT .../assignmentsnow rejects a change that would touch approved or locked timesheet days.
Key Features
- See what you are assigning: each policy lists the pay rules it is made of
- Compose from existing rules: adding a regular rule replaces the current one. The regular rule cannot be removed
- Effective-dated assign and unassign: list who is on the policy on a given date, then remove one assignment by id
- Connecteam agent: the agent uses these endpoints to look up policies and attach people during setup
Authentication
- API Key (
X-API-KEYheader), or - OAuth 2.0 with
company_policies.read,company_policies.write, orcompany_policies.delete
Requires the Time Clock API plan limitation.
For full details and examples, see the Pay Rule Policies guide.
