Schemas de fatura 3.0
Escolha COPEL ou CELESC para consultar os campos retornados, exemplos, enums e dados de PDF da sua integração.
Escolha a distribuidora
O campo dist identifica o schema do item. Os campos com o mesmo significado conservam os mesmos nomes, como consumerUnit.installationId, invoice.id e invoice.dueDate.
Regras comuns
- Os itens de fatura usam
schemaVersion: "3.0"e aparecem emresult.items[]nos trabalhos ou eminvoices[]nas consultas por conexão. - Identificadores são strings, com os zeros à esquerda preservados.
- Períodos usam
YYYY-MM; datas usamYYYY-MM-DD; valores monetários são números em reais. - Um campo previsto no schema da distribuidora pode ser
nullquando seu valor não estiver disponível. Campos fora desse schema são omitidos. - Zero é um valor informado. Não substitua valores ausentes por zero.
pdf_datamantém a mesma estrutura nas duas distribuidoras. Seus valores e significados específicos estão na página de cada uma.pdf_dataéquando não solicitado;pdfénullquando não há descritor de download.
Sinal de revisão
normalization.status aceita normalized ou review_required. No segundo caso, consulte normalization.issues[] e revise o campo indicado antes de usá-lo em decisões automáticas. Os campos source* conservam os rótulos da distribuidora.
Para detalhes do documento, consulte também pdf_data.quality. Um resultado de trabalho concluído não garante que todos os campos da fatura estejam completos ou livres de avisos.