One endpoint. Every action.

List companies.

Create a company.

Update a company by id.

Delete a company by id.

List business units.

Create a businessUnit.

Update a businessUnit by id.

Delete a businessUnit by id.

List locations / branches.

Create a location.

Update a location by id.

Delete a location by id.

List cost centers.

Create a costCenter.

Update a costCenter by id.

Delete a costCenter by id.

List departments.

Create a department.

Update a department by id.

Delete a department by id.

List teams.

Create a team.

Update a team by id.

Delete a team by id.

List designations.

Create a designation.

Update a designation by id.

Delete a designation by id.

List grades.

Create a grade.

Update a grade by id.

Delete a grade by id.

List employee categories.

Create a employeeCategory.

Update a employeeCategory by id.

Delete a employeeCategory by id.

List employment types.

Create a employmentType.

Update a employmentType by id.

Delete a employmentType by id.

List holiday calendars.

Create a holidayCalendar.

Update a holidayCalendar by id.

Delete a holidayCalendar by id.

List holidays.

Create a holiday.

Update a holiday by id.

Delete a holiday by id.

Return the org chart as a tree — department hierarchy or reporting lines.

Rename the current organization.

List matrix reporting lines for an employee or manager.

Add a matrix / dotted-line reporting relationship.

Remove a matrix reporting line by id.

List HR policies.

Create a hrPolicy.

Update a hrPolicy by id.

Acknowledge an HR policy (records the version you accepted).

List who has acknowledged a policy.

Delete a hrPolicy by id.

List / search employees.

Get one employee by id.

Create an employee record.

Update an employee record by id.

Record a demotion: change grade/designation and log the event.

Record a promotion: change grade/designation and log the event.

List employee addresses.

Create a employeeAddress.

Update a employeeAddress by id.

Delete a employeeAddress by id.

List emergency contacts.

Create a employeeContact.

Update a employeeContact by id.

Delete a employeeContact by id.

List dependents.

Create a employeeDependent.

Update a employeeDependent by id.

Delete a employeeDependent by id.

List employee signatures.

Create a employeeSignature.

Update a employeeSignature by id.

Delete a employeeSignature by id.

List an employee's bank accounts (account numbers masked).

Add a bank account for an employee (account number stored encrypted).

Delete an employee bank account by id.

List an employee's documents (numbers masked).

Attach a document (passport, visa, PAN, etc.) to an employee.

Update a document's metadata (not its number — delete + recreate to change that).

Reject an employee document (approval decision).

Mark an employee document as verified.

Get an employee's tax profile (tax number masked).

Set an employee's tax profile (tax number stored encrypted).

List an employee's statutory tax codes (values masked).

Add/replace a statutory tax code (PAN, SSN, …) — type validated per country, value encrypted.

List an employee's employment history events.

List the people in the current organization.

List attendance records for an employee / date range.

Per-day attendance calendar (roster + actuals + approved leave) for an employee.

Check in (server time + optional GPS/QR/NFC; geofence enforced if configured).

Check out (geofence enforced if configured).

Request a correction to an attendance record.

Check in via face recognition (self only; verifies your face + enforces geofence).

Check out via face recognition (self only; verifies your face + enforces geofence).

Worked + overtime minutes per employee over a period (all employees for managers, self otherwise).

List registered devices (never exposes the key).

No request fields.

Deactivate a device (its key stops working).

Register a biometric/punch device. Returns the device key once — store it; only the hash is kept.

Issue a QR code for a site (returns the code to render as a QR).

Deactivate a site QR code.

List geofences.

Create a geofence.

Update a geofence by id.

Delete a geofence by id.

List NFC tags.

Create a nfcTag.

Update a nfcTag by id.

Delete a nfcTag by id.

List face enrollments (self unless you can manage attendance). Never returns the template.

Enroll YOUR OWN face descriptor (128-d, extracted client-side by face-api.js).

Delete a face enrollment (your own, or any if you can manage attendance).

List biometric enrollments.

Create a biometricEnrollment.

Update a biometricEnrollment by id.

Delete a biometricEnrollment by id.

List shifts.

Create a shift.

Update a shift by id.

Delete a shift by id.

List shift groups.

Create a shiftGroup.

Update a shiftGroup by id.

Delete a shiftGroup by id.

List shift segments.

Create a shiftSegment.

Update a shiftSegment by id.

Delete a shiftSegment by id.

List shift assignments.

Create a shiftAssignment.

Update a shiftAssignment by id.

Delete a shiftAssignment by id.

List shift swaps that involve you (or all, if you can manage attendance).

Request to swap one of your rostered shifts with a colleague's.

Accept or decline a shift-swap request addressed to you.

Cancel a swap you requested (before it has been accepted).

List bids for an open shift (manager) or your own bids.

Award an open shift to one of its bidders.

Bid on an open rostered shift.

Withdraw your bid on an open shift.

List the roster (self unless you can manage attendance).

Roster a shift to an employee on a date.

Cancel a rostered shift by id.

Post an OPEN shift (unassigned) that employees can bid on.

List rotation patterns.

Create a rotationPattern.

Update a rotationPattern by id.

Delete a rotationPattern by id.

List rotation steps.

Create a rotationStep.

Update a rotationStep by id.

Delete a rotationStep by id.

List rotation assignments.

Create a rotationAssignment.

Update a rotationAssignment by id.

Delete a rotationAssignment by id.

Auto-generate the roster for a date range from rotation patterns. mode 'fill' adds missing days (idempotent); 'replace' re-stamps this generator's own rows so a pattern edit propagates.

Request overtime approval for a date.

List leave requests (optionally filtered by employee/status).

Leave utilization per type + request breakdown for a year (self unless you can manage leave).

Approved leave overlapping a date range (who's off when).

Request to encash unused leave (routes through approval; balance settled at payroll).

Request leave (for yourself, or for an employee if you manage leave).

Revoke an approved leave and return the consumed days.

Cancel a pending leave request.

List leave types.

Create a leaveType.

Update a leaveType by id.

Delete a leaveType by id.

List leave blackouts.

Create a leaveBlackout.

Update a leaveBlackout by id.

Delete a leaveBlackout by id.

List an employee's leave balances.

Allocate (grant) leave balance to an employee for a year.

List leave-encashment requests (self unless you can manage leave).

List comp-off grants (self unless you can manage leave).

Grant compensatory-off days to an employee (into a comp-off leave type).

Add an ad-hoc earning (bonus/incentive/variable pay) or deduction (garnishment) line to a draft/preview run. Recalculate afterwards.

Approve a calculated run (maker-checker) — records the approver; required before finalize.

Generate the bank-advice payout file (NEFT CSV or NACH fixed-width) for a finalized run. No money moves — this is an export.

Calculate (preview) all payslips for a run — recalc-safe, no ledger posting yet.

Statutory compliance rollup for a FINALIZED run — per-employee amounts + totals for PF (ECR), ESI, Professional Tax, or TDS (Form 24Q).

Compute retro/arrears for an employee: the delta of the current (as-of-period) salary vs what was actually paid in prior locked runs, staged as ARREARS earning input(s) on a draft/preview run.

Stage full & final settlement for a leaver on an fnf run: statutory gratuity + approved leave encashment as earning inputs. Calculate then prorates salary to the exit date and recovers the full loan outstanding; add notice-pay/dues via addRunInput.

Create a payroll run for a company + period (draft).

Post an APPROVED run to the hash-chained ledger and lock it (immutable).

Generate + store PDF payslips for every payslip in a finalized (locked) run.

List ad-hoc input lines for a run.

List payroll runs.

Payroll register for a run: every payslip with earnings/deductions/employer breakdown + cost-to-company and grand totals.