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.

updateDemand

POST/pt-calculator-v2//propertytax/_updatedemand

Query parameters

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

Demandsarray of Demand

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Request

JavaScriptCurlPython

const response = await fetch('/pt-calculator-v2//propertytax/_updatedemand?consumerCodes=text&tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

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

mutationCalculator

POST/pt-calculator-v2//propertytax/mutation/_calculate

Body

application/json

PropertyPropertyV2

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

Other propertiesCalculation (object)

Request

JavaScriptCurlPython

const response = await fetch('/pt-calculator-v2//propertytax/mutation/_calculate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

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/pt-calculator-v2//propertytax/_estimate

Body

*/*

required parameters have to be populated

RequestInfo*RequestInfo (object)

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.

CalulationCriteriaarray of CalulationCriteria (object)

Response

200400404

Success response is calculated tax.

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Calculationarray of Calculation (object)

Request

JavaScriptCurlPython

const response = await fetch('/pt-calculator-v2//propertytax/_estimate', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ts": 0,
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

200400404

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Calculation": [
    {
      "connectionNumber": "text",
      "totalAmount": 0,
      "penalty": 0,
      "exemption": 0,
      "rebate": 0,
      "fromDate": 0,
      "toDate": 0,
      "tenantId": "text"
    }
  ]
}

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

Calculate Property Tax based on criteria.

POST/pt-calculator-v2//propertytax/_calculate

Body

*/*

required parameters have to be populated

RequestInfo*RequestInfo (object)

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.

CalulationCriteriaarray of CalulationCriteria (object)

Response

200400404

Success response calculated tax with connection number and amount.

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Calculationarray of Calculation (object)

Request

JavaScriptCurlPython

const response = await fetch('/pt-calculator-v2//propertytax/_calculate', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ts": 0,
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

200400404

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Calculation": [
    {
      "connectionNumber": "text",
      "totalAmount": 0,
      "penalty": 0,
      "exemption": 0,
      "rebate": 0,
      "fromDate": 0,
      "toDate": 0,
      "tenantId": "text"
    }
  ]
}

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

Generates bill for payment.

POST/pt-calculator-v2//propertytax/_getbill

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo (object)

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

Response

200400404

Success response calculated tax with connection number and amount.

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Calculationarray of Calculation (object)

Request

JavaScriptCurlPython

const response = await fetch('/pt-calculator-v2//propertytax/_getbill?tenantId=text&propertyId=text&assessmentNumber=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ts": 0,
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400404

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Calculation": [
    {
      "connectionNumber": "text",
      "totalAmount": 0,
      "penalty": 0,
      "exemption": 0,
      "rebate": 0,
      "fromDate": 0,
      "toDate": 0,
      "tenantId": "text"
    }
  ]
}

getTaxEstimation

POST/pt-calculator-v2//propertytax/v2/_estimate

Body

application/json

AssessmentAssessmentV2

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Calculationarray of Calculation (object)

Request

JavaScriptCurlPython

const response = await fetch('/pt-calculator-v2//propertytax/v2/_estimate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Calculation": [
    {
      "connectionNumber": "text",
      "totalAmount": 0,
      "penalty": 0,
      "exemption": 0,
      "rebate": 0,
      "fromDate": 0,
      "toDate": 0,
      "tenantId": "text"
    }
  ]
}

Get the list of properties defined in the system.

Get the properties list based on the input parameters.

POST/pt-calculator-v2//billingslab/_search

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo (object)

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

Response

200400

Successful response

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BillingSlabarray of BillingSlab (object)

Request

JavaScriptCurlPython

const response = await fetch('/pt-calculator-v2//billingslab/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ts": 0,
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "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": 0
    }
  ]
}

Create new properties.

API to create new properties.

POST/pt-calculator-v2//billingslab/_create

Body

*/*

Details for the new property + RequestInfo meta data.

RequestInfo*RequestInfo (object)

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.

BillingSlabarray of BillingSlab (object)

Response

201400

Property(s) created sucessfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BillingSlabarray of BillingSlab (object)

Request

JavaScriptCurlPython

const response = await fetch('/pt-calculator-v2//billingslab/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ts": 0,
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

201400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "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": 0
    }
  ]
}

Update existing properties.

Updates a given Property with newer details.

POST/pt-calculator-v2//billingslab/_update

Body

*/*

Request header for the property Request.

tenantId*string

Unique ulb identifier

idstring

unique identifier of the billing slab uuid

propertyTypestring

Based on property type charges will change.

propertySubTypestring

Based on property type charges will change.

usageCategoryMajorstring

Floor Number.

usageCategoryMinorstring

Floor Number.

usageCategorySubMinorstring

Floor Number.

usageCategoryDetailstring

Floor Number.

OwnerShipCategorystring

Floor Number.

SubOwnerShipCategorystring

Floor Number.

fromFloorstring

Floor Number.

toFloorstring

Floor Number.

areastring

Floor Number.

fromPlotSizestring

Floor Number.

toPlotSizestring

Floor Number.

unitRatenumber (double)

Floor Number.

Response

200400

Update Property(s) successful

Body

*/*

tenantId*string

Unique ulb identifier

idstring

unique identifier of the billing slab uuid

propertyTypestring

Based on property type charges will change.

propertySubTypestring

Based on property type charges will change.

usageCategoryMajorstring

Floor Number.

usageCategoryMinorstring

Floor Number.

usageCategorySubMinorstring

Floor Number.

usageCategoryDetailstring

Floor Number.

OwnerShipCategorystring

Floor Number.

SubOwnerShipCategorystring

Floor Number.

fromFloorstring

Floor Number.

toFloorstring

Floor Number.

areastring

Floor Number.

fromPlotSizestring

Floor Number.

toPlotSizestring

Floor Number.

unitRatenumber (double)

Floor Number.

Request

JavaScriptCurlPython

const response = await fetch('/pt-calculator-v2//billingslab/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "tenantId": "text"
    }),
});
const data = await response.json();

Response

200400

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

create new mutation properties

POST/pt-calculator-v2//billingslab/mutation/_create

Body

application/json

MutationBillingSlabarray of MutationBillingSlab

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurlPython

const response = await fetch('/pt-calculator-v2//billingslab/mutation/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Get the list of existing mutation properties

POST/pt-calculator-v2//billingslab/mutation/_search

Query parameters

Body

application/json

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo (object)

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

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurlPython

const response = await fetch('/pt-calculator-v2//billingslab/mutation/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ts": 0,
      "ver": "text"
    }),
});
const data = await response.json();

Update the list of existing mutation properties

POST/pt-calculator-v2//billingslab/mutation/_update

Body

application/json

MutationBillingSlabarray of MutationBillingSlab

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurlPython

const response = await fetch('/pt-calculator-v2//billingslab/mutation/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();