> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/public-finance/v2.3/exemplar/mgramseva/user-manual/tech-user-manual/collect-payment.md). # Collect Payment ## **Link** → {base url}/mgramseva/household/details/collectPayment![](blob:https://digit-discuss.atlassian.net/7b871954-91b9-47a8-8250-33a09a1908c8#media-blob-url=true\&id=91260146-5080-4158-83af-bae678dca7f3\&collection=contentId-1928200243\&contextId=1928200243\&mimeType=image%2Fpng\&name=Collect%20Payment%20Areears.png\&size=46493\&width=373\&height=812\&alt=) ![](/files/-MkMrKT7DvLfkY8wIRts) After the demand is generated for Metered and non-metered connections or if any arrears are present, the Revenue collector uses this screen to collect payments. Collect Payment card is available on the home screen to the user role having `COLLECTION_OPERATOR` permission. ## **User Interaction on Screen** * Users can pay the total due amount by selecting the Full Amount option below Payment Amount. * Or, Users can also pay a partial amount by selecting Partial Amount from the Payment Amount options. If Partial Amount is selected, users have to provide the amount that he wants to pay. * Clicking on Collect Payment navigates the user to the Payment Success screen. The user can download the receipt or share the receipt for the collected amount. * Users can also print mini receipts with the help of Bluetooth thermal printers by selecting the [Print mini receipt](https://digit-discuss.atlassian.net/wiki/spaces/DD/pages/2053210133) option. ## **Logic Implemented for Arrears Breakup**![](blob:https://digit-discuss.atlassian.net/5555ede1-7e6c-4048-9b53-12270099c765#media-blob-url=true\&id=be8bc96e-4523-4574-b3cc-b4d8473e642e\&collection=contentId-1928200243\&contextId=1928200243\&mimeType=image%2Fpng\&name=Payment%20Success.png\&size=40449\&width=374\&height=636\&alt=) The Arrears is broken into 'BL\_(TaxHeadCode)' which we get from Bill details-->Bill Account details ---> Tax Head Code and the amount of particular arrears is similar to the Bill details--> amount from the Fetch Bill API. ![](/files/-MkMrRZWNddJpFZQbwxa) (`Eg. if there are two bills with tax head codes is 10101 and 10102, then Arrears break up is represented as BL_10101(Water Charges) with the corresponding amount and BL_10102(Water Charges-Arrears) with the corresponding amount`) ## **Files Path** Primary Files:[ punjab-mgramseva/collect\_payment.dart at develop · egovernments/punjab-mgramseva](https://github.com/egovernments/punjab-mgramseva/blob/develop/frontend/mgramseva/lib/screeens/common/collect_payment.dart) ## **Field Validations** | **Fields** | **Validations** | | ------------------------------------------------ | -------------------------------------------------------- | | Payment Amount : Full Amount or Partial Amount | None | | Partial Amount (`If Partial Amount is selected`) | `r'^[0-9]+$' , Can not be 0 or greater than Full Amount` | | Payment Method | None | ## **API Details** | **API EndPoint** | **Input Params (Modules)** | **Description** | | ------------------------------------ | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `egov-mdms-service/v1/_search` | `[{"moduleName":"BillingService","masterDetails":[{"name":"BusinessService","filter":"[?(@.code=='WS')]"}]}]` | To get the billGeneiURL, Calculation of Water services and collectionModesNotAllowed | | `billing-service/bill/v2/_fetchbill` |

consumerCode : {}

businessService : WS

tenantId : {}

| To fetch the bills of the connection/Consumer | ### Stack 1 → Home Screen. + Search Connection Screen + Household Results + Household Details Screen + Collect Payment Screen Pop → Household Details Screen Widgets Utilised from Library | **Widgets** | **File Path** | **Description** | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | `BuildTextField` | [punjab-mgramseva/TextFieldBuilder.dart at develop · egovernments/punjab-mgramseva](https://github.com/egovernments/punjab-mgramseva/blob/develop/frontend/mgramseva/lib/widgets/TextFieldBuilder.dart) | Text Field | | `BottomButtonBar` | [punjab-mgramseva/BottonButtonBar.dart at develop · egovernments/punjab-mgramseva](https://github.com/egovernments/punjab-mgramseva/blob/develop/frontend/mgramseva/lib/widgets/BottonButtonBar.dart) | Button | | `RadioButtonField` | [punjab-mgramseva/RadioButtonFieldBuilder.dart at develop · egovernments/punjab-mgramseva](https://github.com/egovernments/punjab-mgramseva/blob/develop/frontend/mgramseva/lib/widgets/RadioButtonFieldBuilder.dart) | Radio Buttons for options | > [![Creative Commons License](https://i.creativecommons.org/l/by/4.0/80x15.png)*​*](http://creativecommons.org/licenses/by/4.0/)*All content on this page by* [*eGov Foundation*](https://egov.org.in/) *is licensed under a* [*Creative Commons Attribution 4.0 International License*](http://creativecommons.org/licenses/by/4.0/)*.* --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.digit.org/public-finance/v2.3/exemplar/mgramseva/user-manual/tech-user-manual/collect-payment.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.