Pular para o conteúdo principal

Visão geral de clientes

Esta seção explica o que a API considera como cliente, como o cliente se relaciona com um estabelecimento, e quais são as diferenças práticas entre tipos de cliente.

O que é “cliente” na API​

Em geral, o “cliente” é o cadastro base (jump_clients) e suas configurações por estabelecimento (jump_client_settings), onde ficam regras como:

  • recorrência e vencimento de faturas
  • tolerância e multa
  • vagas e permissões (ex.: dias/horários)
  • status do vínculo com o estabelecimento

Tipos de cliente (clientTypeId) e diferenças​

O clientTypeId muda regras de cobrança/fatura e também validações de datas.

Nesta documentação consideramos apenas os tipos: 1 (Avulso), 2 (Mensalista) e 4 (Pós-pago).

Tipo 1 - Avulso (AVULSO = 1)​

Cliente sem modelo de cobrança recorrente por fatura “mensalista”. Na prática, tende a operar mais por consumo/lançamentos do dia a dia, e as regras de fatura (quando existirem) costumam ser menos centrais do que nos tipos 2 e 4.

Tipo 2 - Mensalista (FATURA_FIXA = 2) (nuâncias importantes)​

Este tipo costuma ter regras específicas no onboarding:

  • permissões/dias podem começar vazias (em vez de “todos os dias”)
  • ao ativar/inativar o cliente, pode haver efeitos colaterais em faturas pendentes (status)
  • validações de vencimento podem ser mais restritivas para datas no passado

Tipo 4 - Pós-pago (POS_PAGO = 4)​

É tratado como pós-pago em vários fluxos de fatura:

  • Fechamento de fatura (close) é tipicamente permitido/esperado nesses tipos.
  • Pagamento de fatura pode ser bloqueado quando a fatura ainda está “aberta” pela regra de closingDateTime.
  • Ao fechar uma fatura, o sistema pode gerar a próxima fatura recorrente.

Faturas e relação com o cliente​

Os endpoints de clientes incluem atalho para faturas, e o cliente influencia:

  • cálculo de multa e tolerância na visualização da fatura
  • regras de fechamento/pagamento (principalmente pós pago)
  • criação de faturas recorrentes após ações (pagar/fechar/cancelar)

Veja também a seção de faturas: Visão geral de faturas.