Consultar todos os documentos recebidos

Lista todos os documentos recebidos, 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

considerarDataRecebimento boolean
Possible values: [true, false]
Pesquisar por data de recebimento

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, 67, 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

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
codigo do status do documento fiscal
chaveAcesso string
chave de acesso do documento fiscal
codigoUF int32
codigo UF emissor do documento fiscal
conteudo string
Conteúdo do documento fiscal
dataRecebimento int64
timestamp da data de recebimento do documento fiscal
idLote int64
Identificação do número do Documento Fiscal
numeroProtocolo string
numero de protocolo do documento fiscal
permiteImpressao boolean
permite permissao do documento
status string
Descrição do status fiscal do documento
statusArquivo string
timestamp int64
Data de emissão do Documento Fiscal
tipoEmissao object
codigo int32
codigo do tipo de emissao
descricao string
descricao do tipo de emissao
xMotivo string
mensagem 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
}

Consultar todos os documentos recebidos​

Consultar todos os documentos recebidos