Manage NFEs
Access prerequisites
- Permission (module):
viewNFEs(to view the list) ORmanageNFEs(to create/edit) - License/Feature: None.
- Menu container: GENERAL → Accounting group
What it is / when to use
This screen manages the NFE (Electronic Service Invoice) configurations per operation type. Each record defines how an invoice should be issued when a user performs a given type of transaction (token purchase, contribution, service fee, etc.): what municipal service code to use, what description goes on the invoice, and whether issuance is enabled. This is not where the invoice is issued to the customer — it defines the fiscal template that the NFE issuer consults when generating the invoice. Invoices already issued to users can be found in Issued Invoices.
Prerequisites
- Permission:
viewNFEsto view;manageNFEsto create/edit (dual permission — CPM enum on the backend + dynamic module in the DB; both must be registered for the operator's role). - License/Feature: None.
- Dependencies on other screens: the integration with the NFE provider must be configured for issuance to actually occur. This screen only stores the issuance parameters per type.
Step by step
- Open the Accounting → Manage NFEs menu.
- The table lists the existing configurations, identified by the operation type.
- Click the edit icon (pencil) to adjust a configuration, or view (eye) to open it in read-only mode.
- In the edit screen, fill in City service code and Invoice description, and use the Enabled toggle to turn issuance on or off for that type.
- Save. A bottom-sheet footer asks for confirmation before writing the changes.
Fields
| Field | What it is | Required? | System/backend effect |
|---|---|---|---|
| Type | Operation type to which the configuration applies (displayed in the list) | Yes (set at creation) | Key that links the configuration to the transaction type; writes type to the NFEConfigurations entity. It is the template identifier. |
| City service code | Municipal service code (city service list) used on the invoice | Yes (for valid issuance) | Writes properties.cityServiceCode. Goes into the service code field of the NFS-e sent to the provider. 20-character limit. |
| Invoice description | Descriptive text of the service that appears on the invoice | Yes (for valid issuance) | Writes properties.description. Composes the service description on the invoice. 20-character limit. |
| Enabled | Turns automatic issuance on/off for that type | No (default off) | Writes enabled. When off, transactions of that type do not trigger NFE issuance, even if all other fields are filled in. |
WARNING
The form only enables the Save button when City service code and Description are filled in. Both have a 20-character limit — long descriptions must be shortened.
Actions and modals
- New / Create: opens the blank form. Upon confirmation in the bottom-sheet, calls
createNFE. If a configuration already exists for that type (unique-key violation), the system shows an "initials already exist" error — choose a different type or edit the existing one. - Edit: loads the configuration and saves via
saveNFE(PUT). A confirmation bottom-sheet is displayed before saving. - View: read-only mode; the Edit button inside the screen leads to edit mode.
- Cancel: if a creation/edit is in progress, asks for confirmation to discard before returning to the list.
Business rules / caveats
Attention
- Type is the configuration key. It is not possible to have two configurations for the same type — the backend rejects it as a unique-key violation.
- The Enabled toggle is the master switch for issuance of that type: turning it off suspends invoice generation without deleting the configuration.
- Tax compliance: the service code and description must reflect the actual service provided and the company's municipal registration — incorrect fields produce invoices that are invalid before the city government.
- Financial values: this screen does not handle values; the amounts on the invoice come from the originating transaction.