List Payroll Payments | SalaryBox

{
  "message": "Success",
  "status": true,
  "data": [
    {
      "payments": [
        {
          "payment_type": "advance",
          "amount": "5000.00",
          "payment_date": "2026-10-18",
          "created_on": "2026-10-18T16:05:11+05:30",
          "period_from": null,
          "period_to": null,
          "payment_mode": "UPI",
          "payment_status": "success",
          "notes": "Festival advance"
        },
        {
          "payment_type": "previous_due",
          "amount": "12000.00",
          "payment_date": "2026-10-01",
          "created_on": "2026-10-01T09:00:00+05:30",
          "period_from": null,
          "period_to": null,
          "payment_mode": null,
          "payment_status": null,
          "notes": "Dues before joining SalaryBox"
        }
      ],
      "salarybox_id": "SBK7Q2M9TX",
      "employee_id": "EMP-0042",
      "name": "Aarav Sharma",
      "branches": [
        "Mumbai HQ"
      ],
      "departments": [
        "Engineering"
      ]
    },
    {
      "payments": [
        {
          "payment_type": "salary",
          "amount": "41200.00",
          "payment_date": "2026-10-05",
          "created_on": "2026-10-05T11:20:45+05:30",
          "period_from": "2026-09-01",
          "period_to": "2026-09-30",
          "payment_mode": "NEFT",
          "payment_status": "processing",
          "notes": null
        }
      ],
      "salarybox_id": "SBK3H8D1LP",
      "employee_id": "EMP-0043",
      "name": "Meera Nair",
      "branches": [
        "Mumbai HQ"
      ],
      "departments": [
        "Finance"
      ]
    }
  ],
  "count": 2,
  "prev": null,
  "next": null
}

Returns every salary payment, advance and opening balance (dues from before the staff member joined SalaryBox) in a date range of up to 366 days. Requires Payroll Pro. Includes inactive staff.

Grouped by staff member, with payments newest first. Only staff with a payment in the range are listed.

A salary payment falls on its paid date, or the end of its salary period if no paid date was recorded. September’s salary paid on 5 October falls in October.
Failed online payouts are left out; payouts still processing are included as processing.

Authentication

AuthorizationApi-Key

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

Query parameters

start_datedateRequired

First day, YYYY-MM-DD.

end_datedateRequired

Last day, YYYY-MM-DD. The range can cover at most 366 days.

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 staff members with payments in the requested range, each with their payments nested.

messagestring

statusboolean

datalist of objects

countinteger

prevstring or null

nextstring or null

Errors

400

Bad Request Error

403

Forbidden Error