Consultar todos os DFes emitidos
Lista todos os documentos emitidos, 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.
Query Parameters
- listarNaoProcessados boolean
Possible values: [
true
,false
]Listar documentos nao processados
- listarAutorizadosOuCanceladosPorIteracao boolean
Possible values: [
true
,false
]Listar somente documentos autorizados ou cancelados, buscando por data de iteração
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
- 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 int32codigo do status do documento fiscal
chaveAcesso stringchave de acesso do documento fiscal
codigoUF int32codigo UF emissor do documento fiscal
conteudo stringConteúdo do documento fiscal
dataRecebimento int64timestamp da data de recebimento do documento fiscal
idLote int64Identificação do número do Documento Fiscal
numeroProtocolo stringnumero de protocolo do documento fiscal
permiteImpressao booleanpermite permissao do documento
status stringDescrição do status fiscal do documento
statusArquivo stringtimestamp int64Data de emissão do Documento Fiscal
tipoEmissao object
codigo int32codigo do tipo de emissao
descricao stringdescricao do tipo de emissao
xMotivo stringmensagem do status do documento fiscal
]- totalPaginas int32
número total de páginas
{
"maximoPorPagina": 0,
"numeroElementos": 0,
"numeroTotal": 0,
"pagina": 0,
"registros": [
{
"cStat": 0,
"chaveAcesso": "string",
"codigoUF": 0,
"conteudo": "string",
"dataRecebimento": 0,
"idLote": 0,
"numeroProtocolo": "string",
"permiteImpressao": false,
"status": "string",
"statusArquivo": "string",
"timestamp": 0,
"tipoEmissao": {
"codigo": 0,
"descricao": "string"
},
"xMotivo": "string"
}
],
"totalPaginas": 0
}
Created
Unauthorized
Forbidden
Not Found