Pagamentos — Regras de Negócio

1. Conceito

O Pagamento (ContractPayment) é a unidade mínima de cobrança dentro de um contrato. Representa uma obrigação de pagamento individual com valor nominal e data de vencimento definidos. Um contrato agrupa um ou mais pagamentos, que em conjunto correspondem ao valor total da operação formalizada.

Pagamentos não são subdivisíveis — cada pagamento é uma parcela atômica e indivisível. Renegociações que resultam em novos vencimentos ou valores devem ser tratadas como cancelamento do pagamento original e criação de novos pagamentos no contrato substituto.

O ciclo de vida de um pagamento é independente do contrato, mas impacta diretamente o status do contrato pai (ver Contratos.md, seção 2.4 — transições automáticas de ACTIVE → OVERDUE → DEFAULTED).

1.1. Relação com o tipo do contrato

O tipo do pagamento é restrito pelo tipo do contrato pai. Cada tipo de contrato define, via allowedPaymentTypes no seu schema, quais tipos de pagamento são permitidos. O tipo padrão na criação é herdado de paymentDefaults.typeDefault do schema do contrato.

O comportamento de cálculo de encargos (juros, multa, desconto) também é condicionado pelo tipo do contrato. Contratos cujo schema define paymentDefaults.interestApplicable = false (ex: CPR_PHYSICAL) não terão cálculo automático de juros nos seus pagamentos.

1.2. Correção monetária

Para contratos com correctionIndex != NONE, os pagamentos exibem um campo calculado amounts.corrected que representa o valor da parcela atualizado pelo índice de correção até a data da consulta. Esse valor é informativo — não altera o amounts.value armazenado. A correção efetiva é aplicada no momento do registro de baixa (ver Baixas.md).

2. Estruturas de Dados

2.1. ContractPayment

Contrato de API (não confundir com armazenamento). Esta tabela descreve o payload das respostas e requisições da API. A estrutura aninhada (amounts, charges, discount, createdBy) é resultado de serialização — o modelo de dados em 12. Modelo de Dados.md armazena os campos em colunas flat. O backend hidrata e agrupa na hora de devolver.

Campos top-level

Campo	Tipo	Obrigatório	Descrição
`id`	UUID	Sim	Identificador único do pagamento.
`contractId`	UUID	Sim	Contrato ao qual o pagamento pertence.
`companyId`	UUID	Sim	Empresa. Desnormalizado para facilitar consultas.
`code`	String	Não	Código ou número do pagamento (ex: `NF-001`, `CPR-2024-03`). Único por contrato quando informado.
`type`	Enum	Sim	Tipo: `CPR`, `INVOICE`, `PURCHASE_SALE_CONTRACT`, `CCB`, `PROMISSORY_NOTE`, `OTHER`. Deve estar contido no `allowedPaymentTypes` do schema do contrato pai. Quando omitido na criação, herda `paymentDefaults.typeDefault`.
`description`	String	Condicional	Descrição livre. Obrigatório quando `type = OTHER`.
`dueDate`	DateTime (ISO 8601 UTC)	Sim	Data de vencimento.
`status`	Enum	Sim	`PENDING`, `PAID`, `PARTIALLY_PAID`, `OVERDUE`, `DEFAULTED`, `RENEGOTIATED`, `CANCELLED`. Fixo em `PENDING` na criação manual via POST. Em importação (ver `Importação.md`) aceita outros valores para migração de parcelas legadas.
`overdueDays`	Integer	Não	Dias em atraso. Calculado em tempo de leitura quando em atraso. `null` para demais status.
`amounts`	Object	Sim	Objeto com os valores monetários da parcela. Ver detalhe abaixo.
`charges`	Object	Sim	Objeto com encargos (juros, multa, desconto). Sempre presente, mesmo quando todos os componentes estão `null`. Ver detalhe abaixo.
`createdBy`	Object	Sim	Usuário que criou, hidratado: `{ id, name }`. Ver detalhe abaixo.
`createdAt`	DateTime (ISO 8601 UTC)	Sim	Data de criação.
`updatedAt`	DateTime (ISO 8601 UTC)	Sim	Data da última atualização.
`paidAt`	DateTime (ISO 8601 UTC)	Não	Data em que foi integralmente liquidado. Preenchido ao mover para `PAID`.
`defaultedAt`	DateTime (ISO 8601 UTC)	Não	Data em que foi marcado como inadimplência formal. Preenchido ao mover para `DEFAULTED`.
`cancelledAt`	DateTime (ISO 8601 UTC)	Não	Data de cancelamento.

`amounts` (objeto)

Campo	Tipo	Obrigatório	Descrição
`amounts.value`	Decimal	Sim	Valor da parcela em BRL — o valor original da obrigação, sem acréscimos.
`amounts.corrected`	Decimal	Não	Valor da parcela corrigido pelo índice de correção monetária do contrato. Campo calculado em tempo de leitura. `null` quando `correctionIndex = NONE`.
`amounts.due`	Decimal	Não	Valor total devido: `corrected ?? value + charges.interest + charges.fine − charges.discount.calculatedAmount`. Campo calculado em tempo de leitura.
`amounts.received`	Decimal	Não	Valor total efetivamente recebido. Soma do `receivedAmount` de todas as baixas com `status = ACTIVE` (ver `Baixas.md`).
`amounts.remaining`	Decimal	Não	Valor em aberto: `due − received`. Campo calculado em tempo de leitura.

`charges` (objeto)

Campo	Tipo	Obrigatório	Descrição
`charges.interest`	Decimal	Não	Juros de mora calculados automaticamente em tempo de leitura. `null` quando não aplicável ou parcela não está em atraso.
`charges.fine`	Decimal	Não	Multa por atraso. Aplicada a partir do 1º dia de atraso. `null` quando não aplicável.
`charges.discount`	Object	Sim	Objeto de desconto. Sempre presente, mesmo quando não há desconto configurado (nesse caso, `type` e `value` ficam `null`). Ver detalhe abaixo.

`charges.discount` (objeto)

Campo	Tipo	Obrigatório	Descrição
`charges.discount.type`	Enum	Não	`FIXED` ou `PERCENTAGE`. `null` quando não há desconto configurado.
`charges.discount.value`	Decimal	Não	Quando `type = FIXED`, valor monetário do desconto. Quando `type = PERCENTAGE`, percentual aplicado sobre `amounts.value`. `null` quando `type` é `null`.
`charges.discount.calculatedAmount`	Decimal	Não	Valor monetário efetivo do desconto. Quando `type = FIXED`, igual a `discount.value`. Quando `type = PERCENTAGE`, `amounts.value × (discount.value / 100)`. Campo calculado em tempo de leitura. `null` quando não há desconto.

`createdBy` (objeto)

Campo	Tipo	Obrigatório	Descrição
`createdBy.id`	UUID	Sim	ID do usuário que criou a parcela.
`createdBy.name`	String	Sim	Nome do usuário, hidratado pelo backend a partir do User vinculado.

2.2. Ciclo de vida

PENDING ◄──► OVERDUE ──► DEFAULTED ──► PAID / PARTIALLY_PAID / RENEGOTIATED / CANCELLED
         │                          ▲
         └──────────────────────────┘
         (PENDING também pode ir direto a PAID / PARTIALLY_PAID / RENEGOTIATED / CANCELLED)
         (OVERDUE volta a PENDING quando a parcela é liquidada antes da formalização da inadimplência)

Transição	Tipo	Descrição
PENDING → PAID	Automática (via baixa)	Baixa integral registrada.
PENDING → PARTIALLY_PAID	Automática (via baixa)	Baixa parcial. Valor menor que `amounts.due`.
PENDING → OVERDUE	Automática (via job)	`dueDate` ultrapassado. Job diário (`Pagamento → OVERDUE`).
PENDING → CANCELLED	Manual	Cancelamento administrativo.
PENDING → RENEGOTIATED	Manual (via contrato)	Substituído por renegociação do contrato pai.
PARTIALLY_PAID → PAID	Automática (via baixa)	Baixa do saldo restante (`amounts.remaining = 0`).
PARTIALLY_PAID → OVERDUE	Automática (via job)	Parcialmente pago mas `dueDate` ultrapassado e ainda há saldo aberto. Histórico de baixas anteriores preservado em `amounts.received`.
OVERDUE → PENDING	Automática (via job)	Parcela em atraso é liquidada antes da formalização da inadimplência (raro — ocorre se `dueDate` é movido para futuro via PATCH, situação anômala).
OVERDUE → PAID	Automática (via baixa)	Baixa integral após vencimento.
OVERDUE → PARTIALLY_PAID	Automática (via baixa)	Baixa parcial após vencimento.
OVERDUE → DEFAULTED	Automática (via job) ou Manual	Job: `daysToDefault` do contrato ultrapassado. Manual: usuário marca via `PUT /status`.
OVERDUE → RENEGOTIATED	Manual (via contrato)	Renegociação do contrato.
DEFAULTED → PAID	Automática (via baixa)	Baixa integral mesmo após inadimplência formal.
DEFAULTED → PARTIALLY_PAID	Automática (via baixa)	Baixa parcial após inadimplência.
DEFAULTED → RENEGOTIATED	Manual (via contrato)	Renegociação.
DEFAULTED → CANCELLED	Manual	Cancelamento administrativo após inadimplência.

2.3. Status técnico e label de exibição (referência para frontend)

O backend devolve sempre o campo status técnico (enum). O label exibido na UI é derivado pelo frontend a partir desse status — não é um campo retornado pela API.

status (backend)	Label exibida (frontend)
`PENDING`	"Em aberto"
`OVERDUE`	"Em atraso"
`DEFAULTED`	"Inadimplente"
`PARTIALLY_PAID`	"Parcialmente pago"
`PAID`	"Pago"
`RENEGOTIATED`	"Renegociado"
`CANCELLED`	"Cancelado"

2.4. Cálculo de encargos

Configuração de encargos

Os encargos são configurados no contrato (finePercentage, dailyInterestPercentage) e condicionados pelo tipo via paymentDefaults do template. Não existe hierarquia multi-nível — o contrato é a fonte única de configuração.

Fonte	Descrição
Contrato	`finePercentage` e `dailyInterestPercentage` definem os percentuais. Quando não informados, encargos não são calculados.
Template (`paymentDefaults`)	Define se juros, multa e desconto são aplicáveis. Quando `interestApplicable = false`, o cálculo é ignorado independente do que estiver no contrato.
Sobrescrita na baixa	No momento da baixa, o usuário pode informar valores diferentes dos calculados. Ver `Baixas.md`.

Aplicabilidade condicionada ao tipo

O schema do tipo do contrato define via paymentDefaults:

paymentDefaults	Efeito
`interestApplicable = false`	`charges.interest` permanece `null`. Juros não calculados.
`fineApplicable = false`	`charges.fine` permanece `null`.
`discountApplicable = false`	Objeto `charges.discount` é aceito mas `type`/`value` rejeitados na criação. Permanece como `{ type: null, value: null, calculatedAmount: null }`.

Fórmulas

Todas as fórmulas abaixo referenciam campos do objeto serializado conforme seção 2.1. No armazenamento (doc 12), os campos são flat (nominalAmount, interestAmount, etc. — nomes das colunas pendentes de alinhamento com a nomenclatura value); aqui usamos a notação aninhada do contrato de API.

Juros de mora (charges.interest):

Método SIMPLE:

charges.interest = amounts.value × (contract.dailyInterestPercentage / 100) × overdueDays

Método COMPOUND:

charges.interest = amounts.value × ((1 + contract.dailyInterestPercentage / 100) ^ overdueDays − 1)

Conversão quando dailyInterestPercentage do contrato não informado:

MONTHLY: dailyRate = contract.interestRate / 30

ANNUAL: dailyRate = contract.interestRate / 365

Multa (charges.fine):

charges.fine = amounts.value × (contract.finePercentage / 100)

Aplicada integralmente a partir do 1º dia de atraso. Não acumula por dia.

Desconto (charges.discount.calculatedAmount):

Quando charges.discount.type = FIXED: calculatedAmount = charges.discount.value.

Quando charges.discount.type = PERCENTAGE: calculatedAmount = amounts.value × (charges.discount.value / 100).

Quando charges.discount.type = null: calculatedAmount = null.

Correção monetária (amounts.corrected):

amounts.corrected = amounts.value × (índice acumulado no período)

null quando contract.correctionIndex = NONE.

Total devido (amounts.due):

base = amounts.corrected ?? amounts.value
amounts.due = base + (charges.interest ?? 0) + (charges.fine ?? 0) − (charges.discount.calculatedAmount ?? 0)

Desconto só é subtraído quando o pagamento está PENDING e a data de baixa é anterior ou igual ao dueDate. Após o vencimento, o calculatedAmount deixa de ser aplicado no cálculo de due (o desconto vira informativo).

Valor em aberto (amounts.remaining):

amounts.remaining = amounts.due − amounts.received

3. Regras de Negócio

Criação e vínculo

RN-PAY-001: Vínculo obrigatório com contrato ativo
Pagamentos só podem ser criados em contratos com status = DRAFT, ACTIVE ou OVERDUE. Erro: INVALID_CONTRACT_STATUS.

RN-PAY-002: Unicidade de código por contrato
O code, quando informado, deve ser único dentro do contrato. Erro: PAYMENT_CODE_ALREADY_EXISTS.

RN-PAY-003: Vencimento dentro da vigência do contrato
O dueDate deve estar dentro do intervalo startDate — endDate do contrato. Erro: DUE_DATE_OUT_OF_CONTRACT_RANGE.

RN-PAY-004: Tipo restrito pelo contrato
O type deve estar em allowedPaymentTypes do schema do contrato. Quando omitido, herda paymentDefaults.typeDefault. Erro: INCOMPATIBLE_PAYMENT_TYPE.

RN-PAY-004B: Status na criação
O campo status é fixo em PENDING no POST /payments (criação manual) — não pode ser informado pelo cliente. Em importação (ver Importação.md), o campo status é aceito no payload para permitir migração de parcelas legadas já em estados como PAID, PARTIALLY_PAID ou CANCELLED. Erro: INVALID_STATUS_TRANSITION quando o valor informado em importação é inválido para o ciclo de vida da parcela.

RN-PAY-005: Alerta de divergência com value do contrato
Ao adicionar ou remover pagamentos, o sistema verifica se a soma dos amounts.value das parcelas corresponde ao amounts.value do contrato. Divergências geram alerta TOTAL_AMOUNT_MISMATCH (não bloqueante).

Transições de status

RN-PAY-006: Transição automática para OVERDUE
Job diário (Pagamento → OVERDUE, ver Visão Geral, seção 11) move pagamentos PENDING ou PARTIALLY_PAID com dueDate ultrapassado para OVERDUE. Quando o status passa de PARTIALLY_PAID para OVERDUE, o amounts.received (valor já liquidado por baixas anteriores) é preservado — a trilha histórica de pagamentos parciais não é perdida.

RN-PAY-007: Transição para DEFAULTED
A transição OVERDUE → DEFAULTED ocorre por duas vias:

Automática: job diário (Pagamento → DEFAULTED) move parcelas em OVERDUE para DEFAULTED quando o prazo daysToDefault do contrato (ver Contratos.md, seção 2.1) é ultrapassado contado a partir do dueDate.

Manual: usuário marca explicitamente via PUT /status, quando a operação reconhece a inadimplência formalmente antes do prazo configurado.

Quando o contrato não tem daysToDefault configurado, a transição automática não ocorre — DEFAULTED só por marcação manual.

RN-PAY-008: Impacto no contrato
Parcelas em OVERDUE ou DEFAULTED fazem o contrato transitar para OVERDUE (e eventualmente DEFAULTED) conforme regras documentadas em Contratos.md (RN-CONT-011 e RN-CONT-012).

RN-PAY-009: Cancelamento direto
Apenas pagamentos com status = PENDING podem ser cancelados diretamente via PUT /status. Pagamentos em OVERDUE, PARTIALLY_PAID, DEFAULTED ou PAID exigem fluxos específicos: renegociação (via contrato) ou cancelamento de baixa (ver Baixas.md — não há estorno no domínio). Erro: PAYMENT_NOT_CANCELLABLE.

RN-PAY-010: Renegociação
Transição para RENEGOTIATED ocorre em conjunto com a renegociação do contrato. Todos os pagamentos em aberto (PENDING, OVERDUE, DEFAULTED, PARTIALLY_PAID) são movidos simultaneamente.

Encargos

RN-PAY-011: Cálculo automático
A partir de OVERDUE, o sistema recalcula diariamente charges.interest e charges.fine com base nos percentuais definidos no contrato (finePercentage, dailyInterestPercentage). Quando os percentuais não estão configurados no contrato, os encargos correspondentes não são calculados (null).

RN-PAY-012: Sobrescrita na baixa
Na baixa, o usuário pode informar valores diferentes dos calculados para encargos. Ver Baixas.md.

RN-PAY-013: Baixa parcial e múltiplas baixas até liquidar
Quando o valor da baixa é menor que amounts.due, o pagamento transita para PARTIALLY_PAID e o amounts.remaining é recalculado. Múltiplas baixas parciais são permitidas — a parcela permanece em PARTIALLY_PAID enquanto houver saldo aberto. Transita para PAID quando amounts.remaining = 0. A multa (charges.fine) é aplicada uma única vez sobre o título (não acumula por baixa).

RN-PAY-014: Configuração de desconto
O objeto charges.discount é sempre presente na resposta, mesmo quando não há desconto configurado (nesse caso type, value e calculatedAmount ficam null). Na criação ou edição, o campo charges.discount.type aceita FIXED ou PERCENTAGE. value deve ser numérico positivo. Quando o type é informado, value é obrigatório (e vice-versa) — informar um sem o outro gera erro INVALID_DISCOUNT_CONFIG. Quando paymentDefaults.discountApplicable = false, qualquer configuração de desconto (type/value não nulos) é rejeitada. Erro: DISCOUNT_NOT_ALLOWED. O campo calculatedAmount é sempre derivado em tempo de leitura — não pode ser enviado pelo cliente; se enviado, é ignorado.

Edição e exclusão

RN-PAY-015: Edição restrita a PENDING
Apenas pagamentos PENDING podem ser editados via PATCH. Erro: PAYMENT_IMMUTABLE.

RN-PAY-016: Exclusão lógica
Nunca deletados fisicamente. Encerramento via CANCELLED ou PAID.

4. Padrão de Erros

Códigos de erro específicos

Status	Código	Descrição
404	`PAYMENT_NOT_FOUND`	Pagamento não encontrado.
409	`PAYMENT_CODE_ALREADY_EXISTS`	Código duplicado no contrato.
422	`INVALID_CONTRACT_STATUS`	Contrato não está em `DRAFT` ou `ACTIVE`.
422	`DUE_DATE_OUT_OF_CONTRACT_RANGE`	`dueDate` fora da vigência do contrato.
422	`INCOMPATIBLE_PAYMENT_TYPE`	Tipo não permitido para o contrato.
422	`MISSING_DESCRIPTION`	`type = OTHER` sem `description` informado.
422	`INVALID_STATUS_TRANSITION`	Status informado na criação ou transição requisitada não é permitida.
422	`PAYMENT_NOT_CANCELLABLE`	Apenas `PENDING` pode ser cancelado.
422	`PAYMENT_IMMUTABLE`	Pagamento em status que não permite edição.
422	`INVALID_DISCOUNT_CONFIG`	`charges.discount.type` informado sem `value` (ou vice-versa), ou valor não numérico/negativo.
422	`DISCOUNT_NOT_ALLOWED`	Desconto não aplicável ao tipo do contrato (`paymentDefaults.discountApplicable = false`).
422	`TOTAL_AMOUNT_MISMATCH`	Soma dos `amounts.value` das parcelas diverge do `amounts.value` do contrato (alerta).

5. Endpoints

Base path: /v2/companies/:companyId/portfolios/:portfolioId/contracts/:contractId/payments

POST .../payments

Cria um novo pagamento. Status fixo em PENDING na criação manual (RN-PAY-004B).

Permissão: payment:create

Request body (com desconto percentual):

{
  "code": "NF-001",
  "type": "INVOICE",
  "amounts": {
    "value": 150000.00
  },
  "dueDate": "2024-03-14T00:00:00.000+00:00",
  "charges": {
    "discount": {
      "type": "PERCENTAGE",
      "value": 2.0
    }
  }
}

Exemplo para contrato CPR_PHYSICAL (sem desconto):

{
  "code": "CPR-001",
  "amounts": {
    "value": 450000.00
  },
  "dueDate": "2025-04-15T00:00:00.000+00:00"
}

Response 201 Created:

{
  "id": "pay-001",
  "contractId": "contract-001",
  "companyId": "company-001",
  "code": "NF-001",
  "type": "INVOICE",
  "description": null,
  "dueDate": "2024-03-14T00:00:00.000+00:00",
  "status": "PENDING",
  "overdueDays": null,
  "amounts": {
    "value": 150000.00,
    "corrected": null,
    "due": 147000.00,
    "received": 0.00,
    "remaining": 147000.00
  },
  "charges": {
    "interest": null,
    "fine": null,
    "discount": {
      "type": "PERCENTAGE",
      "value": 2.0,
      "calculatedAmount": 3000.00
    }
  },
  "createdBy": {
    "id": "8c3f1a2b-...",
    "name": "João Silva"
  },
  "createdAt": "2025-03-17T09:00:00.000+00:00",
  "updatedAt": "2025-03-17T09:00:00.000+00:00",
  "paidAt": null,
  "defaultedAt": null,
  "cancelledAt": null
}

GET ...:contractId/payments

Lista pagamentos do contrato.

Permissão: payment:read

Query params:

Parâmetro	Tipo	Obrigatório	Descrição
`status`	Enum (multi)	Não	Filtrar por status.
`dueDateStart`	Date (ISO)	Não	`dueDate >=`.
`dueDateEnd`	Date (ISO)	Não	`dueDate <=`.
`orderBy`	Enum	Não	Ordenação: `dueDate`, `amounts.value`, `overdueDays`, `status`, `createdAt`. Default: `dueDate`.
`order`	Enum	Não	`asc` ou `desc`. Default: `asc`.
`offset`	Integer	Não	Default: 0.
`limit`	Integer	Não	Default: 20. Máximo: 100.

Response 200 OK:

{
  "items": [
    {
      "id": "pay-001",
      "contractId": "contract-001",
      "code": "NF-001",
      "type": "INVOICE",
      "description": null,
      "dueDate": "2026-05-13T13:32:32.209+00:00",
      "status": "OVERDUE",
      "overdueDays": 3,
      "amounts": {
        "value": 150000.00,
        "corrected": null,
        "due": 150225.00,
        "received": 0.00,
        "remaining": 150225.00
      },
      "charges": {
        "interest": 225.00,
        "fine": 3000.00,
        "discount": {
          "type": "PERCENTAGE",
          "value": 2.0,
          "calculatedAmount": null
        }
      },
      "createdBy": {
        "id": "8c3f1a2b-...",
        "name": "João Silva"
      },
      "createdAt": "2025-03-17T09:00:00.000+00:00",
      "updatedAt": "2025-03-17T09:00:00.000+00:00",
      "paidAt": null,
      "defaultedAt": null,
      "cancelledAt": null
    }
  ],
  "nextPage": false
}

Nota sobre o exemplo acima: charges.discount.calculatedAmount aparece como null porque a parcela está em OVERDUE — após o vencimento o desconto deixa de ser aplicado (RN-PAY-014 + seção 2.4). A configuração (type e value) permanece registrada.

GET .../payments/:paymentId

Detalhe completo com encargos calculados até o momento da consulta.

Permissão: payment:read

Response 200 OK: Mesmo formato do POST response com todos os campos.

PATCH .../payments/:paymentId

Atualiza dados. Apenas status = PENDING.

Permissão: payment:update

Campos editáveis: code, type, description, dueDate, amounts.value, charges.discount.type, charges.discount.value.

Os demais campos de amounts e charges são derivados em tempo de leitura e não podem ser enviados pelo cliente — se enviados, são ignorados.

Request body (editar valor da parcela e remover desconto):

{
  "code": "NF-001-REV",
  "amounts": {
    "value": 155000.00
  },
  "dueDate": "2024-04-14T00:00:00.000+00:00",
  "charges": {
    "discount": {
      "type": null,
      "value": null
    }
  }
}

Response 200 OK: Pagamento atualizado completo (mesmo formato do POST response).

PUT .../payments/:paymentId/status

Substitui o status do pagamento. Usado para transições manuais (cancelamento, marcação manual de inadimplência).

Permissão: payment:update

Request body — cancelamento:

{
  "status": "CANCELLED",
  "reason": "Pagamento emitido com valor incorreto."
}

Request body — marcação manual de inadimplência:

{
  "status": "DEFAULTED",
  "reason": "Cliente comunicou impossibilidade de pagamento."
}

Response 200 OK:

{
  "id": "pay-001",
  "status": "CANCELLED",
  "cancelledAt": "2025-03-17T12:00:00.000+00:00",
  "updatedAt": "2025-03-17T12:00:00.000+00:00"
}

6. Permissões RBAC

Resource	Domínio	Actions
`payment`	TENANT	`create`, `read`, `update`

O nome técnico da entidade no código permanece ContractPayment — apenas o resource RBAC foi renomeado para payment (mais conciso, dado que o contexto do módulo já implica que pagamento é de contrato).

Pagamentos

Pagamentos — Regras de Negócio#

1. Conceito#

1.1. Relação com o tipo do contrato#

1.2. Correção monetária#

2. Estruturas de Dados#

2.1. ContractPayment#

Campos top-level#

amounts (objeto)#

charges (objeto)#

charges.discount (objeto)#

createdBy (objeto)#

2.2. Ciclo de vida#

2.3. Status técnico e label de exibição (referência para frontend)#

2.4. Cálculo de encargos#

Configuração de encargos#

Aplicabilidade condicionada ao tipo#

Fórmulas#

3. Regras de Negócio#

Criação e vínculo#

Transições de status#

Encargos#

Edição e exclusão#

4. Padrão de Erros#

Códigos de erro específicos#

5. Endpoints#

POST .../payments#

GET ...:contractId/payments#

GET .../payments/:paymentId#

PATCH .../payments/:paymentId#

PUT .../payments/:paymentId/status#

6. Permissões RBAC#