Trade Licence Calculator
Trade Licence Calculator APIs
API specs to calculate trade licence fees.
Calculate Trade License Fee based on criteria.
Body
Responses
200
Success response with calculated tax amount.
*/*
400
Error response in case of failures.
*/*
post
POST /_calculate HTTP/1.1
Host: v1
Content-Type: */*
Accept: */*
Content-Length: 3187
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
},
"CalulationCriteria": [
{
"tradelicense": {
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"commencementDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": "text",
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-07-02",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-02",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-02",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-02",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-02",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": {}
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressNumber": "text",
"type": "text",
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": "[Circular Reference]"
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"additionalDetail": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNumber": "text",
"tenantId": "text"
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Calculation": [
{
"applicationNumber": "text",
"totalAmount": 1,
"penalty": 1,
"exemption": 1,
"rebate": 1,
"tenantId": "text"
}
]
}Generates bill for payment.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
applicationNumberstringRequired
Unique Trade application number.
Body
RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.
apiIdstring · max: 128Required
unique API ID
verstring · max: 32Required
API version - for HTTP based request this will be same as used in path
tsinteger · int64Required
time in epoch
actionstring · max: 32Required
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
didstring · max: 1024Optional
Device ID from which the API is called
keystring · max: 256Optional
API key (API key provided to the caller in case of server to server communication)
msgIdstring · max: 256Required
Unique request message id from the caller
requesterIdstring · max: 256Optional
UserId of the user calling
authTokenstringOptional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
correlationIdstringRead-onlyOptional
Responses
200
Success response calculated tax amount.
*/*
400
Error response in case of failures.
*/*
post
POST /_getbill?tenantId=text&applicationNumber=text HTTP/1.1
Host: v1
Content-Type: */*
Accept: */*
Content-Length: 430
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
}{
"id": "text",
"mobileNumber": "text",
"payerName": "text",
"payerAddress": "text",
"payerEmail": "text",
"isActive": true,
"isCancelled": true,
"additionalDetails": {},
"taxAndPayments": [
{
"businessService": "text",
"taxAmount": "text",
"amountPaid": "text"
}
],
"billDetails": [
{
"id": "text",
"tenantId": "text",
"demandId": "text",
"bill": "text",
"businessService": "text",
"billNumber": "text",
"billDate": 1,
"consumerCode": "text",
"consumerType": "text",
"minimumAmount": 1,
"totalAmount": 1,
"fromPeriod": 1,
"toPeriod": 1,
"collectedAmount": 1,
"collectionModesNotAllowed": [
"text"
],
"partPaymentAllowed": true,
"additionalDetails": {},
"billAccountDetails": [
{
"id": "text",
"tenantId": "text",
"billDetail": "text",
"demandDetailId": "text",
"order": 1,
"amount": 1,
"adjustedAmount": 1,
"isActualDemand": true,
"glcode": "text",
"taxHeadCode": "text",
"additionalDetails": {},
"purpose": "ARREAR"
}
],
"status": "CREATED"
}
],
"tenantId": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}Path parameters
servicenamestringRequired
servicename
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /_estimate HTTP/1.1
Host: v1
Content-Type: application/json
Accept: */*
Content-Length: 3187
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
},
"CalulationCriteria": [
{
"tradelicense": {
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"commencementDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": "text",
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-07-02",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-02",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-02",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-02",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-02",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": {}
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressNumber": "text",
"type": "text",
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": "[Circular Reference]"
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"additionalDetail": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNumber": "text",
"tenantId": "text"
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Calculation": [
{
"applicationNumber": "text",
"totalAmount": 1,
"penalty": 1,
"exemption": 1,
"rebate": 1,
"tenantId": "text"
}
]
}Path parameters
servicenamestringRequired
servicename
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /{servicename}/_calculate HTTP/1.1
Host: v1
Content-Type: application/json
Accept: */*
Content-Length: 3187
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
},
"CalulationCriteria": [
{
"tradelicense": {
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"commencementDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": "text",
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-07-02",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-02",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-02",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-02",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-02",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": {}
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressNumber": "text",
"type": "text",
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": "[Circular Reference]"
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"additionalDetail": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNumber": "text",
"tenantId": "text"
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Calculation": [
{
"applicationNumber": "text",
"totalAmount": 1,
"penalty": 1,
"exemption": 1,
"rebate": 1,
"tenantId": "text"
}
]
}Path parameters
servicenamestringRequired
servicename
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /{servicename}/_estimate HTTP/1.1
Host: v1
Content-Type: application/json
Accept: */*
Content-Length: 3187
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
},
"CalulationCriteria": [
{
"tradelicense": {
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"commencementDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": "text",
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-07-02",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-02",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-02",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-02",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-02",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": {}
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressNumber": "text",
"type": "text",
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": "[Circular Reference]"
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"additionalDetail": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNumber": "text",
"tenantId": "text"
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Calculation": [
{
"applicationNumber": "text",
"totalAmount": 1,
"penalty": 1,
"exemption": 1,
"rebate": 1,
"tenantId": "text"
}
]
}Path parameters
servicenamestringRequired
servicename
Query parameters
businessServicestringOptional
consumerCodestringRequired
demandIdstringOptional
emailstringOptional
mobileNumberstringOptional
tenantIdstringRequired
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /{servicename}/_getbill?consumerCode=text&tenantId=text HTTP/1.1
Host: v1
Content-Type: application/json
Accept: */*
Content-Length: 446
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
}
}{
"billResponse": {
"Bill": [
{
"id": "text",
"mobileNumber": "text",
"payerName": "text",
"payerAddress": "text",
"payerEmail": "text",
"isActive": true,
"isCancelled": true,
"additionalDetails": {},
"taxAndPayments": [
{
"businessService": "text",
"taxAmount": "text",
"amountPaid": "text"
}
],
"billDetails": [
{
"id": "text",
"tenantId": "text",
"demandId": "text",
"bill": "text",
"businessService": "text",
"billNumber": "text",
"billDate": 1,
"consumerCode": "text",
"consumerType": "text",
"minimumAmount": 1,
"totalAmount": 1,
"fromPeriod": 1,
"toPeriod": 1,
"collectedAmount": 1,
"collectionModesNotAllowed": [
"text"
],
"partPaymentAllowed": true,
"additionalDetails": {},
"billAccountDetails": [
{
"id": "text",
"tenantId": "text",
"billDetail": "text",
"demandDetailId": "text",
"order": 1,
"amount": 1,
"adjustedAmount": 1,
"isActualDemand": true,
"glcode": "text",
"taxHeadCode": "text",
"additionalDetails": {},
"purpose": "ARREAR"
}
],
"status": "CREATED"
}
],
"tenantId": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"ResposneInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
},
"billingSlabIds": {
"accesssoryBillingSlabIds": [
"text"
],
"consumerCode": "text",
"tradeTypeBillingSlabIds": [
"text"
]
}
}Get the properties list based on the input parameters.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
activeboolean · varcharOptional
True will be set in cases where only active properties are needed and False will be set when inactive properties are needed and no value will be set when all properties are needed.
propertyIdstring · varcharOptional
Primary key of Property object.
assessmentNumberstring · min: 4 · max: 128Optional
The unique reference number for a property.
oldAssessmentNumberstring · min: 4 · max: 128Optional
The unique old assessment no for a Property.
localityinteger · int64Optional
Locality boundary where the property is located.
Body
RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.
apiIdstring · max: 128Required
unique API ID
verstring · max: 32Required
API version - for HTTP based request this will be same as used in path
tsinteger · int64Required
time in epoch
actionstring · max: 32Required
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
didstring · max: 1024Optional
Device ID from which the API is called
keystring · max: 256Optional
API key (API key provided to the caller in case of server to server communication)
msgIdstring · max: 256Required
Unique request message id from the caller
requesterIdstring · max: 256Optional
UserId of the user calling
authTokenstringOptional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
correlationIdstringRead-onlyOptional
Responses
200
Successful response
*/*
400
Invalid input.
*/*
post
POST /_search?tenantId=text HTTP/1.1
Host: billingslab
Content-Type: */*
Accept: */*
Content-Length: 430
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"BillingSlab": [
{
"tenantId": "text",
"id": "text",
"licenseType": "TEMPORARY",
"structureType": "text",
"tradeType": "text",
"accessoryCategory": "text",
"type": "RATE",
"rate": "text",
"uom": "text",
"from": "text",
"to": "text"
}
]
}API to billing slabs for trade license calculation.
Body
Responses
201
Billing Slab(s) created sucessfully
*/*
400
Billing Slab(s) creation failed
*/*
post
POST /_create HTTP/1.1
Host: billingslab
Content-Type: */*
Accept: */*
Content-Length: 656
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
},
"BillingSlab": [
{
"tenantId": "text",
"id": "text",
"licenseType": "TEMPORARY",
"structureType": "text",
"tradeType": "text",
"accessoryCategory": "text",
"type": "RATE",
"rate": "text",
"uom": "text",
"from": "text",
"to": "text"
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"BillingSlab": [
{
"tenantId": "text",
"id": "text",
"licenseType": "TEMPORARY",
"structureType": "text",
"tradeType": "text",
"accessoryCategory": "text",
"type": "RATE",
"rate": "text",
"uom": "text",
"from": "text",
"to": "text"
}
]
}Updates a given billing slab with new properties
Body
tenantIdstring · min: 4 · max: 128Required
Unique ulb identifier
idstring · min: 2 · max: 64Optional
unique identifier of the billing slab uuid
licenseTypestring · enumOptionalPossible values:
LicenseType, is unique enum value for a license
structureTypestring · min: 2 · max: 64Optional
StructureType and Structure subtype, this mdms data.
tradeTypestring · min: 2 · max: 64Optional
value from Trade type master of mdms .
accessoryCategorystring · min: 2 · max: 64Optional
Accessory Category is a master from mdms .
typestring · enumOptionalPossible values:
Type will define the rate value is flat amount or rate.
ratestring · min: 2 · max: 64Optional
Rate of the trade license, this can be the rate of flat amount based on type.
uomstring · min: 2 · max: 32Optional
unit of measurement of trade type.
fromstring · min: 2 · max: 64Optional
uom value lower bound.
tostring · min: 2 · max: 64Optional
uom value upper bound.
Responses
200
Update Billing Slab(s) successful
*/*
400
Update Billing Slab(s) failed
*/*
post
POST /_update HTTP/1.1
Host: billingslab
Content-Type: */*
Accept: */*
Content-Length: 193
{
"tenantId": "text",
"id": "text",
"licenseType": "TEMPORARY",
"structureType": "text",
"tradeType": "text",
"accessoryCategory": "text",
"type": "RATE",
"rate": "text",
"uom": "text",
"from": "text",
"to": "text"
}{
"tenantId": "text",
"id": "text",
"licenseType": "TEMPORARY",
"structureType": "text",
"tradeType": "text",
"accessoryCategory": "text",
"type": "RATE",
"rate": "text",
"uom": "text",
"from": "text",
"to": "text"
}Path parameters
servicenamestringRequired
servicename
Query parameters
accessoryCategorystringOptional
applicationTypestringOptional
fromnumber · doubleOptional
idsstring[]Optional
licenseTypestringOptional
structureTypestringOptional
tenantIdstringRequired
tonumber · doubleOptional
tradeTypestringOptional
typestringOptional
uomstringOptional
uomValuenumber · doubleOptional
Body
RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.
apiIdstring · max: 128Required
unique API ID
verstring · max: 32Required
API version - for HTTP based request this will be same as used in path
tsinteger · int64Required
time in epoch
actionstring · max: 32Required
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
didstring · max: 1024Optional
Device ID from which the API is called
keystring · max: 256Optional
API key (API key provided to the caller in case of server to server communication)
msgIdstring · max: 256Required
Unique request message id from the caller
requesterIdstring · max: 256Optional
UserId of the user calling
authTokenstringOptional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
correlationIdstringRead-onlyOptional
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /{servicename}/_search?tenantId=text HTTP/1.1
Host: billingslab
Content-Type: application/json
Accept: */*
Content-Length: 430
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"BillingSlab": [
{
"tenantId": "text",
"id": "text",
"licenseType": "TEMPORARY",
"structureType": "text",
"tradeType": "text",
"accessoryCategory": "text",
"type": "RATE",
"rate": "text",
"uom": "text",
"from": "text",
"to": "text"
}
]
}Last updated
Was this helpful?