Skip to main content

​
Campos

CampoTipoDescrição
receivableIdUUIDIdentificador único
paymentIdUUIDReferência ao pagamento que originou o recebível
organizationIdUUIDReferência à organização da empresa beneficiária
companyIdUUIDReferência à empresa beneficiária
externalProviderStringNome do provedor externo
externalProviderIdStringID da transação no provedor externo
amountIntValor do recebível em centavos
gatewayFeeRateIntRate dinâmico inferido do webhook em basis points
gatewayFeeIntValor absoluto em centavos recebido via webhook do gateway
statusReceivableStatusStatus do recebível
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

​
Relacionamentos

​
Regras de Negócio

  • O paymentId é obrigatório — todo recebível é rastreável ao pagamento que o originou.
  • organizationId e companyId identificam a empresa beneficiária do recebível.
  • O gatewayFeeRate e gatewayFee são dinâmicos — reportados pelo provedor de pagamento na sincronização, não pré-configurados.
  • O valor (amount) é o valor líquido reportado para o recebível em centavos.
  • O par externalProvider + externalProviderId evita duplicidade na sincronização com o provedor.
  • O saldo disponível para saque é consultado diretamente no provedor; recebíveis e transferências não possuem vínculo individual.

​
Sincronização de Recebíveis

Os recebíveis são sincronizados a partir do provedor de pagamento quando uma cobrança é confirmada e pela rotina periódica de conciliação. A sincronização localiza o pagamento por identificadores externos e atualiza o recebível de forma idempotente.

​
Enums

​
ReceivableStatus

O status é copiado diretamente do provedor de pagamento a cada sincronização. Default WAITING_FUNDS.
ValorDescrição
WAITING_FUNDSAguardando liquidação dos fundos no provedor
PREPAIDAntecipado
PAIDLiquidado/pago
CANCELLEDCancelado

​
Example

{
  "receivableId": "0197a817-5fb6-7ed8-a75e-27cc15afd0ac",
  "paymentId": "0197a816-281b-72e7-8f50-286fbfc5c08d",
  "organizationId": "0197a801-1690-7590-b3cf-19599b9be3e4",
  "companyId": "0197a801-6a42-79aa-9e56-d3c85148c0fa",
  "externalProvider": "billing_interface",
  "externalProviderId": "recvb_9fa13571",
  "amount": 11001,
  "gatewayFeeRate": 350,
  "gatewayFee": 399,
  "status": "WAITING_FUNDS",
  "createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "createdAt": "2026-07-03T16:02:30.000Z",
  "updatedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "updatedAt": "2026-07-03T16:02:30.000Z"
}