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/tl-calculator//v1/_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

200400

Success response with calculated tax amount.

Body

*/*

ResponseInfoResponseInfo_2 (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

JavaScriptCurl

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

Response

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

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

Generates bill for payment.

POST/tl-calculator//v1/_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

200400

Success response calculated tax amount.

Body

*/*

idstring

Id of the bill

mobileNumberstring

MobileNumber of the payer.

payerNamestring

name of the payer.

payerAddressstring

Address details from the payer.

payerEmailstring

email address of the payer.

isActiveboolean

true when active bill is created, false when inactive bill is created.

isCancelledboolean

true when cancelled bill is cancelled, false when non-cancelled bill is created.

additionalDetailsobject

field for capturing any additional details.

taxAndPaymentsarray of taxAndPayment (object)

billDetailsarray of BillDetail (object)

tenantIdstring

Unique Identifier of the tenant

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

Request

JavaScriptCurl

const response = await fetch('/tl-calculator//v1/_getbill', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "mobileNumber": "text",
  "payerName": "text",
  "payerAddress": "text",
  "payerEmail": "text",
  "isActive": false,
  "isCancelled": false,
  "additionalDetails": {},
  "taxAndPayments": [
    {
      "businessService": "text",
      "taxAmount": "text",
      "amountPaid": "text"
    }
  ],
  "billDetails": [
    {
      "id": "text",
      "tenantId": "text",
      "demandId": "text",
      "bill": "text",
      "businessService": "text",
      "billNumber": "text",
      "billDate": 0,
      "consumerCode": "text",
      "consumerType": "text",
      "minimumAmount": 0,
      "totalAmount": 0,
      "fromPeriod": 0,
      "toPeriod": 0,
      "collectedAmount": 0,
      "collectionModesNotAllowed": [
        "text"
      ],
      "partPaymentAllowed": false,
      "additionalDetails": {},
      "billAccountDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "billDetail": "text",
          "demandDetailId": "text",
          "amount": 0,
          "adjustedAmount": 0,
          "isActualDemand": false,
          "glcode": "text",
          "taxHeadCode": "text",
          "additionalDetails": {},
          "purpose": "ARREAR"
        }
      ],
      "status": "CREATED"
    }
  ],
  "tenantId": "text",
  "auditDetails": {
    "createdBy": "text",
    "lastModifiedBy": "text"
  }
}

estimate

POST/tl-calculator//v1/_estimate

Path parameters

servicename*string

servicename

Body

application/json

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

200201401403404

OK

Body

*/*

ResponseInfoResponseInfo_2 (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

JavaScriptCurl

const response = await fetch('/tl-calculator//v1/_estimate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

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

calculate

POST/tl-calculator//v1/{servicename}/_calculate

Path parameters

servicename*string

servicename

Body

application/json

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

200201401403404

OK

Body

*/*

ResponseInfoResponseInfo_2 (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

JavaScriptCurl

const response = await fetch('/tl-calculator//v1/{servicename}/_calculate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

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

estimate

POST/tl-calculator//v1/{servicename}/_estimate

Path parameters

servicename*string

servicename

Body

application/json

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

200201401403404

OK

Body

*/*

ResponseInfoResponseInfo_2 (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

JavaScriptCurl

const response = await fetch('/tl-calculator//v1/{servicename}/_estimate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

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

getBill

POST/tl-calculator//v1/{servicename}/_getbill

Path parameters

servicename*string

servicename

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

*/*

billResponseBillResponse

billingSlabIdsBillingSlabIds

Request

JavaScriptCurl

const response = await fetch('/tl-calculator//v1/{servicename}/_getbill', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "billResponse": {
    "Bill": [
      {
        "id": "text",
        "mobileNumber": "text",
        "payerName": "text",
        "payerAddress": "text",
        "payerEmail": "text",
        "isActive": false,
        "isCancelled": false,
        "additionalDetails": {},
        "taxAndPayments": [
          {
            "businessService": "text",
            "taxAmount": "text",
            "amountPaid": "text"
          }
        ],
        "billDetails": [
          {
            "id": "text",
            "tenantId": "text",
            "demandId": "text",
            "bill": "text",
            "businessService": "text",
            "billNumber": "text",
            "billDate": 0,
            "consumerCode": "text",
            "consumerType": "text",
            "minimumAmount": 0,
            "totalAmount": 0,
            "fromPeriod": 0,
            "toPeriod": 0,
            "collectedAmount": 0,
            "collectionModesNotAllowed": [
              "text"
            ],
            "partPaymentAllowed": false,
            "additionalDetails": {},
            "billAccountDetails": [
              {
                "id": "text",
                "tenantId": "text",
                "billDetail": "text",
                "demandDetailId": "text",
                "amount": 0,
                "adjustedAmount": 0,
                "isActualDemand": false,
                "glcode": "text",
                "taxHeadCode": "text",
                "additionalDetails": {},
                "purpose": "ARREAR"
              }
            ],
            "status": "CREATED"
          }
        ],
        "tenantId": "text",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      }
    ],
    "ResposneInfo": {
      "apiId": "text",
      "ver": "text",
      "resMsgId": "text",
      "msgId": "text",
      "status": "SUCCESSFUL"
    }
  },
  "billingSlabIds": {
    "accesssoryBillingSlabIds": [
      "text"
    ],
    "consumerCode": "text",
    "tradeTypeBillingSlabIds": [
      "text"
    ]
  }
}

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

Get the properties list based on the input parameters.

POST/tl-calculator//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

JavaScriptCurl

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

Response

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

Create new billing slabs for trade license calculation.

API to billing slabs for trade license calculation.

POST/tl-calculator//billingslab/_create

Body

*/*

Details for the new slab + 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

Billing Slab(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

JavaScriptCurl

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

Response

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

Update existing billing slabs.

Updates a given billing slab with new properties

POST/tl-calculator//billingslab/_update

Body

*/*

Request header for the update of billing slab.

tenantId*string

Unique ulb identifier

idstring

unique identifier of the billing slab uuid

licenseTypeenum

LicenseType, is unique enum value for a license

TEMPORARYPERMANENT

structureTypestring

StructureType and Structure subtype, this mdms data.

tradeTypestring

value from Trade type master of mdms .

accessoryCategorystring

Accessory Category is a master from mdms .

typeenum

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

RATEFLAT

ratestring

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

uomstring

unit of measurement of trade type.

fromstring

uom value lower bound.

tostring

uom value upper bound.

Response

200400

Update Billing Slab(s) successful

Body

*/*

tenantId*string

Unique ulb identifier

idstring

unique identifier of the billing slab uuid

licenseTypeenum

LicenseType, is unique enum value for a license

TEMPORARYPERMANENT

structureTypestring

StructureType and Structure subtype, this mdms data.

tradeTypestring

value from Trade type master of mdms .

accessoryCategorystring

Accessory Category is a master from mdms .

typeenum

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

RATEFLAT

ratestring

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

uomstring

unit of measurement of trade type.

fromstring

uom value lower bound.

tostring

uom value upper bound.

Request

JavaScriptCurl

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

Response

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

billingslabSearchPost

POST/tl-calculator//billingslab/{servicename}/_search

Path parameters

servicename*string

servicename

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

*/*

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

JavaScriptCurl

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

Response

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