Schema da resposta de trabalho

Envelope público de criação e consulta de trabalhos, incluindo alvo, progresso, resultado, paginação e erro.

Nesta página

Exemplo completo
Campos
Status
Resultado e erro

Exemplo completo

{
  "schemaVersion": "3.0",
  "jobId": "job_exemplo_01",
  "type": "invoice_sync_latest",
  "status": "completed",
  "dist": "CELESC",
  "connectionId": "conn_exemplo_123",
  "target": {
    "uc": "154026601110",
    "count": 1,
    "getPdfData": false,
    "forceRefresh": false
  },
  "progress": {
    "total": 1,
    "completed": 1,
    "failed": 0
  },
  "result": {
    "schemaVersion": "3.0",
    "count": 1,
    "items": [
      {
        "schemaVersion": "3.0",
        "dist": "CELESC",
        "invoice": {
          "id": "027001459644",
          "billingPeriod": "2026-07",
          "amount": 41.32,
          "currency": "BRL"
        }
      }
    ],
    "pagination": {
      "limit": 50,
      "offset": 0,
      "hasMore": false
    }
  },
  "error": null,
  "createdAt": "2026-08-24T14:00:00Z",
  "startedAt": "2026-08-24T14:00:04Z",
  "completedAt": "2026-08-24T14:00:18Z"
}

Todos os campos do envelope

Campo	Tipo	Descrição
`schemaVersion`	string	Versão do envelope público. Valor atual: 3.0.
`jobId`	string	Identificador estável usado em consulta, cancelamento e download.
`type`	string	Tipo de trabalho solicitado.
`status`	enum	queued, running, cancelling, cancelled, completed, partial_success, failed ou expired.
`dist`	string	Distribuidora da operação.
`connectionId`	string	Conexão usada pelo trabalho.
`target`	object \| null	Seletores resolvidos do trabalho, como uc, período, invoiceId e opções.
`progress.total`	integer	Quantidade total conhecida de itens a processar.
`progress.completed`	integer	Itens concluídos com sucesso.
`progress.failed`	integer	Itens concluídos com falha.
`result`	object \| null	Resultado disponível em completed e, quando houver itens úteis, partial_success.
`error`	object \| null	Erro terminal ou parcial, com code, message, retryable e details.
`createdAt`	datetime	Criação em ISO 8601 com offset.
`startedAt`	datetime \| null	Início da execução; null enquanto não iniciado.
`completedAt`	datetime \| null	Conclusão do estado terminal.
`result.schemaVersion`	string	Versão do envelope de resultado: 3.0.
`result.count`	integer	Quantidade total de itens disponíveis no resultado.
`result.items`	array	UCs para uc_discovery; faturas para os demais tipos.
`result.pagination.limit`	integer	Tamanho da página retornada.
`result.pagination.offset`	integer	Posição inicial da página.
`result.pagination.hasMore`	boolean	Indica que uma próxima página está disponível.

Valores de `status`

queuedrunningcancellingcancelledcompletedpartial_successfailedexpired

Estados terminais: cancelled, completed, partial_success, failed e expired.

Resultado e erro podem coexistir

Em completed, espere result e nenhum erro. Em failed, espere error e nenhum resultado útil. Em partial_success, processe os itens e também trate o erro.

Exemplo completo

Todos os campos do envelope

Valores de status

Resultado e erro podem coexistir

Valores de `status`