Solicitar extração de balanço e DRE

POST

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

Envia um arquivo de balanço e/ou DRE para extração por IA, debita o saldo da empresa e registra o faturamento. A extração nasce com status FILA e o processamento é assíncrono. Se já existir extração para o mesmo ano, a requisição é recusada, a menos que overwrite seja true. Criar uma extração marca o relatório consolidado do cliente como desatualizado. 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 Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Inferred 201 (from source code)

Bodyapplication/json

🟠400Ano Base inválido

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/queries/clients/CLIENT_ID/report-extraction' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "fileUrl": "string",
    "fileName": "string",
    "fileType": "balanco",
    "year": "string",
    "overwrite": true
}'

Response Example

201 - Sucesso

{
    "_id": "string",
    "queryId": "string",
    "status": "FILA",
    "fileName": "string",
    "fileType": "string",
    "year": "2024"
}

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

Página anterior

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

Próxima página

Visualizar relatório consolidado de um cliente