Ready-made API endpoints to connect accounting, payroll and reporting systems with employee, voucher, expense and payroll data. Each token is tied to a specific company and tenant to ensure complete data isolation.
Use the Bearer Token issued from the dashboard.
Each tenant creates their own token from the dashboard, then uses it in their external system.
All protected requests need a header named Authorization.
The following endpoints are ready to connect with external systems.
| Method | Path | Description | Main filters |
|---|---|---|---|
| GET | /api/v1/health | API health check | - |
| GET | /api/v1/company | Company/tenant data linked to the token | - |
| GET | /api/v1/hr/employees | Employee list | search, status, department, iqama_expiring, iqama_expired, per_page |
| GET | /api/v1/hr/employees/{id} | Employee details with documents | - |
| GET | /api/v1/accounting/summary | Financial and operational summary | - |
| GET | /api/v1/accounting/vouchers | General vouchers and employee vouchers | party_type, type, status, from, to, per_page |
| GET | /api/v1/accounting/expenses | Expenses | status, category, from, to, per_page |
| GET | /api/v1/accounting/payrolls | Payroll runs | status, month, per_page |
These are the most commonly used fields when integrating with accounting and HR systems.
Ready-made samples the tech team can use directly.
All responses are returned in JSON format to make integration easier.