> ## Client identification > > Requests to this API should include a `Client-Platform` header alongside > `Authorization`, identifying the application, tool, or model making the > request. This is used for integration support and analytics. > > Use your model or tool name, for example `claude-code` or `chatgpt`. > > Example: > > ```bash > curl https://api.salaryboxapp.com/... \ > -H "Authorization: Api-Key " \ > -H "Client-Platform: claude-code" > ``` # Which endpoint do I need? Find what you want to do, then use the endpoint next to it. Paths are relative to `https://api.salaryboxapp.com/v2/customer/v1`. ## Company Your company's setup and account. | I want to… | Use | | ----------------------------------------------------------------------- | --------------------------------------------------------- | | Read the company name, owner, GST number or time zone | Get Company Profile `/company/` | | Turn branch names into the IDs the staff filters need | List Branches `/company/branch` | | Turn department names into IDs | List Departments `/company/department` | | Read extra staff profile fields, such as shirt size | List Custom Fields `/company/custom-fields` | | Check the plan, expiry, staff limit, add-ons or an upcoming renewal | Get Company Subscription `/company/subscription` | | See how the company moved between plans over time | List Subscription History `/company/subscription/history` | | Reconcile wallet top-ups and spends, or read the current wallet balance | List Wallet Ledger `/company/wallet/ledger` | ## Staff Who works for you, and people asking to join. | I want to… | Use | | ------------------------------------------------------------------- | --------------------------------------------------------------- | | Sync the current staff directory | List Staff `/staff/` | | Refresh one person's profile, role or permissions | Get Staff Member `/staff/fetch-employee` | | Find who left, and when | List Inactive Staff `/staff/inactive` | | Find the account owners | List Admins `/staff/admin` | | Read previous employers, for example for background checks | List Employment History `/staff/employment-history` | | Bring HR notes into another system | List Staff Notes `/staff/notes` | | See who can use Location Tracking or CRM | List Add-on Permissions `/staff/addon-permissions` | | See who is waiting to join through the joining link or company code | List New Joinee Requests `/pending-requests/new-joinees` | | See who asked to register a new phone for attendance | List Device Mapping Requests `/pending-requests/device-mapping` | ## Attendance Who worked, when and how. | I want to… | Use | | ---------------------------------------------------------------------------------- | -------------------------------------------------------------- | | A status grid (present, absent, leave…) per person per day, with daily head counts | List Daily Attendance `/attendance/daily` | | One row of monthly totals per person, for example for payroll | List Attendance Muster `/attendance/muster` | | Punch times, hours worked, late arrival, early leaving or overtime per day | List Attendance Timesheets `/attendance/timesheet` | | Who is at work right now | List Attendance Timesheets `/attendance/timesheet` | | Every individual punch | List Punches `/attendance/time-entry` | | Who is scheduled for which shift, or off, on a date | List Staff Schedules `/attendance/schedules` | | How each person marks attendance, and why a day became present or half day | List Staff Attendance Settings `/attendance/employee-settings` | | The company's shifts, breaks or holidays | List Shifts, List Breaks, List Holidays | ## Payroll Salaries, payments and pay rules. Requires Payroll Pro, except the reimbursement endpoints. | I want to… | Use | | ------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | Each person's salary (CTC) setup | List Staff CTC `/payroll/fetch-employee-ctc` | | Earnings, deductions and net pay for a month, including final settlements | List Salary Breakdowns `/payroll/fetch-salary-breakdown` | | Total salary or advance paid per person in a month | List Salary Paid, List Advances Paid | | Every individual payment, for example to match bank statements | List Payroll Payments `/payroll/payments` | | What was paid and what is still due over several months | List Payroll History `/payroll/history` | | The company's payroll totals for a month | Get Payroll Summary `/payroll/summary` | | One person's overtime as payroll pays it | Get Staff Overtime `/payroll/overtime` | | Salary cycle and whether week offs and holidays are paid | Get Payroll Settings `/payroll/config` | | Late, early leaving or overtime pay rules per person | List Late Fine Settings, List Early Leaving Fine Settings, List Overtime Settings | | Tax declarations staff submitted | List Tax Declarations `/payroll/tax-declarations` | | Reimbursement claims, pending or past | List Reimbursement Requests `/pending-requests/reimbursements` | | Who approves expense claims | List Reimbursement Approval Flows `/payroll/reimbursement-approval-flows` | ## Leave Leave balances, rules and requests. | I want to… | Use | | -------------------------------------------------------------- | ------------------------------------------------- | | How much leave each person has left | List Leave Balances `/leave/balance` | | Allocation and carry-forward rules | List Leave Policies `/leave/policy` | | Leave requests, pending or past, or one person's leave history | List Leave Requests `/pending-requests/leave` | | Who approves leave | List Leave Approval Flows `/leave/approval-flows` | ## Location Where tracked staff are and have been. Requires the Location Tracking add-on. | I want to… | Use | | ---------------------------------------------------- | ---------------------------------------------------- | | Where everyone is now, or was last seen | List Latest Staff Locations `/location/latest` | | The route one person travelled on a day | List Staff Location History `/location/history` | | Who was asked to be tracked, and whether they agreed | List Location Tracking Requests `/location/requests` | ## CRM Field Force CRM activity. Requires the Field Force CRM add-on. | I want to… | Use | | --------------------------------------------------------------------------- | -------------------------------------------- | | Customer visits per person | List CRM Meetings `/crm/meetings` | | Distance and number of trips per person | List CRM Trips `/crm/trips` | | Each trip of a few people, with odometer readings and start and stop places | List CRM Trip Timeline `/crm/trips/timeline` |