---
title: "Histórico de eventos - Resumo."
url: "https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050/paths/api-v1-DocumentoFiscal-HistoricoEventos-Resumo/get"
---

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

# Histórico de eventos - Resumo.

`GET` `/api/v1/DocumentoFiscal/HistoricoEventos/Resumo`

Fornece uma visão consolidada e simplificada dos eventos vinculados ao processamento de <strong>Notas Fiscais</strong>. Permite o monitoramento operacional através de filtros por tipo de evento, performance (duração) e status da execução.

## Query parameters

- `tipoEvento` (string, optional) - Filtrar pelo tipo do evento da nota fiscal.
- `sucesso` (boolean, optional) - Filtrar por eventos com sucesso ou erro.
- `busca` (string, optional) - Filtrar pela busca genérica por texto.
- `dataInicial` (string, date-time, optional) - Filtrar pela data de início do evento "a partir de".
- `dataFinal` (string, date-time, optional) - Filtrar pela data de início do evento "até".
- `duracaoInicialMilissegundos` (number, double, optional) - Filtrar pela duração mínima em milissegundos.
- `duracaoFinalMilissegundos` (number, double, optional) - Filtrar pela duração máxima em milissegundos.

## Header parameters

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

## Responses

- `200` - OK
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `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/DocumentoFiscal/HistoricoEventos/Resumo:
    get:
      tags:
        - DocumentoFiscal
      summary: Histórico de eventos - Resumo.
      description: >-
        Fornece uma visão consolidada e simplificada dos eventos vinculados ao
        processamento de <strong>Notas Fiscais</strong>. 

        Permite o monitoramento operacional através de filtros por tipo de
        evento, performance (duração) e status da execução.
      parameters:
        - name: tipoEvento
          in: query
          description: Filtrar pelo tipo do evento da nota fiscal.
          schema:
            $ref: "#/components/schemas/TipoEventoNotaFiscalModelEnum"
        - name: sucesso
          in: query
          description: Filtrar por eventos com sucesso ou erro.
          schema:
            type: boolean
        - name: busca
          in: query
          description: Filtrar pela busca genérica por texto.
          schema:
            type: string
        - name: dataInicial
          in: query
          description: Filtrar pela data de início do evento "a partir de".
          schema:
            type: string
            format: date-time
        - name: dataFinal
          in: query
          description: Filtrar pela data de início do evento "até".
          schema:
            type: string
            format: date-time
        - name: duracaoInicialMilissegundos
          in: query
          description: Filtrar pela duração mínima em milissegundos.
          schema:
            type: number
            format: double
        - name: duracaoFinalMilissegundos
          in: query
          description: Filtrar pela duração máxima em milissegundos.
          schema:
            type: number
            format: double
        - name: DocumentoEmissor
          in: header
          description: Documento do emissor.
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/ObterResumoHistoricoEventosNotaFiscalViewModel"
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/ObterResumoHistoricoEventosNotaFiscalViewModel"
            text/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/ObterResumoHistoricoEventosNotaFiscalViewModel"
        "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"
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
      security:
        - BearerAuth: []
security:
  - BearerAuth: []
components:
  schemas:
    TipoEventoNotaFiscalModelEnum:
      enum:
        - PreNotaAutomatica
        - PreNotaSimplificada
        - EmissaoNfe
        - EmissaoNfceAutomatica
        - EmissaoNfceSimplificada
        - EmissaoNfce
        - CancelarNotaFiscal
        - InutilizarFaixaNumeracao
        - TransmitirNotaFiscalEmitidaEmContingencia
        - EmitirNfeEstorno
        - EmitirNfeDevolucao
        - EmitirNfeDevolucaoXml
        - ObterDanfeNfe
        - ObterDanfeNfce
        - ObterArquivoXml
        - EmitirCartaDeCorrecao
        - ObterXmlCartaCorrecao
        - ObterArquivoXmlNfse
        - ObterDanfeNfse
        - CancelarNotaFiscalServico
        - EmissaoNfse
      type: string
      description: Tipo de evento do contexto de notas fiscais.
    ObterResumoHistoricoEventosNotaFiscalViewModel:
      type: object
      properties:
        tipoEvento:
          $ref: "#/components/schemas/TipoEventoNotaFiscalModelEnum"
        totalEventos:
          type: integer
          description: Quantidade total de eventos registrados para o tipo de evento e
            filtros aplicados.
          format: int32
        totalSucesso:
          type: integer
          description: Quantidade total de eventos processados com sucesso para o tipo de
            evento e filtros aplicados.
          format: int32
        totalFalha:
          type: integer
          description: Quantidade total de eventos processados com falha para o tipo de
            evento e filtros aplicados.
          format: int32
      additionalProperties: false
      description: Resumo do histórico de eventos de nota fiscal.
    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
```
