Documentação

English

Português
Español

English

Português
Español

Appearance

Receivables ​

Access Prerequisites

  • Permission (module): viewCredits (list/view and operate the receivable lifecycle).
  • License/Feature: CREDIT_INVESTMENTS enabled on the tenant license (Vault).
  • Menu container: TOKENIZATION → group Tokenized Credit

What it is / when to use ​

The Receivables screen manages the instruments (invoices, trade notes, contracts) that back credit operations. Each receivable belongs to an originator, optionally to a drawee/debtor, and has a receivable type (which defines the required fields). It is the base asset that, once approved, is assigned/anticipated within a Deal.

Use this screen to review receivables, attach/check documents (NFe, contracts), generate installments, and move each receivable through its lifecycle: draft → submitted → approved/rejected.

Prerequisites ​

  • Permission: viewCredits (a dual permission — CPM enum + dynamic module in the DB).
  • License/Feature: CREDIT_INVESTMENTS enabled. Without it, the group does not appear in the menu at all.
  • Dependencies on other screens: the originator (and the drawee, if any) must exist in Parties; the receivable type must be registered in Receivable Types — it is loaded to resolve the label in the list.

Step by step ​

  1. Access the menu Tokenized Credit → Receivables.
  2. Filter by Status and use the search.
  3. Open a receivable (row or ⋮ → View).
  4. Use ⋮ → Documents to attach/view the NFe and other files.
  5. Use ⋮ → Installments to generate/view the installment breakdown from the gross amount.
  6. For a draft receivable, use ⋮ → Submit for approval; then Approve or Reject.

Filters and columns ​

Filter/ColumnWhat it showsData source
External referenceIdentifier of the instrument in the source systemReceivable.externalReference
Receivable typeCategory (resolved to the name via map)Receivable.receivableTypeId → Receivable Types
OriginatorAssignor of the instrumentReceivable.originatorId
Gross amountFace valueReceivable.grossAmount (BigNumber)
Net amountValue after discountsReceivable.netAmount
Due dateInstrument due dateReceivable.dueDate
StatusDRAFT, PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, DISCOUNTED, SETTLED, DEFAULTReceivable.status (filter statusFilter)
Created atRegistration dateReceivable.createdAt

Actions and modals ​

  • View / Edit / Create: routes credit-receivables/view|edit|create.
  • Documents: opens the documents dialog (ReceivableDocumentsDialog) to attach/list files (NFe, contract) linked by receivableId.
  • Installments: opens the installments dialog (ReceivableInstallmentsDialog), which distributes the grossAmount into installments; each installment becomes the basis for a future Charge.
  • Submit for approval: submitReceivableForApproval(id) — moves from DRAFT to PENDING_APPROVAL. On error, the backend message is displayed (e.g.: required fields of the type missing).
  • Approve / Reject: approveReceivable(id) / rejectReceivable(id) after confirmation — they trigger evaluation of the Policies with RECEIVABLE scope.

Approving/rejecting/submitting may trigger step-up (password + MFA, X-Step-Up-Token) depending on the environment — identity reconfirmation, not 4-eyes.

Business rules / considerations ​

Attention

  • The type defines the required fields. Submitting may fail if the Receivable Type requires fields that are not filled in — the error message comes from the backend.
  • RECEIVABLE policies run at approval. E.g.: "NFe not validated" may force manual review or rejection (see examples in Policies).
  • Installments feed the charges. The installment breakdown generated here is the source of the Charges PIX/Boleto sent to the drawee.
  • Financial values: grossAmount/netAmount and installment values are BigNumber on the backend — the sum of installments must match the gross amount; do not round.

Examples ​

Scenario 1 — NFe receivable submitted and approved
  1. Create a receivable with type "Duplicata NFe", originator, external reference and gross amount.
  2. ⋮ → Documents → attach the NFe XML/PDF.
  3. ⋮ → Submit for approval → status becomes PENDING_APPROVAL.
  4. ⋮ → Approve → the RECEIVABLE Policies run; if they pass, the receivable moves to APPROVED and becomes eligible to be included in a Deal.
Scenario 2 — Split a receivable before charging
  1. Open the approved receivable.
  2. ⋮ → Installments → distribute the gross amount into N installments with due dates.
  3. Each generated installment becomes the basis for a Charge to the drawee on the Charges screen.
Scenario 3 — Receivable blocked by policy
  1. Submit a receivable without tax validation.
  2. At approval, the "NFe not validated" Policy (RECEIVABLE scope, Manual Review action) prevents auto-approval and sends the item for human analysis.