If your company manages PTO in an HR, payroll, or other external system, you can use the Rhumbix Public API to send PTO information to Rhumbix for use during timekeeping.
This allows your existing system to remain the source of truth for PTO requests, approvals, and balances while making approved PTO information available in Rhumbix.
New to PTO in Rhumbix? See Paid Time Off (PTO) and Company Holidays in Rhumbix for an overview of how the feature works.
🔄 PTO Available Through the API
The Rhumbix Public API includes endpoints for managing:
PTO Buckets
PTO Bucket Cost Code and Group assignments
Employee PTO balances
Employee PTO requests
Company Holidays
🪣 Manage PTO Buckets
PTO Buckets can be created and updated through the Public API.
When creating a PTO Bucket, specify the bucket name and whether the PTO is recorded using a:
Cost Code
Absence Type
If the bucket uses an Absence Type, the applicable Company Absence Type can also be specified.
For Cost Code-based PTO Buckets, the API also provides endpoints for associating Project Cost Codes with PTO Buckets and configuring default Cost Codes for new Projects through Group assignments.
For complete request requirements and available operations, see the Company PTO Buckets endpoints in the Rhumbix API reference.
💰 Update Employee PTO Balances
Employee PTO balances can be maintained through the Public API, allowing an external HR or payroll system to send current balances to Rhumbix.
This can be useful when another system calculates PTO accruals and maintains the employee's official available balance.
⚠️ Important: Rhumbix does not calculate PTO accruals or automatically deduct PTO when an employee uses time off. Updated balances must be maintained outside of Rhumbix and can be sent to Rhumbix through the Public API.
For complete request requirements, see the applicable Employees PTO endpoint in the Rhumbix API reference.
🌴 Manage Employee PTO Requests
Employee PTO Requests can be created, retrieved, updated, and deleted through the Public API.
This allows an approved PTO request from another system to be sent to Rhumbix so the scheduled time off is available during timekeeping.
When creating a PTO Request, you can provide:
Employee
Company PTO Bucket
Start Date
End Date
Number of Hours
The API also supports an optional user-facing label for the PTO Request.
Once the PTO Request is in Rhumbix, it appears in Weekly View for the scheduled date and can be fulfilled and added to the employee's timecard.
➡️ For step-by-step instructions, see Use PTO and Company Holidays in Weekly View.
💡 Note: Creating a PTO Request through the API does not create an approval workflow in Rhumbix. PTO should be approved through your company's normal process before the approved request is sent to Rhumbix.
🎉 Manage Company Holidays
Company Holidays can also be managed through the Public API.
A Company Holiday configuration can include:
Name and description
PTO Bucket
Holiday dates, names, and paid hours
Cohorts
Unions
Custom Fields
This allows companies with externally managed Holiday schedules to create and maintain those schedules in Rhumbix programmatically.
For complete request requirements and available operations, see the Company Holidays endpoints in the Rhumbix API reference.
🔗 Example PTO Workflow
A company using an HR or payroll system as its PTO source of truth might use the API as part of the following workflow:
An employee requests PTO in the company's existing system.
The PTO request is approved through the company's normal process.
The approved PTO Request is sent to Rhumbix through the Public API.
Rhumbix displays the PTO Request in Weekly View for the scheduled date.
The PTO is fulfilled and added to the employee's timecard.
The employee's updated PTO balance is sent back to Rhumbix from the source system.
This allows the company to continue managing PTO approvals and balances in its existing system while using the PTO information during timekeeping in Rhumbix.
📚 API Reference
For endpoint URLs, request formats, required fields, response codes, and other technical implementation details, refer to the Rhumbix Public API documentation.
Need Help?
If you have questions about using PTO or Company Holidays in Rhumbix, contact Rhumbix Support at support@rhumbix.com for assistance.