Skip to navigation

Get Staff Overtime

Returns one staff member’s overtime for one payroll month, day by day: hours or days, rate and amount, plus the month’s totals. The figures are the ones payroll pays. Requires Payroll Pro. One staff member per call; inactive staff can be fetched.

  • The period is the payroll month’s attendance period (attendance_from_date to attendance_to_date), which follows your salary cycle.
  • overtime_type is HOUR for time worked beyond the shift on a normal day, or DAY for working on a week off or public holiday (1 day, or 0.5 for a half day).
  • Hour-wise overtime within the grace period in Overtime Settings is not paid (it shows 0.00).
  • A day an admin edited in payroll (is_saved_by_admin) uses the admin’s value; actual_overtime_hours shows the hours from attendance.
  • For a finalized month (is_finalized: true), the rates saved with that payroll are used.
  • days lists only days with overtime.

Errors

  • 400 "month cannot be in the future".
  • 400 "No salary structure (CTC) is set for this employee".
  • 400 "Payroll settings are not set up for this company".
  • 404 "Employee not found".

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

salarybox_idstringRequired
SalaryBox ID of the staff member. One ID per request.
monthstringRequiredformat: "^\d{4}-(0[1-9]|1[0-2])$"

Payroll month, YYYY-MM. Not later than the current month.

Response

The staff member's overtime for the month.
messagestring
statusboolean
dataobject

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error