SalaryBox API Documentation
The SalaryBox Customer API lets you pull staff, attendance, payroll, and leave data directly from your SalaryBox account into your own systems, so you can build reports, dashboards, or integrations without leaving the SalaryBox app to export data by hand.
Authentication
Every request must include your API key in the Authorization header:
Get your API key here.
What’s available
Staff
The employee master directory for your company. This is usually the starting point for any integration, since most other endpoints reference employees by their employee code.
- List Staff returns the full employee directory, with job title, branch and department assignment, contact details, and identity/bank details such as PAN, UAN, and Aadhaar where available.
- List Employee fetches that same record for a single employee by their employee code.
- Device verification requests are pending approvals submitted when an employee tries to register a new phone for biometric or location-based attendance.
Attendance
Everything related to who worked, when, and how.
- List Attendance gives you a day-by-day record for every employee in a date range, including status (present, absent, on leave, half day, and so on) plus a company-wide summary for each day.
- Attendance Master aggregates attendance across a date range into one row per employee, with totals for presence, absences, leaves, overtime, and late arrivals.
- Time Entries are the raw punch-in and punch-out logs, grouped by date and employee, useful when you need the underlying events rather than a computed status.
- Shifts are the work schedules configured for your company (start time, end time, and the punch-in/punch-out windows allowed around them).
- Breaks are the paid or unpaid rest periods employees can log during a shift, each with a configured maximum duration.
- Holidays are the merged national and company holiday calendar for the year.
Payroll
Everything related to compensation and pay runs.
- Payroll summary computes payroll data for a given month, including which employees still need their CTC defined before payroll can run, a breakdown of the company’s payroll numbers, and any active employee loan details.
- Fetch employee CTC returns each employee’s payroll (CTC) configuration for a given month.
- Fetch salary breakdown returns a computed salary breakdown per employee for a given month — earnings, deductions, and net pay.
- Reimbursement requests are claims awaiting approval.
Leave
Everything related to leave types, balances, and requests.
- Leave balances tell you how many days of each leave type an employee has remaining, alongside how many they were originally allotted for the period.
- Leave policies show the configured allocation and carry-forward rules per leave type.
- Leave requests are pending approvals submitted by employees.