Skip to navigation
API ReferencePayroll

List Tax Regimes

Returns each staff member’s income-tax regime for a financial year, plus salary and TDS from a previous employer that year. Requires Payroll Pro. Includes inactive staff.

  • Unlike the app, this never creates a tax setup for a staff member. With no saved setup, is_default is true and regime is new, the regime SalaryBox applies.

Authentication

AuthorizationApi-Key

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

Query parameters

financial_yearintegerOptional

Year the financial year starts in: 2026 means April 2026 to March 2027. Defaults to the current financial year.

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.
datalist of objects
messagestringOptional
statusbooleanOptional
countintegerOptional
Total number of results across all pages.
prevstring or nullOptional
URL of the previous page, or null.
nextstring or nullOptional
URL of the next page, or null.

Errors

400
Bad Request Error
403
Forbidden Error