Payment Orders
Access prerequisites
- Permission (module):
viewPayments - License/Feature: None specific.
- Menu container: GENERAL → Operations group (route
/manage-orders)
Route without a menu item
This screen exists in the application (/manage-orders) but has no fixed menu item. It is maintained for the payment orders flow (court-ordered debts and allocations). Before exposing it to operators, confirm with the coordinator whether it remains active in this tenant.
What it is / when to use
These are orders created by allocation or court-ordered debts (precatórios), where a value NFT is released. The user, knowing they have an amount to receive, may wait for payment or trade their NFT for any price they set; at the end, whoever holds the NFT receives the full amount of the court-ordered debt/allocation. This screen lists those orders, allows monitoring their status, viewing the detail of each order, and exporting the list as a PDF.
Prerequisites
- Permission:
viewPayments(dual permission — CPM enum + dynamic module in the DB). - License/Feature: None specific.
- Dependencies on other screens: the value order/NFT must have already been issued (allocation or court-ordered debt).
Step by step
- Go to
/manage-orders(Payment Orders). - Search by order ID or customer e-mail.
- Click view to open the order details; use send (truck icon) to advance the status; use Generate PDF to export the list.
Filters and columns
| Filter/Column | What it shows | Data source |
|---|---|---|
| Search | Local filter by order ID or e-mail | id / userEmail |
| Order | Order number (with message indicator) | id, hasMessage, hasNewMessage |
| Date | Creation date/time | createdAt |
| E-mail / Customer | Buyer and name | userEmail, user.data.firstName/lastName |
| Document | CPF/CNPJ/passport (with automatic mask) | user.data.identifier |
| Total | Order amount | totalAmount (tenant fiat currency) |
| Status | Order state (red = cancelled, green = delivered) | status (orderStatus) |
Possible states: awaiting payment, in progress, delivered, processing cancellation, cancelled, separating stock.
Actions and modals
- View (visibility): opens the
DialogOrderViewComponentmodal with the order details. - Mark as sent (local_shipping): calls
changeOrderStatus('finished', id)— advances the order to finished. Immediate action, with snackbar feedback. - Generate PDF: exports the order list to
pedidos.pdf(jsPDF/autoTable).
Business rules / caveats
Attention
- The filter/search is local over the loaded list (ID or e-mail).
- The status change is immediate (no confirmation bottom-sheet) — confirm the order before clicking.
- Financial amounts: handled as BigNumber — no rounding; the total is displayed in the tenant's fiat currency.
- Idempotency: settlements associated with the order follow FinLib idempotency by
externalId(E00021= already processed = success). - APPROVED status: financial movements presuppose an
APPROVEDuser.