Trade Licence Calculator

Trade Licence Calculator APIs

API specs to calculate trade licence fees.

Calculates Trade License and generates the respective demands in the system.

Calculate Trade License Fee based on criteria.

post

/v1/_calculate

Body

RequestInfoobjectrequired

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.

CalulationCriteriaobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-calculator//v1/_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":[{"tradelicense":{"tenantId":"text","commencementDate":1,"tradeLicenseDetail":{"subOwnerShipCategory":"text","address":{"locality":"[Circular Reference]"},"auditDetails":{},"channel":"COUNTER","owners":[{"userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","tenantId":"text","roles":[{"name":"text","tenantId":"text"}],"documents":{},"relationship":"FATHER"}],"tradeUnits":[{"tenantId":"text","auditDetails":{}}],"accessories":[{"tenantId":"text","auditDetails":{}}],"applicationDocuments":[{"tenantId":"text","documentType":"text","fileStoreId":"text","auditDetails":{}}],"verificationDocuments":[{"tenantId":"text","documentType":"text","fileStoreId":"text","auditDetails":{}}]},"auditDetails":{},"licenseType":"TEMPORARY","action":"INITIATE","status":"INITIATED"},"tenantId":"text"}]}'

200

400

200

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

Success response with calculated tax amount.

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

Generates bill for payment.

post

/v1/_getbill

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

applicationNumberstringrequired

Unique Trade application number.

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

curl -L \
  --request POST \
  --url '/tl-calculator//v1/_getbill?tenantId=text&applicationNumber=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

200

{
  "id": "text",
  "mobileNumber": "text",
  "payerName": "text",
  "payerAddress": "text",
  "payerEmail": "text",
  "isActive": true,
  "isCancelled": true,
  "tenantId": "text",
  "auditDetails": {
    "createdBy": "text",
    "lastModifiedBy": "text",
    "createdTime": 1,
    "lastModifiedTime": 1
  },
  "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,
      "partPaymentAllowed": true,
      "status": "CREATED",
      "additionalDetails": {},
      "collectionModesNotAllowed": [
        "text"
      ],
      "billAccountDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "billDetail": "text",
          "demandDetailId": "text",
          "order": 1,
          "amount": 1,
          "adjustedAmount": 1,
          "isActualDemand": true,
          "glcode": "text",
          "taxHeadCode": "text",
          "purpose": "ARREAR",
          "additionalDetails": {}
        }
      ]
    }
  ]
}

Success response calculated tax amount.

estimate

post

/v1/_estimate

Path parameters

servicenamestringrequired

servicename

Body

RequestInfoobjectrequired

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.

CalulationCriteriaobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-calculator//v1/_estimate' \
  --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"}]}]}},"CalulationCriteria":[{"tradelicense":{"tenantId":"text","commencementDate":1,"tradeLicenseDetail":{"subOwnerShipCategory":"text","address":{"locality":"[Circular Reference]"},"auditDetails":{},"channel":"COUNTER","owners":[{"userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","tenantId":"text","roles":[{"name":"text","tenantId":"text"}],"documents":{},"relationship":"FATHER"}],"tradeUnits":[{"tenantId":"text","auditDetails":{}}],"accessories":[{"tenantId":"text","auditDetails":{}}],"applicationDocuments":[{"tenantId":"text","documentType":"text","fileStoreId":"text","auditDetails":{}}],"verificationDocuments":[{"tenantId":"text","documentType":"text","fileStoreId":"text","auditDetails":{}}]},"auditDetails":{},"licenseType":"TEMPORARY","action":"INITIATE","status":"INITIATED"},"tenantId":"text"}]}'

200

201

401

403

404

200

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

OK

calculate

post

/v1/{servicename}/_calculate

Path parameters

servicenamestringrequired

servicename

Body

RequestInfoobjectrequired

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.

CalulationCriteriaobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-calculator//v1/{servicename}/_calculate' \
  --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"}]}]}},"CalulationCriteria":[{"tradelicense":{"tenantId":"text","commencementDate":1,"tradeLicenseDetail":{"subOwnerShipCategory":"text","address":{"locality":"[Circular Reference]"},"auditDetails":{},"channel":"COUNTER","owners":[{"userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","tenantId":"text","roles":[{"name":"text","tenantId":"text"}],"documents":{},"relationship":"FATHER"}],"tradeUnits":[{"tenantId":"text","auditDetails":{}}],"accessories":[{"tenantId":"text","auditDetails":{}}],"applicationDocuments":[{"tenantId":"text","documentType":"text","fileStoreId":"text","auditDetails":{}}],"verificationDocuments":[{"tenantId":"text","documentType":"text","fileStoreId":"text","auditDetails":{}}]},"auditDetails":{},"licenseType":"TEMPORARY","action":"INITIATE","status":"INITIATED"},"tenantId":"text"}]}'

200

201

401

403

404

200

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

OK

estimate

post

/v1/{servicename}/_estimate

Path parameters

servicenamestringrequired

servicename

Body

RequestInfoobjectrequired

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.

CalulationCriteriaobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-calculator//v1/{servicename}/_estimate' \
  --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"}]}]}},"CalulationCriteria":[{"tradelicense":{"tenantId":"text","commencementDate":1,"tradeLicenseDetail":{"subOwnerShipCategory":"text","address":{"locality":"[Circular Reference]"},"auditDetails":{},"channel":"COUNTER","owners":[{"userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","tenantId":"text","roles":[{"name":"text","tenantId":"text"}],"documents":{},"relationship":"FATHER"}],"tradeUnits":[{"tenantId":"text","auditDetails":{}}],"accessories":[{"tenantId":"text","auditDetails":{}}],"applicationDocuments":[{"tenantId":"text","documentType":"text","fileStoreId":"text","auditDetails":{}}],"verificationDocuments":[{"tenantId":"text","documentType":"text","fileStoreId":"text","auditDetails":{}}]},"auditDetails":{},"licenseType":"TEMPORARY","action":"INITIATE","status":"INITIATED"},"tenantId":"text"}]}'

200

201

401

403

404

200

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

OK

getBill

post

/v1/{servicename}/_getbill

Path parameters

servicenamestringrequired

servicename

Query parameters

businessServicestring

consumerCodestringrequired

demandIdstring

emailstring

mobileNumberstring

tenantIdstringrequired

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

curl -L \
  --request POST \
  --url '/tl-calculator//v1/{servicename}/_getbill?consumerCode=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

200

{
  "billResponse": {
    "ResposneInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "resMsgId": "text",
      "msgId": "text",
      "status": "SUCCESSFUL"
    },
    "Bill": [
      {
        "id": "text",
        "mobileNumber": "text",
        "payerName": "text",
        "payerAddress": "text",
        "payerEmail": "text",
        "isActive": true,
        "isCancelled": true,
        "tenantId": "text",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "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,
            "partPaymentAllowed": true,
            "status": "CREATED",
            "additionalDetails": {},
            "collectionModesNotAllowed": [
              "text"
            ],
            "billAccountDetails": [
              {
                "id": "text",
                "tenantId": "text",
                "billDetail": "text",
                "demandDetailId": "text",
                "order": 1,
                "amount": 1,
                "adjustedAmount": 1,
                "isActualDemand": true,
                "glcode": "text",
                "taxHeadCode": "text",
                "purpose": "ARREAR",
                "additionalDetails": {}
              }
            ]
          }
        ]
      }
    ]
  },
  "billingSlabIds": {
    "consumerCode": "text",
    "accesssoryBillingSlabIds": [
      "text"
    ],
    "tradeTypeBillingSlabIds": [
      "text"
    ]
  }
}

OK

Get the list of properties defined in the system for trade license calculation.

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.

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

curl -L \
  --request POST \
  --url '/tl-calculator//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

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BillingSlab": [
    {
      "tenantId": "text",
      "id": "text",
      "structureType": "text",
      "tradeType": "text",
      "accessoryCategory": "text",
      "rate": "text",
      "uom": "text",
      "from": "text",
      "to": "text",
      "licenseType": "TEMPORARY",
      "type": "RATE"
    }
  ]
}

Successful response

Create new billing slabs for trade license calculation.

API to billing slabs for trade license calculation.

post

/billingslab/_create

Body

RequestInfoobjectrequired

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.

BillingSlabobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-calculator//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","licenseType":"TEMPORARY","type":"RATE"}]}'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BillingSlab": [
    {
      "tenantId": "text",
      "id": "text",
      "structureType": "text",
      "tradeType": "text",
      "accessoryCategory": "text",
      "rate": "text",
      "uom": "text",
      "from": "text",
      "to": "text",
      "licenseType": "TEMPORARY",
      "type": "RATE"
    }
  ]
}

Billing Slab(s) created sucessfully

Update existing billing slabs.

Updates a given billing slab with new properties

post

/billingslab/_update

Body

tenantIdstring · min: 4 · max: 128required

Unique ulb identifier

idstring · min: 2 · max: 64

unique identifier of the billing slab uuid

structureTypestring · min: 2 · max: 64

StructureType and Structure subtype, this mdms data.

tradeTypestring · min: 2 · max: 64

value from Trade type master of mdms .

accessoryCategorystring · min: 2 · max: 64

Accessory Category is a master from mdms .

ratestring · min: 2 · max: 64

Rate of the trade license, this can be the rate of flat amount based on type.

uomstring · min: 2 · max: 32

unit of measurement of trade type.

fromstring · min: 2 · max: 64

uom value lower bound.

tostring · min: 2 · max: 64

uom value upper bound.

licenseTypestring · enum

LicenseType, is unique enum value for a license

Options: TEMPORARY, PERMANENT

typestring · enum

Type will define the rate value is flat amount or rate.

Options: RATE, FLAT

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-calculator//billingslab/_update' \
  --header 'Content-Type: */*' \
  --data '{"tenantId":"text","licenseType":"TEMPORARY","type":"RATE"}'

200

400

200

{
  "tenantId": "text",
  "id": "text",
  "structureType": "text",
  "tradeType": "text",
  "accessoryCategory": "text",
  "rate": "text",
  "uom": "text",
  "from": "text",
  "to": "text",
  "licenseType": "TEMPORARY",
  "type": "RATE"
}

Update Billing Slab(s) successful

billingslabSearchPost

post

/billingslab/{servicename}/_search

Path parameters

servicenamestringrequired

servicename

Query parameters

accessoryCategorystring

applicationTypestring

fromnumber · double

idsstring[]

licenseTypestring

structureTypestring

tenantIdstringrequired

tonumber · double

tradeTypestring

typestring

uomstring

uomValuenumber · double

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

curl -L \
  --request POST \
  --url '/tl-calculator//billingslab/{servicename}/_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

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BillingSlab": [
    {
      "tenantId": "text",
      "id": "text",
      "structureType": "text",
      "tradeType": "text",
      "accessoryCategory": "text",
      "rate": "text",
      "uom": "text",
      "from": "text",
      "to": "text",
      "licenseType": "TEMPORARY",
      "type": "RATE"
    }
  ]
}

OK