Faturas e PDFs

Sincronize os metadados

Use invoice_sync_latest, invoice_sync_period ou invoice_sync_range. Todos retornam faturas com schema 3.0. Consulte os campos específicos no schema COPEL ou no schema CELESC.

• invoice_sync_latest: últimas 1 a 120 faturas.
• invoice_sync_period: um mês em YYYY-MM.
• invoice_sync_range: intervalo inclusivo de até 36 meses.

Obtenha pdf_data

Use invoice_pdf_parse quando precisa das tabelas detalhadas do documento. Como alternativa, defina getPdfData: true em um trabalho de sincronização.

{
  "type": "invoice_pdf_parse",
  "dist": "COPEL",
  "connectionId": "conn_exemplo_123",
  "uc": "000093254403147",
  "invoiceId": "20265042553890",
  "forceRefresh": false
}

Leia um PDF que você já possui

Se o arquivo já está com você ou disponível em uma URL pública, use o POST /api/v1/pdf/parse. A resposta síncrona contém pdf_data diretamente e dispensa conexão, trabalho e polling.

Baixe o PDF sanitizado

Use invoice_pdf_fetch ou uma sincronização com getPdfData: true. O item retornará um descritor pdf.

{
  "pdf": {
    "available": true,
    "fileName": "invoice_2026-07_20265042553890.pdf",
    "contentType": "application/pdf",
    "downloadUrl": "/api/v1/jobs/job_exemplo_01/files/20265042553890"
  }
}

Envie a mesma X-API-Key. A resposta tem Content-Type: application/pdf e Content-Disposition com o nome do arquivo.

Qual operação usar