Skip to content

Receivable Types

Access prerequisites

  • Permission (module): creditConfigManage (to create/edit). Read access granted by viewCredits.
  • License/Feature: CREDIT_INVESTMENTS enabled 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_INVESTMENTS enabled.
  • Dependencies: none. Types are consumed later when creating receivables.

Step by step

  1. Go to Tokenized Credit → Receivable Types.
  2. Filter by Active if needed.
  3. Click Create.
  4. Fill in Code and Name.
  5. 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.
  6. Click Save.

Fields

FieldWhat it isRequired?System/backend effect
CodeShort/unique identifier for the type (e.g.: DUPLICATA)YesStored in code; used as the type's reference key.
NameFriendly name of the typeYesStored in name; appears in listings and selectors.
Required fieldsList of fields the originator must provide for this typeNoStored in requiredFields (array). Each chosen item becomes a mandatory fill-in requirement when registering a receivable of that type.
ActiveEnables/disables the typeYes (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 with creditConfigManage.
  • Add / Remove required field: manipulate the requiredFields list.
  • 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_key as 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 code is the type's reference key, avoid changing it after receivables have already been linked to it.
  • Deactivate instead of deleting. Use Active = No to discontinue a type without breaking historical receivables.