List Payroll History | SalaryBox

{
  "message": "Success",
  "status": true,
  "data": [
    {
      "months": [
        {
          "month": "2026-09",
          "is_computed": true,
          "is_finalized": true,
          "net_salary": "48250.00",
          "advance_paid": "5000.00",
          "total_paid": "48250.00",
          "remaining_balance": "0.00",
          "computed_till": "2026-09-30",
          "computed_on": "2026-10-01T10:42:18+05:30"
        },
        {
          "month": "2026-10",
          "is_computed": true,
          "is_finalized": false,
          "net_salary": "47900.00",
          "advance_paid": "0.00",
          "total_paid": "20000.00",
          "remaining_balance": "27900.00",
          "computed_till": "2026-10-29",
          "computed_on": "2026-10-29T09:15:03+05:30"
        }
      ],
      "salarybox_id": "SBK7Q2M9TX",
      "employee_id": "EMP-0042",
      "name": "Aarav Sharma",
      "branches": [
        "Mumbai HQ"
      ],
      "departments": [
        "Engineering"
      ]
    },
    {
      "months": [
        {
          "month": "2026-09",
          "is_computed": false,
          "is_finalized": false,
          "net_salary": null,
          "advance_paid": null,
          "total_paid": null,
          "remaining_balance": null,
          "computed_till": null,
          "computed_on": null
        },
        {
          "month": "2026-10",
          "is_computed": false,
          "is_finalized": false,
          "net_salary": null,
          "advance_paid": null,
          "total_paid": null,
          "remaining_balance": null,
          "computed_till": null,
          "computed_on": null
        }
      ],
      "salarybox_id": "SBK3H8D1LP",
      "employee_id": "EMP-0057",
      "name": "Priya Nair",
      "branches": [
        "Bengaluru"
      ],
      "departments": [
        "Sales"
      ]
    }
  ],
  "count": 2,
  "prev": null,
  "next": null
}

Returns each staff member’s saved payroll results month by month: net salary, amount paid, amount due and whether the month was finalized. Requires Payroll Pro. Includes inactive staff.

This endpoint never computes payroll. A month nobody has computed yet is listed with is_computed: false and null amounts. Where a month has both a finalized and a later computation, the finalized figures are shown, as in the app.

Every month from from_month to to_month (at most 12), oldest first.

Authentication

AuthorizationApi-Key

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

Query parameters

from_monthstringRequiredformat: "^\d{4}-(0[1-9]|1[0-2])$"

First month, YYYY-MM.

to_monthstringRequiredformat: "^\d{4}-(0[1-9]|1[0-2])$"

Last month, YYYY-MM. At most 11 months after from_month, and not in the future.

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

The payroll history for the requested months.

messagestring

statusboolean

datalist of objects

countinteger

prevstring or null

nextstring or null

Errors

400

Bad Request Error

403

Forbidden Error