Fecha uma fatura

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

Fecha (encerra) uma fatura em aberto. Usado somente no fluxo de clientes pós pago (tipos 4/5), onde o fechamento pode gerar a próxima 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)

Opcional:

Campo	Tipo	Obrigatório	Descrição
closingDateTime	string	não	Data/hora de fechamento (quando necessário pelo fluxo)

Requisição

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

Formato da resposta (JSON)

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

Exemplo de resposta (JSON)

Valores ilustrativos; a forma dos campos segue o retorno real.

{
  "response": "success",
  "data": {
    "clientId": "772420260215093421",
    "invoiceDateTime": "20260215093421",
    "closingDateTime": "2026-02-28 23:59:59",
    "dueDateTime": "2026-03-10 00:00:00",
    "situationId": 1,
    "status": 1,
    "nextInvoiceDateTime": "20260301000000"
  }
}

Nuâncias (regras importantes)

• Somente pós pago: o fechamento é permitido apenas para clientes de tipos 4 e 5.
• Não pode fechar:
  • fatura cancelada (situationId = 3)
  • fatura já paga (situationId = 2 ou com transactionId)
  • fatura que não está “aberta” pela regra de closingDateTime
• Regras de datas:
  • o novo vencimento calculado para a próxima fatura não pode ser “hoje”
  • o closingDateTime calculado não pode cair em data passada/atual (bloqueio)
• Criação de nova fatura: ao fechar com sucesso, o sistema pode criar a próxima fatura pendente e aberta se não houver outra aberta.

Códigos de erro comuns

Código	Quando ocorre
06001	Fatura não encontrada (ou não elegível para fechamento)
06015	Cliente não é pós pago (tipo diferente de 4/5)
06017	Fatura cancelada
06018	Fatura já paga / com transação
06021	Regra de data bloqueou (ex.: vencimento calculado igual a hoje)
06022	Regra de fechamento bloqueou (ex.: closingDateTime em data não permitida)