Skip to main content
O domínio Billing gerencia o ciclo financeiro das vendas de passagens: pagamento, conciliação de recebíveis, saldo e transferência para contas bancárias das empresas.

Entidades

Payment Lifecycle

Métodos, status e fluxos de pagamento; confirmação via webhook do provedor.

Billing Provider

Contrato genérico de integração e configuração externa por Company.

Receivables

Recebíveis sincronizados do provider para conciliação financeira.

Transfers

Saques do saldo da empresa para sua conta bancária.

Fluxo de Billing

Conceitos-Chave

  • Payment é o pagamento único de um Order (relação 1:1). A confirmação chega via webhook do provedor (PaymentStatus = PAID) ou pode nascer confirmada em POS com dinheiro.
  • Billing Provider define a superfície de integração para pagamentos, recebíveis, contas bancárias e transferências.
  • PaymentMethod pertence ao Customer e funciona como proxy local do gateway.
  • CompanyPaymentSettings guarda a configuração externa de billing da empresa, incluindo a API key criptografada.
  • Receivable é o registro de conciliação de valores a receber por empresa, sincronizado do provedor. O gatewayFee é reportado pelo provedor.
  • BankAccount é a conta bancária cadastrada por cada empresa.
  • Transfer é o saque do saldo disponível (consultado no provedor) para a conta bancária.
  • Entidades de billing carregam organizationId e companyId para deixar explícita a empresa beneficiária.
  • Os métodos aceitos no modelo atual são dinheiro, PIX, cartão de crédito e cartão de débito.
  • Cooperative não participa do fluxo financeiro.
Todos os valores monetários são armazenados em centavos (integer). O gateway fee é reportado pelo provider e pode ter rate derivado para conciliação.