Search…
⌃K

Trade License Data Model Specs

The TL services are used to issue licenses to applicants after verification. The service is designed in such a way that it can be used to serve different types of licenses. Currently used to issue trade licenses, perform stakeholder registration and issue lockdown passes. The service is integrated with configurable workflows that define the steps for approval of the application.

TL Services Entity Details

Data Constructs

eg_tl_accessory

Description
Attribute Details
Mapping Details
This entity captures the accessory details required for the applied trade.
Attribute Name
Data Type
Definition
Mandatory (Y/N)
id (PK)
character varying (64)
unique id of the accessory
Y
tenantid
character varying (64)
tenantid of the trade license
Y
accessorycategory
character varying (64)
a code for the accessory category
Y
uom
character varying (64)
unit of measurement
Y
uomvalue
character varying (64)
value of unit of measurement
Y
tradelicensedetailid (FK)
character varying (64)
unique id of tradelicense details
Y
active
boolean
whether the accessory is active
Y
createdby
character varying (64)
user id of user who created the accessory
N
lastmodifiedby
character varying (64)
user id of user who last modified the accessory
N
createdtime
bigint
epoch for time on which accessory was created
N
lastmodifiedtime
bigint
epoch for time on which accessory was last modified
N
count
integer
how many such accessories are required
Y
Attribute Name
Mapping Details
id
Licenses.*.tradeLicenseDetail.accessories.*.id
tenantid
Licenses.*.tradeLicenseDetail.accessories.*.tenantId
accessorycategory
Licenses.*.tradeLicenseDetail.accessories.*.accessoryCategory
uom
Licenses.*.tradeLicenseDetail.accessories.*.uom
uomvalue
Licenses.*.tradeLicenseDetail.accessories.*.uomValue
tradelicensedetailid
Licenses[*][?({id} in @.tradeLicenseDetail.accessories[*].id)].tradeLicenseDetail.id
active
Licenses.*.tradeLicenseDetail.accessories.*.active
createdby
Licenses[*][?({id} in @.tradeLicenseDetail.accessories[*].id)].auditDetails.createdBy
lastmodifiedby
Licenses[*][?({id} in @.tradeLicenseDetail.accessories[*].id)].auditDetails.lastModifiedBy
createdtime
Licenses[*][?({id} in @.tradeLicenseDetail.accessories[*].id)].auditDetails.createdTime
lastmodifiedtime
Licenses[*][?({id} in @.tradeLicenseDetail.accessories[*].id)].auditDetails.lastModifiedTime
count

eg_tl_institution

Description
Attribute Details
Mapping Details
This entity captures the trade institution details for the applied trade license.
Attribute Name
Data Type
Definition
Mandatory (Y/N)
tenantid
character varying (256)
unique id for the tenant in whcih trade is set up
Y
id (PK)
character varying (64)
unique id for the institution
Y
tradelicensedetailid (FK)
character varying (64)
unique id for the tradelicense detail
Y
name
character varying (64)
name of the trade
Y
type
character varying (64)
type of trade
Y
designation
character varying (64)
createdby
character varying (64)
user id of user who created the application
Y
lastmodifiedby
bigint
user id of user who last modified the application
Y
createdtime
character varying (64)
epoch for time on which application was created
Y
lastmodifiedtime
bigint
epoch for time on which application was last modified
Y
active
boolean
whether trade is active
Y
institutionname
character varying (250)
name of institution
Y
contactno
character varying (50)
contact number of the institution
Y
organizationregistrationno
character varying (50)
unique registration number for the institution
Y
address
character varying (512)
address of the institution
Y
Attribute Name
Mapping Details
tenantid
Licenses.*.tradeLicenseDetail.institution.tenantId
id
Licenses.*.tradeLicenseDetail.institution.id
tradelicensedetailid
Licenses.*.tradeLicenseDetail.id
name
Licenses.*.tradeLicenseDetail.institution.name
type
Licenses.*.tradeLicenseDetail.institution.type
designation
Licenses.*.tradeLicenseDetail.institution.designation
createdby
Licenses.*.auditDetails.createdBy
lastmodifiedby
Licenses.*.auditDetails.lastModifiedBy
createdtime
Licenses.*.auditDetails.createdTime
lastmodifiedtime
Licenses.*.auditDetails.lastModifiedTime
active
Licenses.*.tradeLicenseDetail.institution.active
institutionname
contactno
organizationregistrationno
address

eg_tl_tradelicensedetail

Description
Attribute Details
Mapping Details
This entity captures the trade license application details.
Attribute Name
Data Type
Definition
Mandatory (Y/N)
id (PK)
character varying (64)
unique id for the tradelicense details
Y
surveyno
character varying (64)
subownershipcategory
character varying (64)
ownership category
Y
channel
character varying (64)
additionaldetail
jsonb
any additional details
N
tradelicenseid (FK)
character varying (256)
unique id of the tradelicense
Y
createdby
character varying (64)
user id of user who created the application
Y
lastmodifiedby
character varying (64)
user id of user who last modified the application
Y
createdtime
bigint
epoch for time on which application was created
Y
lastmodifiedtime
bigint
epoch for time on which application was last modified
Y
noofemployees
integer
number of employees in the trade
N
structuretype
character varying (64)
type of structure (kutcha, pakka)
Y
adhocexemption
numeric (12, 2)
adhocpenalty
numeric (12, 2)
adhocexemptionreason
character varying (1024)
adhocpenaltyreason
character varying (1024)
Attribute Name
Mapping Details
id
Licenses.*.tradeLicenseDetail.id
surveyno
Licenses.*.tradeLicenseDetail.surveyNo
subownershipcategory
Licenses.*.tradeLicenseDetail.subOwnerShipCategory
channel
Licenses.*.tradeLicenseDetail.channel
additionaldetail
Licenses.*.tradeLicenseDetail.additionalDetail
tradelicenseid
Licenses.*.id
createdby
Licenses.*.auditDetails.createdBy
lastmodifiedby
Licenses.*.auditDetails.lastModifiedBy
createdtime
Licenses.*.auditDetails.createdTime
lastmodifiedtime
Licenses.*.auditDetails.lastModifiedTime
noofemployees
Licenses.*.tradeLicenseDetail.noOfEmployees
structuretype
Licenses.*.tradeLicenseDetail.structureType
adhocexemption
Licenses.*.tradeLicenseDetail.adhocExemption
adhocpenalty
Licenses.*.tradeLicenseDetail.adhocPenalty
adhocexemptionreason
Licenses.*.tradeLicenseDetail.adhocExemptionReason
adhocpenaltyreason
Licenses.*.tradeLicenseDetail.adhocPenaltyReason

eg_tl_tradelicensedetail_audit

Description
Attribute Details
Mapping Details
This entity captures the trade license application audit details.
Attribute Name
Data Type
Definition
Mandatory (Y/N)
id (PK)
character varying(64)
unique id of the tradelicense audit
Y
surveyno
character varying(64)
subownershipcategory
character varying(64)
owners category
Y
channel
character varying(64)
additionaldetail
jsonb
any additional details
N
tradelicenseid (FK)
character varying(256)
unique id of the tradelicensedetail
Y
createdby
character varying(64)
user id of user who created the application
Y
lastmodifiedby
character varying(64)
user id of user who last modified the application
Y
createdtime
bigint
epoch for time on which application was created
Y
lastmodifiedtime
bigint
epoch for time on which application was last modified
Y
noofemployees
integer
number of employees in the trade
N
structuretype
character varying(64)
type of structure (kutcha, pakka)
Y
adhocexemption
numeric(12, 2)
adhocpenalty
numeric(12, 2)
adhocexemptionreason
character varying(1024)
adhocpenaltyreason
character varying(1024)
Attribute Name
Mapping Details
id
Licenses.*.tradeLicenseDetail.id
surveyno
Licenses.*.tradeLicenseDetail.surveyNo
subownershipcategory
Licenses.*.tradeLicenseDetail.subOwnerShipCategory
channel
Licenses.*.tradeLicenseDetail.channel
additionaldetail
Licenses.*.tradeLicenseDetail.additionalDetail
tradelicenseid
Licenses.*.id
createdby
Licenses.*.auditDetails.createdBy
lastmodifiedby
Licenses.*.auditDetails.lastModifiedBy
createdtime
Licenses.*.auditDetails.createdTime
lastmodifiedtime
Licenses.*.auditDetails.lastModifiedTime
noofemployees
Licenses.*.tradeLicenseDetail.noOfEmployees
structuretype
Licenses.*.tradeLicenseDetail.structureType
adhocexemption
Licenses.*.tradeLicenseDetail.adhocExemption
adhocpenalty
Licenses.*.tradeLicenseDetail.adhocPenalty
adhocexemptionreason
Licenses.*.tradeLicenseDetail.adhocExemptionReason
adhocpenaltyreason
Licenses.*.tradeLicenseDetail.adhocPenaltyReason

eg_tl_owner

Description
Attribute Details
Mapping Details
This entity captures the trade establishment owner details provided in the trade license application.
Attribute Name
Data Type
Definition
Mandatory (Y/N)
id (PK)
character varying(64)
uuid of the owner
Y
tenantid
character varying(256)
tenant id of the owner
Y
tradelicensedetailid (FK)
character varying(64)
id of the tradelicense details
Y
isactive
boolean
whether owner is active
Y
isprimaryowner
boolean
whether owner is primary
Y
ownertype
character varying(64)
type of owner(single, multiple)
Y
ownershippercentage
character varying(64)
percentage of ownership
N
relationship
character varying(64)
guardian relation
N
active
boolean
whether guardian is active
Y
institutionid
character varying(64)
id of institution, in case of institutional owners
N
createdby
character varying(64)
user id of user who created owner
Y
createdtime
bigint
time when owner was created
Y
lastmodifiedby
character varying(64)
user id of user who last modified owner
Y
lastmodifiedtime
bigint
time when owner was last modified
Y
Attribute Name
Mapping Details
id
Licenses.*.tradeLicenseDetail.owners.*.uuid
tenantid
Licenses.*.tradeLicenseDetail.owners.*.tenantId
tradelicensedetailid
Licenses[*][?({id} in @.tradeLicenseDetail.owners[*].id)].tradeLicenseDetail.id
isactive
Licenses.*.tradeLicenseDetail.owners.*.userActive
isprimaryowner
Licenses.*.tradeLicenseDetail.owners.*.isPrimaryOwner
ownertype
Licenses.*.tradeLicenseDetail.owners.*.ownerType
ownershippercentage
Licenses.*.tradeLicenseDetail.owners.*.ownerShipPercentage
relationship
Licenses.*.tradeLicenseDetail.owners.*.relationship
active
Licenses.*.tradeLicenseDetail.owners.*.userActive
institutionid
createdby
Licenses[*][?({id} in @.tradeLicenseDetail.owners[*].id)].auditDetails.createdBy
createdtime
Licenses[*][?({id} in @.tradeLicenseDetail.owners[*].id)].auditDetails.createdTime
lastmodifiedby
Licenses[*][?({id} in @.tradeLicenseDetail.owners[*].id)].auditDetails.lastModifiedBy
lastmodifiedtime
Licenses[*][?({id} in @.tradeLicenseDetail.owners[*].id)].auditDetails.lastModifiedTime

eg_tl_address

Description
Attribute Details
Mapping Details
This entity captures and stores the trade establishment address details furnished in the trade license application.
<!--td {border: 1px solid #ccc;}br {mso-data-placement:same-cell;}-->
Attribute Name
Data Type
Definition
Mandatory (Y/N)
id (PK)
character varying(64)
unique id of the address object
Y
tenantid
character varying(64)
tenant id of the location
Y
doorno
character varying(64)
door number
N
buildingname
character varying(64)
building name
N
addressid
character varying(64)
addressnumber
character varying(64)
type
character varying(64)
addressline1
text
full address
N
addressline2
character varying(256)
full address
N
landmark
character varying(64)
any landmark
N
street
character varying(64)
Street name/ number
N
city
character varying(64)
city name
Y
locality
character varying(64)
locality name
Y
pincode
character varying(64)
pincode
N
detail
character varying(64)
other details
N
tradelicensedetailid (FK)
character varying(64)
id of the tradelicense details
Y
createdby
character varying(64)
user who created the address
Y
lastmodifiedby
character varying(64)
user who last modified the address
Y
createdtime
bigint
time when address was created
Y
lastmodifiedtime
bigint
time when address was last modified
Y
Attribute Name
Mapping Details
id
Licenses.*.tradeLicenseDetail.address.id
tenantid
Licenses.*.tradeLicenseDetail.address.tenantId
doorno
Licenses.*.tradeLicenseDetail.address.doorNo
buildingname
Licenses.*.tradeLicenseDetail.address.buildingName
addressid
Licenses.*.tradeLicenseDetail.address.addressId
addressnumber
Licenses.*.tradeLicenseDetail.address.addressNumber
type
Licenses.*.tradeLicenseDetail.address.type
addressline1
Licenses.*.tradeLicenseDetail.address.addressline1
addressline2
Licenses.*.tradeLicenseDetail.address.addressline2
landmark
Licenses.*.tradeLicenseDetail.address.landmark
street
Licenses.*.tradeLicenseDetail.address.street
city
Licenses.*.tradeLicenseDetail.address.city
locality
Licenses.*.tradeLicenseDetail.address.locality.code
pincode
Licenses.*.tradeLicenseDetail.address.pincode
detail
Licenses.*.tradeLicenseDetail.address.detail
tradelicensedetailid
Licenses.*.tradeLicenseDetail.id
createdby
Licenses.*.auditDetails.createdBy
lastmodifiedby
Licenses.*.auditDetails.lastModifiedBy
createdtime
Licenses.*.auditDetails.createdTime
lastmodifiedtime
Licenses.*.auditDetails.lastModifiedTime

eg_tl_applicationdocument

Description
Attribute Details
Mapping Details
This entity captures and stores the supporting documents uploaded by the trade license applicant.
Attribute Name
Data Type
Definition
Mandatory (Y/N)
id (PK)
character varying(64)
unique id of the application document
Y
tenantid
character varying(64)
tenant id of the trade license
Y
documenttype
character varying(64)
type of document (id proof, address proof etc)
Y
filestoreid
character varying(64)
id of the document media files
N
tradecategorydetail
character varying(64)
Trade category (good or services)
N
tradelicensedetailid (FK)
character varying(64)
Unique id for the trade license details
N
active
boolean
Whether trade is active or not
N
createdby
character varying(64)
user id of user who created the document
N
lastmodifiedby
character varying(64)
user id of user who last modified the document
N
createdtime
bigint
epoch for time on which document was created
N
lastmodifiedtime
bigint
epoch for time on which document was last modified
N
Attribute Name
Mapping Details
id
Licenses.*.tradeLicenseDetail.applicationDocuments.*.id
tenantid
Licenses.*.tradeLicenseDetail.applicationDocuments.*.tenantId
documenttype
Licenses.*.tradeLicenseDetail.applicationDocuments.*.documentType
filestoreid
Licenses.*.tradeLicenseDetail.applicationDocuments.*.fileStoreId
tradecategorydetail
Licenses.*.tradeLicenseDetail.applicationDocuments.*.tradecategorydetail
tradelicensedetailid
Licenses[*][?({id} in @.tradeLicenseDetail.applicationDocuments[*].id)].tradeLicenseDetail.id
active
Licenses.*.tradeLicenseDetail.applicationDocuments.*.active
createdby
Licenses[*][?({id} in @.tradeLicenseDetail.applicationDocuments[*].id)].auditDetails.createdBy
lastmodifiedby
Licenses[*][?({id} in @.tradeLicenseDetail.applicationDocuments[*].id)].auditDetails.lastModifiedBy
createdtime
Licenses[*][?({id} in @.tradeLicenseDetail.applicationDocuments[*].id)].auditDetails.createdTime
lastmodifiedtime
Licenses[*][?({id} in @.tradeLicenseDetail.applicationDocuments[*].id)].auditDetails.lastModifiedTime

eg_tl_document_owner

Description
Attribute Details
Mapping Details
Stores information about the owner of the document used for issuing the trade license.
Attribute Name
Data Type
Definition
Mandatory (Y/N)
tenantid
character varying(256)
tenant id of the document owner
Y
id (PK)
character varying(64)
unique id of document owner
Y
tradelicensedetailid (FK)
character varying(64)
unique id of tradelicense detail
Y
userid (FK)
character varying(128)
uuid of the owner
Y
documenttype
character varying(64)
type of document
Y
filestoreid
character varying(64)
id of document media files
N
active
boolean
whether document owner is active
Y
documentuid
character varying(64)
unique uuid for the document
Y
createdby
character varying(64)
user id of user who created owner
Y
createdtime
bigint
time when owner was created
Y
lastmodifiedby
character varying(64)
user id of user who last modified owner
Y
lastmodifiedtime
bigint
time when owner was last modified
Y
Attribute Name
Mapping Details
tenantid
Licenses[*][?({id} in @.tradeLicenseDetail.owners.*.documents[*].id)].tenantId
id
Licenses.*.tradeLicenseDetail.owners.*.documents.*.id
tradelicensedetailid
Licenses[*][?({id} in @.tradeLicenseDetail.owners.*.documents[*].id)].tradeLicenseDetail.id
userid
Licenses.*.tradeLicenseDetail.owners[*][?({id} in @.documents[*].id)].uuid
documenttype
Licenses.*.tradeLicenseDetail.owners.*.documents.*.documentType
filestoreid
Licenses.*.tradeLicenseDetail.owners.*.documents.*.fileStoreId
active
Licenses.*.tradeLicenseDetail.owners.*.documents.*.active
documentuid
Licenses.*.tradeLicenseDetail.owners.*.documents.*.documentUid
createdby
Licenses[*][?({id} in @.tradeLicenseDetail.owners.*.documents[*].id)].auditDetails.createdBy
createdtime
Licenses[*][?({id} in @.tradeLicenseDetail.owners.*.documents[*].id)].auditDetails.createdTime
lastmodifiedby
Licenses[*][?({id} in @.tradeLicenseDetail.owners.*.documents[*].id)].auditDetails.lastModifiedBy
lastmodifiedtime
Licenses[*][?({id} in @.tradeLicenseDetail.owners.*.documents[*].id)].auditDetails.lastModifiedTime

eg_tl_tradelicense_audit

Description
Attribute Details
Mapping Details
When the trade license is edited, the old entry is stored in the audit table. Maintains the transaction history.
Attribute Name
Data Type
Definition
Mandatory (Y/N)
id
character varying(64)
unique id for trade license audit
Y
accountid
character varying(64)
uuid of the user who created the application
N
tenantid
character varying(64)
tenant id of the trade license
Y
licensetype
character varying(64)
type of trade (permanent, temporary)
Y
licensenumber
character varying(64)
unique number of the license
Y
applicationnumber
character varying(64)
unique number of the application
Y
oldlicensenumber
character varying(64)
old license number, if expired
N
propertyid
character varying(256)
N
oldpropertyid
character varying(64)
N
applicationdate
bigint
date on which application was created
Y
commencementdate
bigint
Date on which trade started
Y
issueddate
bigint
Date on which license issued
Y
financialyear
character varying(64)
Financial year during which applicaation is valid
Y
validfrom
bigint
epoch for time from which application is valid
Y
validto
bigint
epoch for time upto which application is valid
Y
action
character varying(64)
action which was taken on the application
Y
status
character varying(64)
current status of the application
Y
createdby
character varying(64)
user id of user who created the application
Y
lastmodifiedby
character varying(64)
user id of user who last modified the application
Y
createdtime
bigint
epoch for time on which application was created
Y
lastmodifiedtime
bigint
epoch for time on which application was last modified
Y