Receivable Types
Access prerequisites
- Permission (module):
creditConfigManage(to create/edit). Read access granted byviewCredits. - License/Feature:
CREDIT_INVESTMENTSenabled in the tenant license (Vault). - Menu container: TOKENIZATION → group Tokenized Credit
What it is / when to use
The Receivable Type defines the categories of receivables the platform accepts (invoice, fiscal note, card, etc.) and which fields are required when registering a receivable of that type. It is what standardizes and validates data entry from the originator.
Use this screen to create/maintain the available types and control, per type, which information the originator is required to provide.
Prerequisites
- Permission:
creditConfigManage(double permission — CPM enum + dynamic module in the DB). - License/Feature:
CREDIT_INVESTMENTSenabled. - Dependencies: none. Types are consumed later when creating receivables.
Step by step
- Go to Tokenized Credit → Receivable Types.
- Filter by Active if needed.
- Click Create.
- Fill in Code and Name.
- In the required fields block, click Add field and choose from the available options:
external_reference,invoice_number,invoice_key,debtor_id,issue_date,due_date,gross_amount,net_amount,currency. - Click Save.
Fields
| Field | What it is | Required? | System/backend effect |
|---|---|---|---|
| Code | Short/unique identifier for the type (e.g.: DUPLICATA) | Yes | Stored in code; used as the type's reference key. |
| Name | Friendly name of the type | Yes | Stored in name; appears in listings and selectors. |
| Required fields | List of fields the originator must provide for this type | No | Stored in requiredFields (array). Each chosen item becomes a mandatory fill-in requirement when registering a receivable of that type. |
| Active | Enables/disables the type | Yes (default Yes) | Stored in active; inactive types must not be offered in new registrations. |
The screen tolerates both JSON format and the PostgreSQL array format (
{invoice_number,invoice_key}) when reopening a type for editing — you do not need to worry about serialization.
Actions and modals
- Create / Update: saves the type via
createReceivableType/updateReceivableType. Button visible only withcreditConfigManage. - Add / Remove required field: manipulate the
requiredFieldslist. - Edit (pencil icon): loads the type and rebuilds the required fields list.
Because this is a structural credit configuration, saving may require step-up (password + MFA) depending on the environment.
Business rules / considerations
Attention
- Required fields become validation at the source. Marking
invoice_keyas required, for example, prevents registering a receivable of that type without the NFe key — align the requirement with what the originator can actually provide. - Code must be stable. Since
codeis the type's reference key, avoid changing it after receivables have already been linked to it. - Deactivate instead of deleting. Use
Active = Noto discontinue a type without breaking historical receivables.
Related screens
- Credit Policies — fields such as
hasInvoiceValidationconnect to the NFe requirement. - Pricing Templates
- Credit Guide
- Tokenized Credit (group index)