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

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

# Histórico de eventos - Listar.

`GET` `/api/v1/DocumentoFiscal/HistoricoEventos/Listar`

Permite a listagem e rastreabilidade de eventos processados pela API de Notas Fiscais. Fornece uma visão detalhada do ciclo de vida das requisições, permitindo auditoria técnica e funcional. 🔍 **BUSCA ABRANGENTE**: O campo de busca genérica atua sobre a rota acessada e o conteúdo (body) das requisições, facilitando a localização de transações específicas. ⏱️ **PERFORMANCE**: É possível filtrar eventos por tempo de execução (milissegundos), ideal para identificar gargalos operacionais ou latências atípicas no processamento. 🛡️ **AUDITORIA**: O filtro por sucesso ou erro permite isolar rapidamente falhas de integração ou validações de negócio impeditivas.

## 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) - Termo de busca genérico (rota ou conteúdo).
- `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.
- `offset` (integer, int32, optional) - Registro inicial para paginação.
- `limit` (integer, int32, optional) - Quantidade de registros por página.

## 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/Listar:
    get:
      tags:
        - DocumentoFiscal
      summary: Histórico de eventos - Listar.
      description: >-
        Permite a listagem e rastreabilidade de eventos processados pela API de
        Notas Fiscais. 

        Fornece uma visão detalhada do ciclo de vida das requisições, permitindo
        auditoria técnica e funcional.


        🔍 **BUSCA ABRANGENTE**: O campo de busca genérica atua sobre a rota
        acessada e o conteúdo (body) das requisições, facilitando a localização
        de transações específicas.


        ⏱️ **PERFORMANCE**: É possível filtrar eventos por tempo de execução
        (milissegundos), ideal para identificar gargalos operacionais ou
        latências atípicas no processamento.


        🛡️ **AUDITORIA**: O filtro por sucesso ou erro permite isolar
        rapidamente falhas de integração ou validações de negócio impeditivas.
      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: Termo de busca genérico (rota ou conteúdo).
          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: offset
          in: query
          description: Registro inicial para paginação.
          schema:
            type: integer
            format: int32
            default: 1
        - name: limit
          in: query
          description: Quantidade de registros por página.
          schema:
            type: integer
            format: int32
            default: 10
        - name: DocumentoEmissor
          in: header
          description: Documento do emissor.
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/ListarHistoricoEventosNotaFiscalViewModelListPagina\
                  tionResponse"
            application/json:
              schema:
                $ref: "#/components/schemas/ListarHistoricoEventosNotaFiscalViewModelListPagina\
                  tionResponse"
            text/json:
              schema:
                $ref: "#/components/schemas/ListarHistoricoEventosNotaFiscalViewModelListPagina\
                  tionResponse"
        "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.
    ListarHistoricoEventosNotaFiscalViewModelListPaginationResponse:
      type: object
      properties:
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
        data:
          type: array
          items:
            $ref: "#/components/schemas/ListarHistoricoEventosNotaFiscalViewModel"
          nullable: true
      additionalProperties: false
    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
    ListarHistoricoEventosNotaFiscalViewModel:
      type: object
      properties:
        id:
          type: string
          description: Identificador interno do histórico do evento.
          format: uuid
        tipoEvento:
          $ref: "#/components/schemas/TipoEventoNotaFiscalModelEnum"
        documentoEmissor:
          type: string
          description: Documento (CPF/CNPJ) do emissor.
          nullable: true
        nomeEmissor:
          type: string
          description: Nome ou Razão Social do emissor.
          nullable: true
        sucesso:
          type: boolean
          description: Indica se o processamento do evento foi realizado com sucesso.
        rota:
          type: string
          description: Rota ou endpoint do evento.
          nullable: true
        inicioExecucao:
          type: string
          description: Data de início da execução do evento.
          format: date-time
        finalExecucao:
          type: string
          description: Data do fim da execução do evento.
          format: date-time
        duracaoMilissegundos:
          type: number
          description: Tempo de duração do evento em milissegundos.
          format: double
        duracao:
          type: string
          description: Tempo de duração do evento.
          nullable: true
      additionalProperties: false
      description: Dados da listagem do histórico de comandos de notas fiscais.
  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
```