e-Challan Calculator Service
Overview
e-Challan Calculator service is used to calculate the e-challan amount based on the details present in the e-challan request. This module is designed in such a way that it can be used to serve e-challan for different types of services.
Pre-requisites
Before you proceed with the configuration, make sure the following pre-requisites are met -
Java 8
Kafka server is up and running.
PSQL server is running and a database is created to store eChallan Calculator Application data.
Following services should be up and running:
egov-mdms
echallan-services
billing-service
Key Functionalities
e-challan service internally call e-challan-calculator to generate demand.
Based on the tax head and tax amount defined in e-challan request, e-challan calculator service creates the demand.
After Demand creation, it calls the billing service to generate the fees.
Configuration Details
MDMS Config
Define the tax period in the below MDMS file for the business service defined in the e-challan service.
https://github.com/egovernments/egov-mdms-data/blob/DEV/data/pb/BillingService/TaxPeriod.json
Define the tax head in the below MDMS file for the business service defined in the e-challan service.
https://github.com/egovernments/egov-mdms-data/blob/DEV/data/pb/BillingService/TaxHeadMaster.json
Define the action and role action mapping for the APIs in the below MDMS files.
Deployment Details
Add MDMS configs required for e-Challan Service and calculator and restart MDMS service.
Deploy the latest version of e-Challan Service and calculator.
Add e-Challan Service persister yaml path in persister configuration and restart persister service
Add role-action mapping for APIs.
Integration
Integration Scope
e-Challan-calculator is integrated with e-Challan-services. The e-Challan-services internally invoke the e-Challan-calculator service to calculate and generate demand for the e-Challan request.
Integration Benefits
The e-Challan calculator application is used to calculate the e-Challan Fees based on the data mentioned in e-Challan creation. Based on the tax amount mentioned in the e-Challan, demand is created. So because of the e-Challan calculator, the calculation and demand generation logic is separated out from eChallan services. So in future, if calculation logic requires changes, the modifications can be carried out for each implementation without making any changes to the e-Challan services.
Steps to Integration
e-Challan service application needs to call the eChallan-calculator/v1/_calculate API to calculate and generate the demand for the e-Challan application.
Interaction Diagram
TBD
Reference Docs
Doc Links
API Swagger Contract
eChallan Service Document
API List
echallan-calculator/v1/_calculate