CST
Introduction
This API allows you to search for a specific CST (Central Sales Tax) number of a company associated with your patron ID. The CST number is a unique identifier used in India to track sales tax on inter-state sales of goods.
Sample CURL
curl --request POST \
--url https://signzy.tech/api/v2/patrons/..your-patron-id../csts \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'Authorization: <Access-Token>' \
--header 'content-type: application/json' \
--data '{"essentials":{"cstNumber":".....company'\''s-cst-to-search-for...."}}'Parameter | Type | Required | Description |
|---|---|---|---|
url | string | Yes | The URL to make the request to, with {patron-id} replaced with the unique identifier of the patron making the request. |
Accept | string | No | The MIME type(s) of the response that the client can understand. |
Accept-Language | string | No | The preferred language for the response. |
Authorization | string | Yes | A valid Access-Token obtained through the authentication process. |
content-type | string | Yes | The MIME type of the request body. |
cstNumber | string | Yes | The CST (Central Sales Tax) number of the company to search for, provided as a value in a JSON object under the essentials key. |
Sample API Response
{
"essentials": {
"cstNumber": "...cstNumber..."
},
"id": "...accessToken...",
"patronId": "...patronId...",
"result": {
"cstStatus": "...cstStatus...",
"pan": "...pan...",
"status": "...status...",
"ownerName": "...ownerName...",
"dealer": "...dealer...",
"address": "...address...",
"regDate": "...regDate...",
"cancelDate": "...cancelDate...",
"splitAddress": {
"district": [
"...district..."
],
"state": [
[
"...state..."
]
],
"city": [
"...city..."
],
"pincode": "...pincode...",
"country": [
"IN",
"IND",
"INDIA"
],
"addressLine": "...addressLine...",
}
}
}Parameter | Description |
|---|---|
essentials.cstNumber | The CST number of the company being searched for. |
id | The Access Token used for authentication. |
patronId | The unique identifier of the patron making the request. |
result.cstStatus | The status of the CST number, e.g. "Active" or "Cancelled". |
result.pan | The PAN (Permanent Account Number) associated with the company. |
result.status | The status of the company, e.g. "Active" or "Cancelled". |
result.ownerName | The name of the company owner. |
result.dealer | The dealer type of the company, if applicable. |
result.address | The full address of the company. |
result.regDate | The date the company was registered. |
result.cancelDate | The date the company was cancelled, if applicable. |
result.splitAddress.district | The district(s) where the company is located. |
result.splitAddress.state | The state(s) where the company is located. |
result.splitAddress.city | The city where the company is located. |
result.splitAddress.pincode | The PIN code of the company's location. |
result.splitAddress.country | The country where the company is located, represented as a list of possible values. |
result.splitAddress.addressLine | The street address of the company's location. |