List Overtime Settings | SalaryBox

{
  "message": "Success",
  "status": true,
  "data": [
    {
      "salarybox_id": "SBK7Q2M9TX",
      "employee_id": "EMP-0042",
      "name": "Aarav Sharma",
      "branches": [
        "Bengaluru HQ"
      ],
      "departments": [
        "Sales"
      ],
      "config": {
        "per_hour_amount_type": "custom",
        "per_hour_amount": "150.00",
        "hourly_grace_period": "00:30:00",
        "week_off_per_day_amount_type": "multipler",
        "week_off_per_day_amount": "1.50",
        "public_holiday_per_day_amount_type": "multipler",
        "public_holiday_per_day_amount": "2.00"
      }
    },
    {
      "salarybox_id": "SBR4T8W2PL",
      "employee_id": "EMP-0063",
      "name": "Rohan Verma",
      "branches": [
        "Pune Plant"
      ],
      "departments": [],
      "config": null
    }
  ],
  "count": 2,
  "prev": null,
  "next": null
}

Returns each staff member’s overtime pay settings. Requires Payroll Pro. config is null when none exist; overtime is then paid at 0.

Normal days: overtime beyond hourly_grace_period is paid at per_hour_amount per hour.
Week offs and public holidays: working the day is paid at week_off_per_day_amount or public_holiday_per_day_amount per day.
Each amount type is custom (money) or multipler (a multiple of the staff member’s hourly or daily salary, for example 2.00 for double pay).

For the day-by-day result, use Get Staff Overtime.

Authentication

AuthorizationApi-Key

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

Query parameters

salarybox_idslist of stringsOptional

Repeatable. Limits the result to these staff members, for example salarybox_ids=SBK7Q2M9TX&salarybox_ids=SBK3H8D1LP.

pageintegerOptional

Page number, starting at 1.

page_sizeintegerOptional

Results per page. Default and maximum 50.

Response

One row per matching staff member on this page.

messagestring

statusboolean

datalist of objects

countinteger

Total number of matching staff members across all pages.

prevstring or null

URL of the previous page, or null on the first page.

nextstring or null

URL of the next page, or null on the last page.

Errors

403

Forbidden Error

404

Not Found Error