CashSettlement

​

Campos

​

Relacionamentos

• Relaciona-se com CheckoutSession por checkoutSessionId único. Cada CheckoutSession confirmada com paymentMethod = CASH possui exatamente um CashSettlement.
• Relaciona-se com Organization por organizationId.
• Relaciona-se com Cooperative por cooperativeId.
• Relaciona-se com TransportOperator por transportOperatorId.
• Relaciona-se com Driver por driverId.
• Relaciona-se opcionalmente 1:1 com Payment por Payment.cashSettlementId único. O vínculo é obrigatório quando status = CONFIRMED.

​

Regras de Negócio

• A confirmação de uma CheckoutSession com paymentMethod = CASH cria e envia o CashSettlement automaticamente com status = PENDING.
• O mesmo fluxo cria o Payment CASH com channel = DRIVER_APP e status = PAID, mas mantém Payment.cashSettlementId = null até a confirmação pela OPS.
• O fluxo CASH de CheckoutSession deve produzir exatamente um Payment para preservar as relações 1:1.
• declaredAmount é preenchido automaticamente com o valor em dinheiro da venda e não é informado por um endpoint de criação ou envio.
• organizationId, cooperativeId, transportOperatorId e driverId repetem o contexto da Trip no momento da venda para manter o registro financeiro auditável.
• Confirmar a prestação e preencher Payment.cashSettlementId ocorre na mesma transação.
• Um CashSettlement CONFIRMED deve possuir exatamente um Payment vinculado, e um Payment não pode pertencer a mais de um CashSettlement.
• Um CashSettlement PENDING ou REJECTED não possui Payment vinculado.
• Rejeitar a prestação não altera o status PAID do Payment nem invalida Order ou Ticket já emitidos.
• A criação e o envio são idempotentes por checkoutSessionId.

​

Enums

​

CashSettlementStatus

​

Example

{
  "cashSettlementId": "01981264-9aa0-7d18-a4a4-3b9a9a3a1c13",
  "checkoutSessionId": "01981255-3c7a-7bd4-bb5f-8b47bc4dce91",
  "organizationId": "0197a7f7-7291-7a43-96db-2c8580b80c5d",
  "cooperativeId": "0197a800-24e6-76a2-90ed-ff0f6fba7b0c",
  "transportOperatorId": "01980d30-6a3c-7a42-9182-17ad6324d3aa",
  "driverId": "0197a807-1ec7-75e8-8ff8-df64dd070046",
  "declaredAmount": 11400,
  "status": "CONFIRMED",
  "submittedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "submittedAt": "2026-07-08T12:11:08.000Z",
  "confirmedBy": "0197a806-7a50-7d8d-b2ea-07748f4e38f7",
  "confirmedAt": "2026-07-08T18:45:00.000Z",
  "rejectedBy": null,
  "rejectedAt": null,
  "rejectionReason": null,
  "createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "createdAt": "2026-07-08T12:11:08.000Z",
  "updatedBy": "0197a806-7a50-7d8d-b2ea-07748f4e38f7",
  "updatedAt": "2026-07-08T18:45:00.000Z"
}