UI details for eChallan feature in mCollect module
This page offers a detailed insight into the user interface features, screens, and navigation available for the eChallan service in the mCollect module. Browse through this document to find the e-Challan service details, MDMS and localization details.
Objective
Generate e-challans / bills for all miscellaneous / Adhoc services which citizens avail from ULBs
The ability for ULBs to Notify citizens about outstanding payments - Online and offline
Enable Digital payments for citizens - QR code, payment link in notifications, etc.
Employees can Create Challan, by selecting the service category, and entering all consumer information and tax head details.
Click here to find the create new challan file changes.
Selecting City is disabled as UC Employee of City A should be able to access/create only City A-related challans.
Based on the response, Service Type and Service category Dropdowns are Loaded. For eg: Refer to the response object
Based on that "businessService": "WaterCharges.Metered"
The service Category is "WaterCharges"
and the service Type is "Metered"
The conversion of business Service utils is setServiceCategory
method present in ``https://github.com/egovernments/frontend/blob/39ffbeb4f5446bbb08729e9ce6cf0d519f2f748c/web/rainmaker/dev-packages/egov-uc-dev/src/ui-config/screens/specs/utils/index.js
Based on the MDMS response TaxHeadMaster
are formed by the selected service type dropdown.
Filter the initial Taxhead master with the selected service type with service
attribute in each Taxheads.
Other Validations and Create challan can be referred to in https://github.com/egovernments/frontend/blob/39ffbeb4f5446bbb08729e9ce6cf0d519f2f748c/web/rainmaker/dev-packages/egov-uc-dev/src/ui-config/screens/specs/uc/newCollectionResource/newCollectionFooter.js
createChallan
method is used to create challan.
/echallan-services/eChallan/v1/_create
API is used to create a challan.
Users will be able to see the Challan Acknowledgement once the Challan is created successfully,
Actions available:
Proceed to Payment
Download/print Challan
Navigate back to the Home page
Challan’s can be downloaded through this API egov-pdf/download/UC/mcollect-challan?challanNo=
rainmaker-uc
API Used
egov-mdms-service/v1/_search
echallan-services/eChallan/v1/_create
egov-pdf/download/UC/mcollect-challan
egov-mdms-service/v1/_search
954
echallan-services/eChallan/v1/_create
UC_EMP
2112
egov-pdf/download/UC/mcollect-challan
UC_EMP
2115
MCollect Search Challan
MCollect Pay Challan
MCollect Edit / Update Challan
Challans are created using create Challan, it is explained in Challan Creation
Provide Employee to update / Cancel / Pay Challan against a Challan number.
Route - mSeva
After searching for a Challan with a click on the Challan number it navigates to viewing the Challan details. The view Challan details is mentioned over digit-ui-internals/EmployeeChallan.js at main · egovernments/digit-ui-internals
Action modal - This comes up on the click of cancel Challan.
Click on yes, the challan will be cancelled and users will be routed to the acknowledgement screen.
Clicking on the Update Challan option updates and routes users to the acknowledgement screen.
The common pay screen is visible once the user clicks on the Pay Challan/Proceed button to payment from the acknowledgement screen.
This pay screen is common for all the modules.
Clicking on the Collect Payment button payment allows users to collect and route to the acknowledgement screen it is common for all modules.
Click on Print Receipt, qa.digit.org/collection-services/payments/{challanBusinessService}/_search
(we need to configure bussinessServices to the respective roles in the MDMS like below ) API will get the payment response, by using that response again we need to call pdf-service/v1/_create
API.
Data fetch, load and render
Once the Challan is searched using echallan-services/eChallan/v1/_search
API, then we can search for bill details using billing-service/bill/v2/_search
for the tax head breakup information.
For Updating/Cancelling the Challan, we can use the API /echallan-services/eChallan/v1/_update
.
download/print Challan using egov-pdf/download/UC/mcollect-challan
API.
rainmaker-uc
egov-mdms-service/v1/_search
echallan-services/eChallan/v1/_update
egov-pdf/download/UC/mcollect-challan
echallan-services/eChallan/v1/_search
billing-service/bill/v2/_search
collection-services/payments/ADVT.Gas_Balloon_Advertisement/_search
we need to pass the businessService (collection-services/payments/{businessService}/_search
).
collection-services/payments/_create
billing-service/bill/v2/_fetchbill
pdf-service/v1/_create
egov-mdms-service/v1/_search
954
echallan-services/eChallan/v1/_update
UC_EMP
2117
egov-pdf/download/UC/mcollect-challan
UC_EMP
2115
echallan-services/eChallan/v1/_search
UC_EMP
2114
billing-service/bill/v2/_search
UC_EMP
1861
billing-service/bill/v2/_fetchbill
UC_EMP
collection-services/payments/ADVT.Gas_Balloon_Advertisement/_search
UC_EMP
2138
collection-services/payments/_create
UC_EMP
1862
pdf-service/v1/_create
UC_EMP
1834
MCollect Create Challan
MCollect Search Challan
This page offers the UI details for the search and pays challan feature. Once a challan is created, in order to pay the challan or update the challan, we have to find the relevant challan.
A citizen can only search for the challan, download the challan, and pay for the challan.
In order to make any payment for challans, both Citizen and Employee roles, use the Bill genie screens to get the bill and can proceed with payment.
To enable the service category to search we have to configure billGineiURL
in MDMS as follow.
Once billGineiURL
is configured for a service, we get an option in bill genie to search for it.
Once the challan is created to Update or cancel challan we use Challan Search.
rainmaker-uc
API Used
egov-mdms-service/v1/_search
echallan-services/eChallan/v1/_search
This document provides details about the edit challan feature in the mCollect module. Challans are created using create challan option explained in the page.
The edit challan workflow enables users to make any correction in the challan or even cancel created challans.
Use the search tool to find the relevant challan and edit it. The Search and Pay Challan page provides information on how to use the search tool.
Click on the search result to navigate to the view challan screen. The service details are .
Here we use echallan-services/eChallan/v1/_search
API to get the Challan Information andbilling-service/bill/v2/_search
to the tax head breakup information. Download/Print using egov-pdf/download/UC/mcollect-challan
API.
Actions
Update challan to edit
Cancel challan
To cancel challan, click on cancel and enter the reason for cancellation. This action calls the echallan-services/eChallan/v1/_update
API to cancel.
Update challan can be used to edit only Tax head information. Any other information that is freezed, can be changed accordingly to support the requirement.
Once you click on update challan echallan-services/eChallan/v1/_update?
API will be called and the challan will be updated accordingly.
rainmaker-uc
API Used
egov-mdms-service/v1/_search
echallan-services/eChallan/v1/_update
egov-pdf/download/UC/mcollect-challan
echallan-services/eChallan/v1/_search
billing-service/bill/v2/_search
Provide employees with the option to create Challan, by selecting the service category, and entering all consumer information and tax head details.
Created hooks for MDMS in mCollect, by using hooks will get the response by passing on the details in the method.
Based on the response, Service Type and Service category Dropdowns are Loaded. For eg: Refer to the response object
Based on that "businessService": "WaterCharges.Metered"
The service Category will be "WaterCharges"
The service Type will be "Metered"
Based on the MDMS response TaxHeadMaster
are formed by the selected service type dropdown. Filter the initial Taxhead master with the selected service type with service
the attributes in each Taxheads.
createChallan
the method is used to create challan.
/echallan-services/eChallan/v1/_create
API is used to create a challan.
Once Challan is created successfully, you will be able to see the Challan Acknowledgement.
Actions available:
Print Challan
Go to home
Proceed to Payment
Print Challan: Click on Print Challan, Challan will be downloaded using egov-pdf/download/UC/mcollect-challan
API.
Go to home: Click on Go TO Home routes users to the home screen.
rainmaker-uc
egov-mdms-service/v1/_search
echallan-services/eChallan/v1/_update
egov-pdf/download/UC/mcollect-challan
collection-services/payments/ADVT.Gas_Balloon_Advertisement/_search
we need to pass the businessService (collection-services/payments/{businessService}/_search
).
collection-services/payments/_create
billing-service/bill/v2/_fetchbill
pdf-service/v1/_create
Provide employees with the option to search challans, download receipts, check the current status, cancel challans, update challans and collect payment.
Once the user login with UC_EMP Role, then the User will get the mCollect module card with the Total Challan Count.
The clicking of Search Challan navigates to the Inbox/search challan screen.
Inbox File link -
Clicking on the Collect button routes users to the common-pay screen with the URL.
example: “https://qa.digit.org/digit-ui/employee/payment/collect/{selectedbusinessService
}/{selectedChallanNumber
}/tenantId={tenantId
}?workflow=mcollect”
This screen is common for all modules.
On Click on download receipt, able to download the receipt of the respective challan number using pdf service API egov-pdf/download/PAYMENT/consolidatedreceipt
.
MDMS Configs used in this inbox screen - applicationStatus
to show all required statuses in the inbox, similarly uiCommonPay
to get service categories.
Table Structure
Uses the same table component similar to other modules.
Once the data is fetched using echallan-services/eChallan/v1/_search
API is being used to search and get data, after that using consumer codes, need to call fetch Bill API billing-service/bill/v2/_fetchbill
to get bills for respective challan for showing status, amount and date etc.
The count APIechallan-services/eChallan/v1/_count
to get the count of total challans.
rainmaker-uc
egov-mdms-service/v1/_search
echallan-services/eChallan/v1/_create
egov-pdf/download/UC/mcollect-challan
echallan-services/eChallan/v1/_count
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
File path of acknowledgement screen: digit-ui-internals/EmployeeChallanAcknowledgement.js at main · egovernments/digit-ui-internals
Update Challan screen, This comes up on the click of update Challan (mSeva ).
File Path: digit-ui-internals/EmployeeChallanAcknowledgement.js at main · egovernments/digit-ui-internals
Click here to find the and the .
All content on this page by is licensed under a .
All content on this page by is licensed under a .
File Path:
Digit.MDMSService.getPaymentRules(tenantId, "[?(@.type=='Adhoc')]");
which is present in the below file:
MDMS File path:
Other Validations and Create challan can be referred in
File Path:
Proceed To Payment: Clicking on this routes users to the common pay screen and it is common for all modules also refer to .
Route -
On search results we can click on the challan number to update/cancel any challan, it is explained in the following documentation -
egov-mdms-service/v1/_search
954
echallan-services/eChallan/v1/_search
UC_EMP
2114
MCollect Create Challan
MCollect Pay Challan
MCollect Edit / Update Challan
egov-mdms-service/v1/_search
954
echallan-services/eChallan/v1/_update
UC_EMP
2117
egov-pdf/download/UC/mcollect-challan
UC_EMP
2115
echallan-services/eChallan/v1/_search
UC_EMP
2114
billing-service/bill/v2/_search
1861
MCollect Create Challan
MCollect Search Challan
MCollect Pay Challan
egov-mdms-service/v1/_search
954
/echallan-services/eChallan/v1/_create
UC_EMP
2112
egov-pdf/download/UC/mcollect-challan
UC_EMP
2115
collection-services/payments/ADVT.Gas_Balloon_Advertisement/_search
UC_EMP
2138
collection-services/payments/_create
UC_EMP
1862
pdf-service/v1/_create
UC_EMP
1834
billing-service/bill/v2/_fetchbill
EMPLOYEE
1862
MCollect Search
MCollect Update/Cancel Challan
egov-mdms-service/v1/_search
954
echallan-services/eChallan/v1/_create
UC_EMP
2112
egov-pdf/download/UC/mcollect-challan
UC_EMP
2115
echallan-services/eChallan/v1/_count
UC_EMP
2192
MCollect Create Challan
MCollect Edit / Update Challan