Skip to main content

Campos

CampoTipoDescrição
customerIdUUIDIdentificador único
userIdUUIDReferência ao usuário
externalProviderStringIdentificador lógico do provider de billing usado pela interface
externalProviderIdStringIdentificador do customer no provedor de billing
documentStringNúmero do documento
documentTypeDocumentTypeTipo do documento
birthDateDate?Data de nascimento
phoneIsoStringCódigo ISO do país do telefone
phoneDdiStringDDI do telefone
phoneNumberStringNúmero do telefone
phoneVerifiedBooleanIndica se o telefone foi verificado. Default: false
createdByUUID?Usuário que criou o registro, quando aplicável
createdAtDateTimeData de criação
updatedByUUID?Usuário que fez a última atualização, quando aplicável
updatedAtDateTimeData da última atualização
deletedByUUID?Usuário que removeu o registro, quando aplicável
deletedAtDateTime?Data de remoção

Relacionamentos

Regras de Negócio

  • Cada User possui no máximo um Customer (relação 1:1). O Customer representa o perfil de passageiro — quem compra passagens.
  • Quando o mesmo User possui Employee em uma Company, esse Customer pode receber créditos concedidos por regra de funcionário nessa Company.
  • Ao criar o Customer, o sistema registra um customer correspondente no provider de billing e guarda externalProvider + externalProviderId.
  • O document é obrigatório no cadastro do Customer e deve ser único.
  • O endereço inicial é criado junto com o Customer e marcado como isDefault = true.

Enums

DocumentType

ValorDescrição
CPFCadastro de Pessoa Física
CNPJCadastro Nacional da Pessoa Jurídica
RGRegistro Geral

Example

{
  "customerId": "0197a7f6-4d36-7c0a-a7cb-54fcb33a3148",
  "userId": "0197a7f5-2a88-7c1e-9b65-1f6d8f3b3a10",
  "externalProvider": "billing_interface",
  "externalProviderId": "cus_8f3b2a91",
  "document": "12345678909",
  "documentType": "CPF",
  "birthDate": "1992-04-18",
  "phoneIso": "BR",
  "phoneDdi": "55",
  "phoneNumber": "11987654321",
  "phoneVerified": true,
  "createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "createdAt": "2026-07-03T12:00:10.000Z",
  "updatedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "updatedAt": "2026-07-03T12:00:10.000Z",
  "deletedBy": null,
  "deletedAt": null
}