Search GST TaxPayer API
API Method: GET
URL: https://gstapi.charteredinfo.com/commonapi/v1.1/search
Headers Parameters
|
Property
|
Description
|
Data Type
|
|
aspid
|
AspUserId provided by GSP.
|
String
|
|
password
|
Password of ASP Account.
|
String
|
Query Parameters
|
Property
|
Description
|
Data Type
|
|
action
|
"TP" - set to value TP for Search TaxPayer Action.
|
String
|
|
gstin
|
GSTIN of API Caller (under which API would be Loged).
|
String
|
|
searchgstin
|
GSTIN of TaxPayer to Search for.
|
String
|
Sample for URL Based API:
https://gstapi.charteredinfo.com/commonapi/v1.1/search?Action=TP&Gstin=CallerGstin&SearchGstin=GSTINOfTaxPayerToSearch
Header Parameter : aspid=ASPID, password : {ASPAcPassword}
Response to the Search GST TaxPayer API Call will be as below
|
Search TaxPayer
|
|
Details
|
Respective Key (Item)
|
Response Sample
|
|
Registration Date
|
rgdt:
|
01/07/2017
|
|
Company Type
|
ctb:
|
Private Limited Company/ Limited Company..
|
|
Constitution of Business
|
sts:
|
Active/ Inactive
|
|
Legal Name
|
lgnm:
|
ABC Corporation LTD.
|
|
State Jurisdiction
|
stj:
|
Jalandhar
|
|
GSTIN
|
gstin:
|
11AAAAA2222Q1Z2
|
|
Nature of Business Activity
|
nba:
|
Recipient of Goods or Services/Wholesale Business
|
Method in TaxProGST.API Lib:
public async static Task<TxnRespWithObj<SearchTaxpayerJson>> SearchTaxPayerAsync(APISession ApiSession, string SearchGSTIN)
public async static Task<TxnRespWithObj<SearchTaxpayerJson>> SearchTaxPayerAsync(string ASPID, string ASPPassword, string GSTIN, string SearchGSTIN)
Note: If you are using "SearchTaxPayer" User Control and setting "DatabaseContext" Property, it will catch TaxPayer's Info in table "GSTINInfoCache".
