Property Tax Calculator
Property Tax Information System APIs
API specs to handle property assessment, change existing property details, change of ownership, calculate property tax, demand generation, and enable ULBs to manage properties.
Query parameters
amountExpectednumber · bigdecimalOptional
assessmentNumberstringOptional
assessmentYearstringOptional
billIdstringOptional
consumerCodesstring[]Required
fromDateinteger · int64Optional
propertyIdstringOptional
tenantIdstringRequired
toDateinteger · int64Optional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /_updatedemand?consumerCodes=text&tenantId=text HTTP/1.1
Host: propertytax
Content-Type: application/json
Accept: */*
Content-Length: 376
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "text"
}
]
}
]
}
}
}{
"Demands": [
{
"additionalDetails": {},
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"consumerCode": "text",
"consumerType": "text",
"demandDetails": [
{
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"collectionAmount": 1,
"demandId": "text",
"id": "text",
"taxAmount": 1,
"taxHeadMasterCode": "text",
"tenantId": "text"
}
],
"id": "text",
"minimumAmountPayable": 1,
"payer": {
"emailId": "text",
"id": 1,
"mobileNumber": "text",
"name": "text",
"roles": [
{
"code": "text",
"id": 1,
"name": "text"
}
],
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"status": "ACTIVE",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
}
],
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
}Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /mutation/_calculate HTTP/1.1
Host: propertytax
Content-Type: application/json
Accept: */*
Content-Length: 3155
{
"Property": {
"accountId": "text",
"acknowldgementNumber": "text",
"additionalDetails": {},
"address": {
"additionalDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"id": "text",
"landmark": "text",
"locality": {
"area": "text",
"children": [
{
"area": "text",
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"channel": "text",
"creationReason": "text",
"documents": [
{
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text",
"status": "text"
}
],
"id": "text",
"institution": {
"additionalDetails": {},
"designation": "text",
"id": "text",
"name": "text",
"nameOfAuthorizedPerson": "text",
"tenantId": "text",
"type": "text"
},
"landArea": 1,
"linkedProperties": [
"text"
],
"noOfFloors": 1,
"oldPropertyId": "text",
"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-05",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-05",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-05",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-05",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-05",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text"
}
],
"ownershipCategory": "text",
"propertyId": "text",
"propertyType": "text",
"source": "text",
"status": "text",
"superBuiltUpArea": 1,
"surveyId": "text",
"tenantId": "text",
"units": [
{
"active": true,
"additionalDetails": {},
"arv": 1,
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"constructionDetail": {
"builtUpArea": 1,
"carpetArea": 1,
"constructionDate": 1,
"constructionType": "text",
"dimensions": {},
"plinthArea": 1,
"superBuiltUpArea": 1
},
"floorNo": 1,
"id": "text",
"occupancyDate": 1,
"occupancyType": "text",
"tenantId": "text",
"unitType": "text",
"usageCategory": "text"
}
],
"usageCategory": "text"
},
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "text"
}
]
}
]
}
}
}{
"ANY_ADDITIONAL_PROPERTY": {
"connectionNumber": "text",
"totalAmount": 1,
"penalty": 1,
"exemption": 1,
"rebate": 1,
"fromDate": 1,
"toDate": 1,
"tenantId": "text"
}
}Generates estimated Property tax that will be incured once this particular property is added in to the system (note- only one property should be sent to the api for estimation, anything more than one will be ignored.)
post
Estimates the Property Tax to be paid for given property .
Body
Responses
200
Success response is calculated tax.
*/*
400
New water connection request failed
*/*
404
tenantId provided was not found
*/*
post
POST /_estimate HTTP/1.1
Host: propertytax
Content-Type: */*
Accept: */*
Content-Length: 2227
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "text"
}
]
}
]
}
},
"CalulationCriteria": [
{
"property": {
"tenantId": "text",
"oldPropertyId": "text",
"status": "ACTIVE",
"address": "[Circular Reference]",
"creationReason": "NEWPROPERTY",
"occupancyDate": 1,
"propertyDetail": [
{
"financialYear": "text",
"assessmentDate": 1,
"propertyType": "text",
"propertySubType": "text",
"usageCategoryMajor": "text",
"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-05",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-05",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-05",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-05",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-05",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text"
}
],
"source": "MUNICIPAL_RECORDS",
"noOfFloors": 1,
"landArea": 1,
"buildUpArea": 1,
"units": [
{
"id": "text",
"tenantId": "text",
"floorNo": "text",
"unitType": "text",
"unitArea": 1,
"usageCategoryMajor": "text",
"usageCategoryMinor": "text",
"usageCategorySubMinor": "text",
"usageCategoryDetail": "text",
"occupancyType": "Owner",
"occupancyDate": 1,
"constructionType": "text",
"constructionSubType": "text",
"arv": 1
}
],
"documents": [
{
"id": 1,
"documentType": "text",
"fileStore": "text"
}
],
"additionalDetails": "text",
"channel": "SYSTEM"
}
]
},
"assesmentNumber": "text",
"assesmentYear": "text",
"oldAssesmentNumber": "text",
"tenantId": "text"
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Calculation": [
{
"connectionNumber": "text",
"totalAmount": 1,
"penalty": 1,
"exemption": 1,
"rebate": 1,
"fromDate": 1,
"toDate": 1,
"tenantId": "text"
}
]
}Calculate Property Tax based on criteria.
Body
Responses
200
Success response calculated tax with connection number and amount.
*/*
400
New water connection request failed
*/*
404
tenantId provided was not found
*/*
post
POST /_calculate HTTP/1.1
Host: propertytax
Content-Type: */*
Accept: */*
Content-Length: 2227
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "text"
}
]
}
]
}
},
"CalulationCriteria": [
{
"property": {
"tenantId": "text",
"oldPropertyId": "text",
"status": "ACTIVE",
"address": "[Circular Reference]",
"creationReason": "NEWPROPERTY",
"occupancyDate": 1,
"propertyDetail": [
{
"financialYear": "text",
"assessmentDate": 1,
"propertyType": "text",
"propertySubType": "text",
"usageCategoryMajor": "text",
"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-05",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-05",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-05",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-05",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-05",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text"
}
],
"source": "MUNICIPAL_RECORDS",
"noOfFloors": 1,
"landArea": 1,
"buildUpArea": 1,
"units": [
{
"id": "text",
"tenantId": "text",
"floorNo": "text",
"unitType": "text",
"unitArea": 1,
"usageCategoryMajor": "text",
"usageCategoryMinor": "text",
"usageCategorySubMinor": "text",
"usageCategoryDetail": "text",
"occupancyType": "Owner",
"occupancyDate": 1,
"constructionType": "text",
"constructionSubType": "text",
"arv": 1
}
],
"documents": [
{
"id": 1,
"documentType": "text",
"fileStore": "text"
}
],
"additionalDetails": "text",
"channel": "SYSTEM"
}
]
},
"assesmentNumber": "text",
"assesmentYear": "text",
"oldAssesmentNumber": "text",
"tenantId": "text"
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Calculation": [
{
"connectionNumber": "text",
"totalAmount": 1,
"penalty": 1,
"exemption": 1,
"rebate": 1,
"fromDate": 1,
"toDate": 1,
"tenantId": "text"
}
]
}Generates bill for payment.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
propertyIdstringRequired
Primary key of Property object.
assessmentNumberstringRequired
Unique id of the assessment.
assessmentYearstringOptional
Year for which the property is being assessed, assessment year should be given in yyyy-yy format (2013-14).
billIdstringOptional
Primary key of bill object.
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 with connection number and amount.
*/*
400
New water connection request failed
*/*
404
tenantId provided was not found
*/*
post
POST /_getbill?tenantId=text&propertyId=text&assessmentNumber=text HTTP/1.1
Host: propertytax
Content-Type: */*
Accept: */*
Content-Length: 360
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "text"
}
]
}
]
}
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Calculation": [
{
"connectionNumber": "text",
"totalAmount": 1,
"penalty": 1,
"exemption": 1,
"rebate": 1,
"fromDate": 1,
"toDate": 1,
"tenantId": "text"
}
]
}Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /v2/_estimate HTTP/1.1
Host: propertytax
Content-Type: application/json
Accept: */*
Content-Length: 1465
{
"Assessment": {
"additionalDetails": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"empty": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
},
"assessmentDate": 1,
"assessmentNumber": "text",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"channel": "text",
"documentV2s": [
{
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text",
"status": "text"
}
],
"financialYear": "text",
"id": "text",
"propertyId": "text",
"source": "FIELD_SURVEY",
"status": "text",
"tenantId": "text",
"unitUsageList": [
{
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"id": "text",
"occupancyDate": 1,
"occupancyType": "text",
"tenantId": "text",
"unitId": "text",
"usageCategory": "text"
}
]
},
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "text"
}
]
}
]
}
}
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Calculation": [
{
"connectionNumber": "text",
"totalAmount": 1,
"penalty": 1,
"exemption": 1,
"rebate": 1,
"fromDate": 1,
"toDate": 1,
"tenantId": "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.
acknowldgementNumberstring · min: 1 · max: 64Optional
The acknowldgement number no for a property.
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: 360
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "text"
}
]
}
]
}
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"BillingSlab": [
{
"tenantId": "text",
"id": "text",
"propertyType": "text",
"propertySubType": "text",
"usageCategoryMajor": "text",
"usageCategoryMinor": "text",
"usageCategorySubMinor": "text",
"usageCategoryDetail": "text",
"OwnerShipCategory": "text",
"SubOwnerShipCategory": "text",
"fromFloor": "text",
"toFloor": "text",
"area": "text",
"fromPlotSize": "text",
"toPlotSize": "text",
"unitRate": 1
}
]
}API to create new properties.
Body
Responses
201
Property(s) created sucessfully
*/*
400
Property(s) creation failed
*/*
post
POST /_create HTTP/1.1
Host: billingslab
Content-Type: */*
Accept: */*
Content-Length: 749
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "text"
}
]
}
]
}
},
"BillingSlab": [
{
"tenantId": "text",
"id": "text",
"propertyType": "text",
"propertySubType": "text",
"usageCategoryMajor": "text",
"usageCategoryMinor": "text",
"usageCategorySubMinor": "text",
"usageCategoryDetail": "text",
"OwnerShipCategory": "text",
"SubOwnerShipCategory": "text",
"fromFloor": "text",
"toFloor": "text",
"area": "text",
"fromPlotSize": "text",
"toPlotSize": "text",
"unitRate": 1
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"BillingSlab": [
{
"tenantId": "text",
"id": "text",
"propertyType": "text",
"propertySubType": "text",
"usageCategoryMajor": "text",
"usageCategoryMinor": "text",
"usageCategorySubMinor": "text",
"usageCategoryDetail": "text",
"OwnerShipCategory": "text",
"SubOwnerShipCategory": "text",
"fromFloor": "text",
"toFloor": "text",
"area": "text",
"fromPlotSize": "text",
"toPlotSize": "text",
"unitRate": 1
}
]
}Updates a given Property with newer details.
Body
tenantIdstring · min: 4 · max: 128Required
Unique ulb identifier
idstring · min: 2 · max: 64Optional
unique identifier of the billing slab uuid
propertyTypestring · min: 2 · max: 64Optional
Based on property type charges will change.
propertySubTypestring · min: 2 · max: 64Optional
Based on property type charges will change.
usageCategoryMajorstring · min: 2 · max: 64Optional
Floor Number.
usageCategoryMinorstring · min: 2 · max: 64Optional
Floor Number.
usageCategorySubMinorstring · min: 2 · max: 64Optional
Floor Number.
usageCategoryDetailstring · min: 2 · max: 64Optional
Floor Number.
OwnerShipCategorystring · min: 2 · max: 64Optional
Floor Number.
SubOwnerShipCategorystring · min: 2 · max: 64Optional
Floor Number.
fromFloorstring · min: 2 · max: 64Optional
Floor Number.
toFloorstring · min: 2 · max: 64Optional
Floor Number.
areastring · min: 2 · max: 64Optional
Floor Number.
fromPlotSizestring · min: 2 · max: 64Optional
Floor Number.
toPlotSizestring · min: 2 · max: 64Optional
Floor Number.
unitRatenumber · doubleOptional
Floor Number.
Responses
200
Update Property(s) successful
*/*
400
Update Property(s) failed
*/*
post
POST /_update HTTP/1.1
Host: billingslab
Content-Type: */*
Accept: */*
Content-Length: 356
{
"tenantId": "text",
"id": "text",
"propertyType": "text",
"propertySubType": "text",
"usageCategoryMajor": "text",
"usageCategoryMinor": "text",
"usageCategorySubMinor": "text",
"usageCategoryDetail": "text",
"OwnerShipCategory": "text",
"SubOwnerShipCategory": "text",
"fromFloor": "text",
"toFloor": "text",
"area": "text",
"fromPlotSize": "text",
"toPlotSize": "text",
"unitRate": 1
}{
"tenantId": "text",
"id": "text",
"propertyType": "text",
"propertySubType": "text",
"usageCategoryMajor": "text",
"usageCategoryMinor": "text",
"usageCategorySubMinor": "text",
"usageCategoryDetail": "text",
"OwnerShipCategory": "text",
"SubOwnerShipCategory": "text",
"fromFloor": "text",
"toFloor": "text",
"area": "text",
"fromPlotSize": "text",
"toPlotSize": "text",
"unitRate": 1
}Body
Responses
200
OK
*/*
Responseobject
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /mutation/_create HTTP/1.1
Host: billingslab
Content-Type: application/json
Accept: */*
Content-Length: 729
{
"MutationBillingSlab": [
{
"fixedAmount": 1,
"id": "text",
"maxMarketValue": 1,
"minMarketValue": 1,
"ownerShipCategory": "text",
"propertySubType": "text",
"propertyType": "text",
"rate": 1,
"subOwnerShipCategory": "text",
"tenantId": "text",
"type": "FLAT",
"usageCategoryDetail": "text",
"usageCategoryMajor": "text",
"usageCategoryMinor": "text",
"usageCategorySubMinor": "text"
}
],
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "text"
}
]
}
]
}
}
}{}Query parameters
idstring[]Optional
Unique Identifier(UUID) of the land for internal reference.
marketValuenumber · doubleOptional
market value of the item
ownerShipCategorystringOptional
one of different categories of legal ownership
propertySubTypestringOptional
defined by the type of ownership, which can be determined by the legal description or how the property is deeded
propertyTypestringOptional
value for dwelling configuration of the property
subOwnerShipCategorystringOptional
subOwnerShipCategory of product
tenantIdstringRequired
Unique ULB identifier.
usageCategoryMajorstringOptional
category of product usage
usageCategoryMinorstringOptional
usageCategoryMinor
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
*/*
Responseobject
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /mutation/_search?tenantId=text HTTP/1.1
Host: billingslab
Content-Type: application/json
Accept: */*
Content-Length: 360
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "text"
}
]
}
]
}
}{}Body
Responses
200
OK
*/*
Responseobject
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /mutation/_update HTTP/1.1
Host: billingslab
Content-Type: application/json
Accept: */*
Content-Length: 729
{
"MutationBillingSlab": [
{
"fixedAmount": 1,
"id": "text",
"maxMarketValue": 1,
"minMarketValue": 1,
"ownerShipCategory": "text",
"propertySubType": "text",
"propertyType": "text",
"rate": 1,
"subOwnerShipCategory": "text",
"tenantId": "text",
"type": "FLAT",
"usageCategoryDetail": "text",
"usageCategoryMajor": "text",
"usageCategoryMinor": "text",
"usageCategorySubMinor": "text"
}
],
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"userName": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"description": "text"
}
]
}
]
}
}
}{}Last updated
Was this helpful?