---
title: "Histórico de consultas CNPJ - Resumo."
url: "https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050/paths/api-v1-RecursosAdicionais-Cnpj-HistoricoConsulta-Resumo/get"
---

> Full API specification: https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050.md

# Histórico de consultas CNPJ - Resumo.

`GET` `/api/v1/RecursosAdicionais/Cnpj/HistoricoConsulta/Resumo`

Fornece uma visão consolidada e totalizada do histórico de consultas de <strong>CNPJ</strong> realizadas pela aplicação. Este recurso é estratégico para a <strong>gestão e bilhetagem</strong> do consumo, permitindo auditar o volume de requisições processadas dentro de um período específico ou através de termos de busca. 📊 **INDICADORES**: O retorno contempla somatórios que auxiliam no controle operacional e financeiro do uso da API de consulta cadastral.

## Query parameters

- `filtro` (string, optional) - Filtrar pelo filtro utilizado na consulta.
- `dataConsultaInicial` (string, date-time, optional) - Filtrar pela data de consulta "a partir de".
- `dataConsultaFinal` (string, date-time, optional) - Filtrar pela data de consulta "até".

## Header parameters

- `DocumentoEmissor` (string, optional) - Documento do emissor.

## Responses

- `200` - OK
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found
- `500` - Internal Server Error

## OpenAPI definition

```yaml
openapi: 3.0.4
info:
  title: Stone Tax API
  version: 1.0.0
servers:
  - url: https://stone-tax-sdx.stone.com.br
    description: Ambiente de Desenvolvimento
  - url: https://stone-tax.stone.com.br
    description: Ambiente de Produção
paths:
  /api/v1/RecursosAdicionais/Cnpj/HistoricoConsulta/Resumo:
    get:
      tags:
        - RecursosAdicionais
      summary: Histórico de consultas CNPJ - Resumo.
      description: >-
        Fornece uma visão consolidada e totalizada do histórico de consultas de
        <strong>CNPJ</strong> realizadas pela aplicação. 

        Este recurso é estratégico para a <strong>gestão e bilhetagem</strong>
        do consumo, permitindo auditar o volume de requisições 

        processadas dentro de um período específico ou através de termos de
        busca.


        📊 **INDICADORES**: O retorno contempla somatórios que auxiliam no
        controle operacional e financeiro do uso da API de consulta cadastral.
      parameters:
        - name: filtro
          in: query
          description: Filtrar pelo filtro utilizado na consulta.
          schema:
            type: string
        - name: dataConsultaInicial
          in: query
          description: Filtrar pela data de consulta "a partir de".
          schema:
            type: string
            format: date-time
        - name: dataConsultaFinal
          in: query
          description: Filtrar pela data de consulta "até".
          schema:
            type: string
            format: date-time
        - name: DocumentoEmissor
          in: header
          description: Documento do emissor.
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/ObterResumoConsultaCnpjAplicacaoViewModel"
            application/json:
              schema:
                $ref: "#/components/schemas/ObterResumoConsultaCnpjAplicacaoViewModel"
            text/json:
              schema:
                $ref: "#/components/schemas/ObterResumoConsultaCnpjAplicacaoViewModel"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
      security:
        - BearerAuth: []
security:
  - BearerAuth: []
components:
  schemas:
    ObterResumoConsultaCnpjAplicacaoViewModel:
      type: object
      properties:
        totalConsultas:
          type: integer
          description: Total de consultas realizadas pelo emissor.
          format: int32
        totalSucesso:
          type: integer
          description: Total de consultas concluídas com sucesso.
          format: int32
        totalNaoEncontrado:
          type: integer
          description: Total de consultas cujo CNPJ não foi encontrado.
          format: int32
        totalFalha:
          type: integer
          description: Total de consultas que apresentaram falhas no processo.
          format: int32
      additionalProperties: false
      description: Dados do resumo do histórico de consultas de CNPJ.
    ResponseErrorResult:
      type: object
      properties:
        status:
          type: integer
          format: int32
        titulo:
          type: string
          nullable: true
        erros:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      description: Autenticação via token JWT. Obtenha o token através do endpoint
        /Autenticacao/ObterToken usando Basic Auth. O token expira em 1 hora.
      scheme: bearer
      bearerFormat: JWT
```