Consultar inutilizações de uma empresa
Lista as inutilizações da empresa, a partir de um modelo de DFe específico.
Path Parameters
- empresa string required
CNPJ/CPF da empresa
- ambiente string required
Possible values: [
hom
,prod
]Tipo do ambiente
- codModelo int32 required
Possible values: [
55
,57
,65
]Código do modelo
- uf string required
Possible values: [
AC
,AL
,AP
,AM
,BA
,CE
,DF
,ES
,GO
,MA
,MT
,MS
,MG
,PA
,PB
,PR
,PE
,PI
,RJ
,RN
,RS
,RO
,RR
,SC
,SP
,SE
,TO
]Sigla da UF da unidade receptora
- ano int32 required
Ano de emissão do documento (4 dígitos)
Query Parameters
- pagina int32
Default value:
1
Pagina de registros, onde 1 significa a primeira página
- comXml boolean
Se deve retornar os XMLs
Header Parameters
- x-auth-token string required
identificador de sessão
- 200
- 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 stringambiente da inutilização
ano int32ano de vigência da inutilização
cnpjEmitente stringCnpj do emitente da inutilização
conteudo stringXml da inutilização
dataRecebimento date-timeData de recebimento da inutilização na SEFAZ
justificativa stringJustificativa da inutilização
modelo int32Modelo da do documento da inutilização
numeroFinal int32Número final da inutilização
numeroInicial int32Número inicial da inutilização
protocolo int64Número do protocolo da inutilização
serie int32Série da inutilização
status stringNome do Status da inutilização
uf stringUF 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-11-07T23:52:43.398Z",
"justificativa": "string",
"modelo": 0,
"numeroFinal": 0,
"numeroInicial": 0,
"protocolo": 0,
"serie": 0,
"status": "string",
"uf": "string"
}
],
"totalPaginas": 0
}
Unauthorized
Forbidden
Not Found