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.

PreviousProperty Registry NextPublic Grievance Redressal

Last updated 1 year ago

Was this helpful?

updateDemand

post

/propertytax/_updatedemand

Query parameters

amountExpectednumber · bigdecimal

assessmentNumberstring

assessmentYearstring

billIdstring

consumerCodesstring[]required

fromDateinteger · int64

propertyIdstring

tenantIdstringrequired

toDateinteger · int64

Body

RequestInfoobject

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.

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pt-calculator-v2//propertytax/_updatedemand?consumerCodes=text&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Demands": [
    {
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "consumerCode": "text",
      "consumerType": "text",
      "id": "text",
      "minimumAmountPayable": 1,
      "payer": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text"
          }
        ]
      },
      "taxPeriodFrom": 1,
      "taxPeriodTo": 1,
      "tenantId": "text",
      "status": "ACTIVE",
      "demandDetails": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "collectionAmount": 1,
          "demandId": "text",
          "id": "text",
          "taxAmount": 1,
          "taxHeadMasterCode": "text",
          "tenantId": "text"
        }
      ]
    }
  ]
}

mutationCalculator

post

/propertytax/mutation/_calculate

Body

PropertyPropertyV2

RequestInfoobject

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pt-calculator-v2//propertytax/mutation/_calculate' \
  --header 'Content-Type: application/json' \
  --data '{"Property":{"additionalDetails":{},"address":{"additionalDetails":{},"locality":{"children":[{"children":"[Circular Reference]"}]}},"auditDetails":{},"institution":{"additionalDetails":{}},"documents":[{"auditDetails":{},"documentType":"text","fileStoreId":"text"}],"linkedProperties":[null],"owners":[{"userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","tenantId":"text","roles":[{"name":"text","tenantId":"text"}]}],"units":[{"additionalDetails":{},"auditDetails":{},"constructionDetail":{"dimensions":{}},"usageCategory":"text"}]},"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

{
  "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.)

Estimates the Property Tax to be paid for given property .

post

/propertytax/_estimate

Body

RequestInfoobjectrequired

CalulationCriteriaobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pt-calculator-v2//propertytax/_estimate' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"CalulationCriteria":[{"property":{"address":"[Circular Reference]","status":"ACTIVE","creationReason":"NEWPROPERTY","propertyDetail":[{"source":"MUNICIPAL_RECORDS","channel":"SYSTEM","owners":[{"userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","tenantId":"text","roles":[{"name":"text","tenantId":"text"}]}],"units":[{"occupancyType":"Owner"}],"documents":[{}]}]},"tenantId":"text"}]}'

200

400

404

{
  "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"
    }
  ]
}

Success response is calculated tax.

Calculates Property tax and generates the respective demands in the system.

Calculate Property Tax based on criteria.

post

/propertytax/_calculate

Body

RequestInfoobjectrequired

CalulationCriteriaobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pt-calculator-v2//propertytax/_calculate' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"CalulationCriteria":[{"property":{"address":"[Circular Reference]","status":"ACTIVE","creationReason":"NEWPROPERTY","propertyDetail":[{"source":"MUNICIPAL_RECORDS","channel":"SYSTEM","owners":[{"userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","tenantId":"text","roles":[{"name":"text","tenantId":"text"}]}],"units":[{"occupancyType":"Owner"}],"documents":[{}]}]},"tenantId":"text"}]}'

200

400

404

{
  "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"
    }
  ]
}

Success response calculated tax with connection number and amount.

Updates demand with time based penalty if applicable and Generates bill for the given criteria.

Generates bill for payment.

post

/propertytax/_getbill

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

propertyIdstringrequired

Primary key of Property object.

assessmentNumberstringrequired

Unique id of the assessment.

assessmentYearstring

Year for which the property is being assessed, assessment year should be given in yyyy-yy format (2013-14).

billIdstring

Primary key of bill object.

Body

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: 1024

Device ID from which the API is called

keystring · max: 256

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: 256

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoobject

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pt-calculator-v2//propertytax/_getbill?tenantId=text&propertyId=text&assessmentNumber=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

404

{
  "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"
    }
  ]
}

Success response calculated tax with connection number and amount.

getTaxEstimation

post

/propertytax/v2/_estimate

Body

AssessmentAssessmentV2

RequestInfoobject

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pt-calculator-v2//propertytax/v2/_estimate' \
  --header 'Content-Type: application/json' \
  --data '{"Assessment":{"additionalDetails":{"nodeType":"ARRAY"},"assessmentDate":1,"auditDetails":{},"financialYear":"text","propertyId":"text","tenantId":"text","source":"FIELD_SURVEY","documentV2s":[{"auditDetails":{},"documentType":"text","fileStoreId":"text"}],"unitUsageList":[{"auditDetails":{},"id":"text","occupancyDate":1,"occupancyType":"text","tenantId":"text","unitId":"text"}]},"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

{
  "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 list of properties defined in the system.

Get the properties list based on the input parameters.

post

/billingslab/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

activeboolean · varchar

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 · varchar

Primary key of Property object.

assessmentNumberstring · min: 4 · max: 128

The unique reference number for a property.

oldAssessmentNumberstring · min: 4 · max: 128

The unique old assessment no for a Property.

localityinteger · int64

Locality boundary where the property is located.

acknowldgementNumberstring · min: 1 · max: 64

The acknowldgement number no for a property.

Body

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: 1024

Device ID from which the API is called

keystring · max: 256

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: 256

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoobject

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pt-calculator-v2//billingslab/_search?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

{
  "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
    }
  ]
}

Successful response

Create new properties.

API to create new properties.

post

/billingslab/_create

Body

RequestInfoobjectrequired

BillingSlabobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pt-calculator-v2//billingslab/_create' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"BillingSlab":[{"tenantId":"text"}]}'

201

400

{
  "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
    }
  ]
}

Property(s) created sucessfully

Update existing properties.

Updates a given Property with newer details.

post

/billingslab/_update

Body

tenantIdstring · min: 4 · max: 128required

Unique ulb identifier

idstring · min: 2 · max: 64

unique identifier of the billing slab uuid

propertyTypestring · min: 2 · max: 64

Based on property type charges will change.

propertySubTypestring · min: 2 · max: 64

Based on property type charges will change.

usageCategoryMajorstring · min: 2 · max: 64

Floor Number.

usageCategoryMinorstring · min: 2 · max: 64

Floor Number.

usageCategorySubMinorstring · min: 2 · max: 64

Floor Number.

usageCategoryDetailstring · min: 2 · max: 64

Floor Number.

OwnerShipCategorystring · min: 2 · max: 64

Floor Number.

SubOwnerShipCategorystring · min: 2 · max: 64

Floor Number.

fromFloorstring · min: 2 · max: 64

Floor Number.

toFloorstring · min: 2 · max: 64

Floor Number.

areastring · min: 2 · max: 64

Floor Number.

fromPlotSizestring · min: 2 · max: 64

Floor Number.

toPlotSizestring · min: 2 · max: 64

Floor Number.

unitRatenumber · double

Floor Number.

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pt-calculator-v2//billingslab/_update' \
  --header 'Content-Type: */*' \
  --data '{"tenantId":"text"}'

200

400

{
  "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
}

Update Property(s) successful

create new mutation properties

post

/billingslab/mutation/_create

Body

RequestInfoobject

MutationBillingSlabMutationBillingSlab[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pt-calculator-v2//billingslab/mutation/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"MutationBillingSlab":[{"fixedAmount":1,"rate":1,"tenantId":"text","type":"FLAT"}]}'

200

201

401

403

404

{}

Get the list of existing mutation properties

post

/billingslab/mutation/_search

Query parameters

idstring[]

Unique Identifier(UUID) of the land for internal reference.

marketValuenumber · double

market value of the item

ownerShipCategorystring

one of different categories of legal ownership

propertySubTypestring

defined by the type of ownership, which can be determined by the legal description or how the property is deeded

propertyTypestring

value for dwelling configuration of the property

subOwnerShipCategorystring

subOwnerShipCategory of product

tenantIdstringrequired

Unique ULB identifier.

usageCategoryMajorstring

category of product usage

usageCategoryMinorstring

usageCategoryMinor

Body

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: 1024

Device ID from which the API is called

keystring · max: 256

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: 256

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoobject

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pt-calculator-v2//billingslab/mutation/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

201

401

403

404

{}

Update the list of existing mutation properties

post

/billingslab/mutation/_update

Body

RequestInfoobject

MutationBillingSlabMutationBillingSlab[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pt-calculator-v2//billingslab/mutation/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"MutationBillingSlab":[{"fixedAmount":1,"rate":1,"tenantId":"text","type":"FLAT"}]}'

200

201

401

403

404

{}