Paga uma fatura

POST /api/{userId}/establishment/{establishmentId}/invoices/pay/{clientId}/{invoiceDateTime}

Efetua o pagamento da fatura e vincula uma transação (transactionId). Dependendo do tipo de cliente e das configurações do método de pagamento, o fluxo pode criar transações adicionais (ex.: taxa) e/ou criar nova fatura recorrente.

Parâmetros de rota

Nome	Tipo	Descrição
userId	number	Identificador do usuário
establishmentId	number	Identificador do estabelecimento
clientId	string	Identificador do cliente
invoiceDateTime	string	Chave da fatura

Body (JSON)

Campo	Tipo	Obrigatório	Descrição
paymentMethod	number	sim	Identificador do método de pagamento do estabelecimento
paymentDateTime	string	sim	Data/hora do pagamento (YYYY-MM-DD HH:mm:ss)
amount	number	sim	Valor pago
paymentCode	string / null	não	Código/observação do pagamento (ex.: NSU)
accountId	number / null	não	Conta; se omitido, usa o accountId do método de pagamento

Requisição

• Método: POST
• Path: /api/\{userId\}/establishment/\{establishmentId\}/invoices/pay/\{clientId\}/\{invoiceDateTime\}
• Headers: Authorization, Accept: application/json, Content-Type: application/json

Formato da resposta (JSON)

• Sucesso (HTTP 200): { "response": "success", "data": <payload> } ou { "response": "success", "data": { "msg": "...", "code": "..." } } (mensagem de sucesso)
• Erro (HTTP 400): { "response": "error", "data": { "msg": "...", "code": "..." } }
• Não autorizado / permissão: Autorização

Nuâncias (regras importantes)

• Cliente pós pago (tipos 4/5): se a fatura estiver “aberta” (opened = 1 pela regra de closingDateTime), o pagamento pode ser bloqueado.
• Validações de método de pagamento: o método precisa existir e estar habilitado para o estabelecimento.
• Categoria automática: a transação usa uma categoria padrão (varia se a fatura é de pacote de serviço).
• Taxa de recebimento (receivingFee): quando o método de pagamento tem taxa, o sistema pode criar uma transação vinculada (valor negativo) para representar a taxa.
• Criação de nova fatura recorrente:
  • Ao pagar, o sistema pode criar uma nova fatura pendente se não houver outra pendente e a fatura paga não for de pacote de serviço.

Códigos de erro comuns

Código	Quando ocorre
06001	Fatura não encontrada
06008	Método de pagamento inválido
06011	Categoria padrão não encontrada/configurada
06014	Regra de pós pago bloqueou o pagamento (fatura “aberta”)

Exemplo de requisição

{
  "paymentMethod": 12,
  "paymentDateTime": "2026-04-15 10:30:00",
  "amount": 93.5,
  "paymentCode": "NSU123456",
  "accountId": 3
}