Visualiza uma fatura

GET /api/{userId}/establishment/{establishmentId}/invoices/{clientId}/{invoiceDateTime}

Retorna a visão detalhada da fatura, incluindo dados do cliente, configurações relevantes (tolerância/multa), status de NFSe (quando existir transação) e cálculo de valor sugerido.

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

Requisição

• Método: GET
• Path: /api/\{userId\}/establishment/\{establishmentId\}/invoices/\{clientId\}/\{invoiceDateTime\}
• Headers: Authorization, Accept: 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

Campos mais relevantes em data

Campo	Tipo	Descrição
clientId	string	Cliente
clientName	string	Nome do cliente
clientDocument	string	Documento
clientEmail	string	E-mail
invoiceDateTime	string	Chave da fatura
registerDateTime	string	Registro
closingDateTime	string	Fechamento
dueDateTime	string	Vencimento
paymentDateTime	string / null	Pagamento (se pago)
amount	number	Valor base
closingAmount	number	Ajustes/taxa
transactions	array	Itens/lançamentos associados (quando existir JSON)
transactionId	string / null	Transação de pagamento
paymentMethodId	number / null	Método de pagamento (quando houver transação)
amountReceived	number	Valor “a receber/a pagar” calculado (ver nuances)
toleranceDays	number	Dias de tolerância (config do cliente)
penalty	number	Multa (valor ou percentual conforme penaltyType)
penaltyType	number	Tipo da multa (2 = percentual)
situationId	number	Situação
opened	number	1 se considerada “aberta” pela regra de closingDateTime

Também podem aparecer dados de nota fiscal quando houver transação, por exemplo: nfseStatus, rpsSeries, rpsNumber, nfseLink.

Nuâncias (regras e cálculos)

• transactions: é decodificado de JSON para array quando existir no banco.
• Tolerância (toleranceDays): a verificação de “vencida” pode considerar a data de vencimento somada da tolerância.
• Multa (penalty):
  • Só é considerada quando situationId = 1 e a fatura está vencida após tolerância.
  • Se penaltyType = 2, a multa é calculada como percentual de amount.
• amountReceived:
  • Quando existe transação, o sistema usa o valor recebido (ou, em alguns casos, reconstitui como amount + closingAmount).
  • Quando aplicável, a multa é somada a esse valor sugerido.

Códigos de erro comuns

Código	Quando ocorre
06001	Fatura não encontrada