Accessing the Overview
The Overview opens automatically when you select Payments from the PLUGINS section in the Midaz module. You can return to it at any time by clicking Payments in the left-side menu.
The Overview requires the View permission. If your role doesn’t include it, the page won’t be displayed. See Permissions and RBAC.
Operations
At the top of the page, the Operations section provides quick-action cards to start the most common tasks. Each card is shown only if your role has the matching permission.
Issue boleto
Create a new boleto for collection. Opens the New Boleto form on the Boletos page. Requires boleto create permission.
Pay bill
Pay a bill via its digitable line or barcode, or a DARF tax form. Opens the Bill Payments page (Pay bill / Pay DARF). Requires payment create permission.
Boletos summary
The Boletos section summarizes the lifecycle of every boleto issued by your organization through a set of KPI cards.
| Card | What it shows |
|---|---|
| Issued | Total number of boletos issued. |
| Pending | Boletos still awaiting settlement. |
| Settled | Boletos that have been paid. |
| Overdue | Boletos past their due date and not settled. |
| Total amount | Sum of all issued boleto amounts. |
| Settled amount | Sum of the amounts already settled. |
| Overdue amount | Sum of the amounts that are overdue. |
| Settlement rate | Share of issued boletos that have been settled, as a percentage. The card color reflects performance: green at 80% or above, blue from 50% to 79%, and amber below 50%. |
Recent boletos
Below the KPI cards, the Recent boletos table lists the five most recently created boletos with the following columns:- ID — the boleto identifier (shortened).
- Type — the boleto type.
- Amount — the boleto value.
- Status — the current lifecycle state.
- Created at — when the boleto was issued.
Payments summary
The Payments section summarizes your bill payment activity with its own set of KPI cards.
| Card | What it shows |
|---|---|
| Created | Total number of payments created. |
| Scheduled | Payments scheduled for a future date. |
| Settled | Payments that have been completed. |
| Failed | Payments that failed to process. |
| Total amount | Sum of all payment amounts. |
| Settled amount | Sum of the amounts already settled. |
| Rejected | Payments that were rejected. |
| Canceled | Payments that were canceled. |

