> 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/features/household-register.md).

# Household Register

**Context**

Users can click on the HouseHold Register on the home screen and navigate to this screen. This provides a single view snapshot of all pending collections by consumers till date.

![](/files/-MjDX9RH9fXY2OZ3WOHt)

| **Title**      | **Explanation**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Heading        | HouseHold Register                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| As of Date     | As of \<Todays Date>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Search         | <ul><li>Search by consumer name or connection id</li><li>Partial match should be allowed.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Filters        | <p>Default is “All” selected</p><p>User can switch to “Pending” or “Paid” view. Based on selection, results are displayed in the table</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Download PDF   | Download PDF should download PDF format of Household Register with name of document as HH\_Register\_\<Date>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| WhatsApp Share | Should trigger same PDF as Whatsapp share                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Columns        | <ul><li><p>Connection ID</p><ul><li>New Connection ID of the consumer. If there is a metered connection, an “M” in ⭕️ is shown alongside connection ID</li></ul></li><li><p>Name</p><ul><li>Name of the consumer - Similar to Revenue dashboard truncate it to 20 characters and show 3 dots</li></ul></li><li><p>Pending Collections</p><ul><li>Total pending collections of the consumer till date.</li></ul></li></ul><p>The table has sort options by all columns.</p><p>The sorted and filtered table, as in the screen view, is exported into the PDF format dynamically on printing.</p> |

Clicking back takes the user back to the home screen.

> [![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/features/household-register.md?ask=<question>&goal=<endgoal>
```

`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.