Solicitar relatório consolidado de um cliente

POST

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

Gera um novo relatório consolidado a partir das extrações dos quatro anos mais recentes do cliente, debita o saldo da empresa e registra o faturamento. O relatório nasce com status FILA e o processamento é assíncrono. Não tem corpo de requisição. 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

Respostas

🟢201

application/json

Inferred 201

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/queries/clients/CLIENT_ID/report-extraction/consolidated' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

201 - Sucesso

{
    "_id": "string",
    "clientId": "string",
    "companyId": "string",
    "queryId": "string",
    "status": "FILA",
    "indicators": [
        {
            "year": "2024",
            "content": {
                "balanco_patrimonial": {
                    "ativo_circulante": 0,
                    "disponivel": 0,
                    "passivo_circulante": 0,
                    "estoques": 0,
                    "patrimonio_liquido": 0,
                    "realizavel_a_longo_prazo": 0,
                    "exigivel_a_longo_prazo": 0,
                    "passivo_total": 0,
                    "ativo_total": 0,
                    "emprestimos_e_financiamentos_circulante": 0,
                    "emprestimos_e_financiamentos_nao_circulante": 0
                },
                "demonstracao_resultado": {
                    "lucro_liquido": 0,
                    "custos_das_mercadorias_vendidas": 0,
                    "receita_liquida": 0,
                    "receita_bruta": 0,
                    "lucro_bruto": 0,
                    "lucro_operacional": 0,
                    "despesas_operacionais": 0,
                    "estoque_medio": 0,
                    "depreciacao": 0,
                    "amortizacao": 0,
                    "aumento_no_capital_de_giro": 0
                },
                "indicadores": {
                    "liquidez_geral": 0,
                    "liquidez_imediata": 0,
                    "liquidez_seca": 0,
                    "liquidez_corrente": 0,
                    "endividamento": 0,
                    "margem_bruta": 0,
                    "ebitda": 0,
                    "indice_operacional": 0,
                    "giro_de_estoque": 0,
                    "fluxo_de_caixa_operacional": 0,
                    "alavancagem_financeira": 0,
                    "porte_da_empresa": "médio"
                }
            }
        }
    ]
}

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

Página anterior

Visualizar relatório consolidado de um cliente

Próxima página

Visualizar relatório consolidado de um cliente (detalhado)