> ## Client identification
>
> Requests to this API should include a `Client-Platform` header alongside
> `Authorization`, identifying the application, tool, or model making the
> request. This is used for integration support and analytics.
>
> Use your model or tool name, for example `claude-code` or `chatgpt`.
>
> Example:
>
> ```bash
> curl https://api.salaryboxapp.com/... \
>   -H "Authorization: Api-Key <api-key>" \
>   -H "Client-Platform: claude-code"
> ```

# List Tax Regimes

GET https://api.salaryboxapp.com/v2/customer/v1/payroll/config/tax

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.


Reference: https://docs.salarybox.in/api-reference/payroll/config-tax-retrieve

## Authentication

- `Authorization` header (required) (prefixed with ` Api-Key   `) — Format: "Api-Key \{api-key}"

## Request

### Query parameters

- `financial_year` (integer, optional) — Year the financial year starts in: `2026` means April 2026 to March 2027. Defaults to the current financial year.
- `salarybox_ids` (list of string, optional) — Repeatable. Limits the result to these staff members, for example `salarybox_ids=SBK7Q2M9TX&salarybox_ids=SBK3H8D1LP`.
- `page` (integer, optional) — Page number, starting at 1.
- `page_size` (integer, optional) — Results per page. Default and maximum 50.

## Response

### 200

One row per matching staff member on this page.

- `data` (list of EmployeeTaxRegime, required)
- `message` (string, optional)
- `status` (boolean, optional)
- `count` (integer, optional) — Total number of results across all pages.
- `prev` (string, optional, nullable) — URL of the previous page, or null.
- `next` (string, optional, nullable) — URL of the next page, or null.

## Errors

### 400 Bad Request Error

A parameter is invalid. `financial_year` must be between 2000 and 2100.

- `message` (string, required)
- `status` (boolean, required)
- `errors` (map from string to any, optional, nullable)

### 403 Forbidden Error

Your plan does not include payroll.

- `message` (string, required)
- `status` (boolean, required)
- `errors` (map from string to any, optional, nullable)

## Types

### EmployeeTaxRegime

Identity fields shared by per-employee payroll responses.

- `financial_year` (integer, required) — Starting year of the financial year, so 2026 means April 2026 to March 2027.
- `regime` (enum, required) — The income-tax regime in use.
  - Allowed values: `old`, `new`
- `is_default` (boolean, required) — `true` when the staff member has no saved tax setup for the year. `regime` is then `new`, the one SalaryBox applies.
- `chosen_by_staff` (boolean, required) — `true` when the staff member picked the regime themselves.
- `salarybox_id` (string, optional) — SalaryBox ID of the staff member. Not null.
- `employee_id` (string, optional) — The employee ID your company assigned. Not null, may be empty.
- `name` (string, optional) — Full name of the staff member. Not null.
- `branches` (list of string, optional) — Names of the branches the staff member belongs to. Empty list if none.
- `departments` (list of string, optional) — Names of the departments the staff member belongs to. Empty list if none.
- `previous_employer_salary` (string, optional, nullable) — Salary from a previous employer this year, with 2 decimals.
- `previous_employer_tds` (string, optional, nullable) — TDS already deducted by a previous employer this year, with 2 decimals.

## Examples

**Response**

```json
{
  "data": [
    {
      "financial_year": 2026,
      "regime": "old",
      "is_default": false,
      "chosen_by_staff": true,
      "salarybox_id": "SBK7Q2M9TX",
      "employee_id": "EMP-031",
      "name": "Ravi Kumar",
      "branches": [
        "Pune Plant"
      ],
      "departments": [
        "Sales"
      ],
      "previous_employer_salary": "180000.00",
      "previous_employer_tds": "12000.00"
    }
  ],
  "message": "Success",
  "status": true,
  "count": 1,
  "prev": null,
  "next": null
}
```

**SDK Code**

```python Example
import requests

url = "https://api.salaryboxapp.com/v2/customer/v1/payroll/config/tax"

querystring = {"financial_year":"2026"}

headers = {"Authorization": "Api-Key  <apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript Example
const url = 'https://api.salaryboxapp.com/v2/customer/v1/payroll/config/tax?financial_year=2026';
const options = {method: 'GET', headers: {Authorization: 'Api-Key  <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.salaryboxapp.com/v2/customer/v1/payroll/config/tax?financial_year=2026"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Api-Key  <apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Example
require 'uri'
require 'net/http'

url = URI("https://api.salaryboxapp.com/v2/customer/v1/payroll/config/tax?financial_year=2026")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Api-Key  <apiKey>'

response = http.request(request)
puts response.read_body
```

```java Example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.salaryboxapp.com/v2/customer/v1/payroll/config/tax?financial_year=2026")
  .header("Authorization", "Api-Key  <apiKey>")
  .asString();
```

```php Example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.salaryboxapp.com/v2/customer/v1/payroll/config/tax?financial_year=2026', [
  'headers' => [
    'Authorization' => 'Api-Key  <apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Example
using RestSharp;

var client = new RestClient("https://api.salaryboxapp.com/v2/customer/v1/payroll/config/tax?financial_year=2026");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Api-Key  <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Example
import Foundation

let headers = ["Authorization": "Api-Key  <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.salaryboxapp.com/v2/customer/v1/payroll/config/tax?financial_year=2026")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```