Consultar todas as inutilizações

Lista todas as inutilizações, 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 [

  ambiente string

  ambiente da inutilização

  ano int32

  ano de vigência da inutilização

  cnpjEmitente string

  Cnpj do emitente da inutilização

  conteudo string

  Xml da inutilização

  dataRecebimento date-time

  Data de recebimento da inutilização na SEFAZ

  justificativa string

  Justificativa da inutilização

  modelo int32

  Modelo da do documento da inutilização

  numeroFinal int32

  Número final da inutilização

  numeroInicial int32

  Número inicial da inutilização

  protocolo int64

  Número do protocolo da inutilização

  serie int32

  Série da inutilização

  status string

  Nome do Status da inutilização

  uf string

  UF receptora da inutilização

  ]
• totalPaginas int32

  número total de páginas

{
  "maximoPorPagina": 0,
  "numeroElementos": 0,
  "numeroTotal": 0,
  "pagina": 0,
  "registros": [
    {
      "ambiente": "string",
      "ano": 0,
      "cnpjEmitente": "string",
      "conteudo": "string",
      "dataRecebimento": "2024-08-22T18:47:43.399Z",
      "justificativa": "string",
      "modelo": 0,
      "numeroFinal": 0,
      "numeroInicial": 0,
      "protocolo": 0,
      "serie": 0,
      "status": "string",
      "uf": "string"
    }
  ],
  "totalPaginas": 0
}

Created

Unauthorized

Forbidden

Not Found

Loading...