Consultar todos os eventos

Lista todos os eventos, de todas as empresas que o usuário autenticado tenha permissão, de acordo com o modelo, tipo de ambiente e o intervalo de datas informado.

Header Parameters

• x-auth-token string required

  identificador de sessão

application/json

Request Body required

filtrosRelatorio

• cnpj string

  CNPJ interessado, para multiplos cnpjs os valores devem ser separadas por ponto e vírgula, vírgula, espaço ou uma nova linha.

• comXml boolean

  Se deve retornar os XML's

• dataFinal date-time required

  Data final, no formato aaaa-mm-dd'T'hh:mm:ssZ. Exemplo: '2018-03-26T12:25:59-03:00'

• dataInicial date-time required

  Data inicial, no formato aaaa-mm-dd'T'hh:mm:ssZ. Exemplo: '2018-03-26T12:25:59-03:00'

• modelo int32 required

  Possible values: [55, 57, 58, 59, 65, 66, 99]

  Código do modelo

• pagina int32

  Número da página, começando em 1 (um)

• tipoAmbiente string required

  Possible values: [hom, prod]

  Tipo do ambiente

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

*/*

• Schema
• Example (from schema)

---

Schema

• maximoPorPagina int32

  número máximo de registros por página

• numeroElementos int32

  número de registros presentes na página

• numeroTotal int64

  número total de registros retornados pela consulta

• pagina int32

  número da página atual

• registros object[]

  lista de todos os registros existentes na pagina atual

  Array [

  cStat int32

  Código de retorno do evento

  chaveAcesso string

  Chave de acesso do documento que gerou o evento

  codigoEvento int64

  Código do tipo do evento

  conteudo string

  XML do evento, layout procEvento Sefaz

  dataEvento string

  Data do evento, no formato ISO-8601

  descricaoEvento string

  Descrição do evento

  numeroProtocolo string

  O número do protocolo de registro do evento

  retornoSefaz string

  Descrição de retorno do evento

  sequencial int32

  Sequencial do evento

  status string

  Status do evento

  ]
• totalPaginas int32

  número total de páginas

{
  "maximoPorPagina": 0,
  "numeroElementos": 0,
  "numeroTotal": 0,
  "pagina": 0,
  "registros": [
    {
      "cStat": 0,
      "chaveAcesso": "string",
      "codigoEvento": 0,
      "conteudo": "string",
      "dataEvento": "string",
      "descricaoEvento": "string",
      "numeroProtocolo": "string",
      "retornoSefaz": "string",
      "sequencial": 0,
      "status": "string"
    }
  ],
  "totalPaginas": 0
}

Created

Unauthorized

Forbidden

Not Found

Loading...