Skip to navigation

List Tax Summaries

Returns each staff member’s yearly income-tax (TDS) projection under both regimes, as of the last payroll computation. Requires Payroll Pro. Includes inactive staff.

  • This does not recompute payroll. Run Get Payroll Summary first for fresh figures.
  • When TDS was never computed for the year, is_computed is false and the regime figures are null.

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