Visualizar relatório consolidado de um cliente

GET

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

Visualiza o relatório consolidado do cliente: porte atual da empresa, parecer de crédito, pontos fortes, pontos de atenção e o resumo com recomendação. Traz também a lista de anos com extração disponível e os cards comparativos de balanço e DRE dos quatro últimos anos. O campo deprecated indica que há extração mais nova do que o consolidado. 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

🟢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/consolidated' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "allReports": [
        {
            "_id": "string",
            "year": "string"
        }
    ],
    "consolidatedReport": {
        "status": "string",
        "createdAt": "2026-05-07T19:25:48.327Z",
        "deprecated": true,
        "currentCompanySize": "string",
        "creditOpinion": "string",
        "strengths": [
            "string"
        ],
        "areasOfAttention": [
            "string"
        ],
        "summaryAndRecommendation": "string"
    },
    "cards": {
        "growthHeader": {
            "netRevenue": {
                "items": [
                    {
                        "period": "string",
                        "value": 0,
                        "color": "string",
                        "indicator": "string"
                    }
                ]
            },
            "netDebt": {
                "items": [
                    {
                        "period": "string",
                        "value": 0,
                        "color": "string",
                        "indicator": "string",
                        "skip": true,
                        "skipReason": "string"
                    }
                ]
            }
        },
        "graphicCards": [
            {
                "title": "string",
                "type": "string",
                "value": 0,
                "percentageValue": 0,
                "prefix": "string",
                "dataSource": [
                    {
                        "year": 0,
                        "value": 0
                    }
                ]
            }
        ]
    }
}

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

Página anterior

Solicitar extração de balanço e DRE

Próxima página

Solicitar relatório consolidado de um cliente