Skip to main content

Customers (Persons)

Customers are represented by the Person model (Person) with different types depending on the context.

Person Types​

TypeDescription
organizationTenant/organization that uses the platform
customerCustomer of an organization
contactSecondary contact

Customer Fields​

FieldDescription
NameName or legal name
NicknameTrade name
Legal nameFull legal name
Document typeCPF or CNPJ
Document numberNormalized (digits only)
Naturenatural (individual) or juridical (legal entity)
Date of birthOptional
AddressesList of addresses (JSON)
PhonesList of phone numbers (JSON)
EmailsList of emails (JSON)
WebsitesList of websites (JSON)
TagsList of tags for categorization
NotesInternal observations
Custom dataCustom fields (JSON)

Hierarchy​

Customers belong to an organization via the parent_id field:

Organization (type=organization, parentId=null)
├── Customer A (type=customer, parentId=org_id)
├── Customer B (type=customer, parentId=org_id)
└── Contact (type=contact, parentId=org_id)

Validations​

  • Document number unique within the organization
  • External code (external_id) unique per organization
  • Document format restrictions: CPF (11 digits) or CNPJ (14 digits)

Screenshots​

Customer list​

The /dashboard/customers screen lists the organization's customers with search by name, document or email. The table shows document, email, total linked billing accounts and consolidated MRR.

List of customers with name, document and billing accounts

Customer detail​

The /dashboard/customers/[id] page brings together registration data, linked billing accounts, subscriptions, invoices, payments, NF-e and audit — all in a single context for support and finance.

Customer detail with billing, subscription and invoice tabs