Listar extrações de balanço e DRE de um cliente

GET

/v2/queries/clients/{clientId}/report-extraction

Lista as extrações de balanço e DRE do cliente, da mais recente para a mais antiga, com o ano, o arquivo de origem e o status do processamento. Paginado por page. O campo hasRequested, que indica se a empresa já usou o produto alguma vez, só vem na primeira página. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200

application/json

Harvested 200

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/queries/clients/CLIENT_ID/report-extraction?page=1' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": [
        {
            "_id": "string",
            "queryId": "string",
            "fileName": "string",
            "fileType": "string",
            "status": "string",
            "year": "string",
            "createdAt": "2026-05-20T14:06:05.366Z",
            "resultUrl": "string",
            "hasRequested": true,
            "analysisYear": "string",
            "totalAssets": 0,
            "totalLiabilities": 0,
            "dreResult": 0
        }
    ],
    "hasRequested": true
}

Modificado em 2026-10-13 09:47:06

Página anterior

Exportar consumo da empresa

Próxima página

Solicitar extração de balanço e DRE