> ## 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 PT and LWF Rule Categories

GET https://api.salaryboxapp.com/v2/customer/v1/payroll/config/rule-categories

Returns the state-wise Professional Tax and Labour Welfare Fund rule categories. They are used when PT/LWF rule categories are switched on for your company. Requires Payroll Pro. Not paginated, no parameters.

- When `enabled` is `false`, both lists are empty.
- `deduction_months` are month numbers, 1 for January to 12 for December.
- LWF contributions are the statutory amounts for each deduction, as 2-decimal strings.


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

## Authentication

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

## Response

### 200

Rule categories by state.

- `message` (string, required)
- `status` (boolean, required)
- `data` (PayrollRuleCategoriesResponseData, required)

## Errors

### 403 Forbidden Error

Your plan does not include payroll.

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

## Types

### PayrollRuleCategoriesResponseData

- `enabled` (boolean, required) — Whether rule categories are switched on for the company. When `false`, both lists are empty.
- `professional_tax` (list of PayrollRuleCategoriesResponseDataProfessionalTaxItems, required)
- `labour_welfare_fund` (list of PayrollRuleCategoriesResponseDataLabourWelfareFundItems, required)

### PayrollRuleCategoriesResponseDataProfessionalTaxItems

- `state` (string, required)
- `categories` (list of PayrollRuleCategoriesResponseDataProfessionalTaxItemsCategoriesItems, required)

### PayrollRuleCategoriesResponseDataLabourWelfareFundItems

- `state` (string, required)
- `categories` (list of PayrollRuleCategoriesResponseDataLabourWelfareFundItemsCategoriesItems, required)

### PayrollRuleCategoriesResponseDataProfessionalTaxItemsCategoriesItems

- `value` (string, required)
- `label` (string, required)
- `deduction_months` (list of integer, required)

### PayrollRuleCategoriesResponseDataLabourWelfareFundItemsCategoriesItems

- `value` (string, required)
- `label` (string, required)
- `frequency` (string, required)
- `deduction_months` (list of integer, required)
- `employee_contribution` (string, required) — Statutory amount for each deduction.
- `employer_contribution` (string, required) — Statutory amount for each deduction.

## Examples

**Response**

```json
{
  "message": "Success",
  "status": true,
  "data": {
    "enabled": true,
    "professional_tax": [
      {
        "state": "Tamil Nadu",
        "categories": [
          {
            "value": "chennai_corporation",
            "label": "Chennai Corporation",
            "deduction_months": [
              9,
              3
            ]
          },
          {
            "value": "coimbatore_corporation",
            "label": "Coimbatore Corporation",
            "deduction_months": [
              9,
              3
            ]
          }
        ]
      }
    ],
    "labour_welfare_fund": [
      {
        "state": "Kerala",
        "categories": [
          {
            "value": "commercial_establishments",
            "label": "Shops & Commercial Establishments",
            "frequency": "monthly",
            "deduction_months": [
              1,
              2,
              3,
              4,
              5,
              6,
              7,
              8,
              9,
              10,
              11,
              12
            ],
            "employee_contribution": "50.00",
            "employer_contribution": "50.00"
          }
        ]
      }
    ]
  }
}
```

**SDK Code**

```python Example
import requests

url = "https://api.salaryboxapp.com/v2/customer/v1/payroll/config/rule-categories"

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

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

print(response.json())
```

```javascript Example
const url = 'https://api.salaryboxapp.com/v2/customer/v1/payroll/config/rule-categories';
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/rule-categories"

	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/rule-categories")

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/rule-categories")
  .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/rule-categories', [
  '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/rule-categories");
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/rule-categories")! 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()
```