Faturas
Rotas de consulta por conexão e referência completa do recurso de fatura normalizado no schema 3.0.
Nesta página
Rotas por conexão
GET
/api/v1/connections/{connectionId}/invoices/latest?uc={uc}GET
/api/v1/connections/{connectionId}/invoices/latest/{count}?uc={uc}GET
/api/v1/connections/{connectionId}/invoices/period/{billingPeriod}?uc={uc}GET
/api/v1/connections/{connectionId}/invoices/range?from=2026-01&to=2026-06&uc={uc}GET
/api/v1/connections/{connectionId}/invoices/{invoiceId}?uc={uc}GET
/api/v1/connections/{connectionId}/invoices/{invoiceId}/pdf?uc={uc}Parâmetros comuns
| Parâmetro | Tipo | Padrão | Uso |
|---|---|---|---|
uc | string | obrigatório | Identificador atual ou legado, somente dígitos ASCII. |
get_pdf_data | boolean | false | Preenche pdf_data. |
force_refresh | boolean | false | Solicita dados atuais para esta operação. |
installation | string | — | Alias obsoleto de uc. |
contract_account | string | — | Alias obsoleto de uc. |
Envelope de lista
As respostas JSON contêm schemaVersion, count e invoices[]. O download de PDF retorna bytes, não JSON.
Todos os campos da fatura
Consulte o schema COPEL ou o schema CELESC. Cada página mostra todos os campos retornados para aquela distribuidora. Um valor indisponível em um campo previsto é null; campos fora do schema são omitidos.