Pay Rates API Released

Introducing the Pay Rates API — a new set of endpoints to manage employee pay rates programmatically, enabling seamless payroll integration and automated compensation management.

New Endpoints

• GET /pay-rates/v1/pay-rates — Retrieve pay rates for one or more users within a date range, with filtering by rate type and resource IDs
• PUT /pay-rates/v1/pay-rates — Create or update pay rates for up to 500 users in a single bulk request
• DELETE /pay-rates/v1/pay-rates/users/USERID/{effectiveDate} — Delete a specific pay rate entry by user and effective date

Key Features

• Flexible Rate Types: Support for hourly, monthly, and yearly rate configurations
• Resource-Specific Rates: Assign custom rates per job/resource, with optional sub-resource rate inheritance
• Bulk Operations: Update pay rates for up to 500 users in a single request
• Modification History: Track all pay rate changes over time with the isIncludeHistory parameter
• Locked Days Protection: Built-in validation prevents modifications that would affect approved or locked timesheet days

OAuth Scopes

• pay_rates.read — required for GET endpoints
• pay_rates.write — required for PUT endpoints
• pay_rates.delete — required for DELETE endpoints

For more details, see the Pay Rates Guide and the API Reference.