Consultar resumo dos documentos recebidos

Retorna um resumo dos documentos recebidos, emitidos em uma data específica.

Path Parameters

empresa string required
CPF/CNPJ da empresa
ambiente string required
Possible values: [hom, prod]
Tipo do ambiente
codModelo int32 required
Possible values: [55, 57, 58, 59, 65, 66, 67, 99]
Código do modelo
dataEmissao string required
Data de emissão (yyyy-MM-dd)

Query Parameters

pagina int32
Default value: 1
Página de registros, onde 1 significa a primeira página

Header Parameters

x-auth-token string required
identificador de sessão

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 [
cfops string[]
Lista de CFOPs listados no DF-e (Indisponível caso não exista o XML completo do DF-e na base)
chDFe string required
Chave de acesso do DF-e
dhEmi string required
Data de emissão do DF-e
dhRecbto string required
Data de processamento do DF-e pela Sefaz
dhRecebtoOobj string
Data de recebimento do DF-e pela OOBJ
digVal string required
Digest Value da assinatura do DF-e
docEmit string required
Número de documento do Emitente do DF-e
ieEmit string required
Inscrição estadual do Emitente do DF-e
mod int32
Modelo do DF-e
nomeEmit string required
Razão Social do Emitente do DF-e
nsu int64
NSU do DF-e
numero int64
Número do DF-e
parcelas object[]
Lista das Parcelas de Cobrança
Array [
dataVencimento string required
Data de Vencimento da Parcela
nParcela string required
Numero da Parcela
vParcela double required
Valor da Parcela
]
prot string required
Número de protocolo de autorização do DF-e
serie int32
Série do DF-e
sitDF string required
Status do DF-e
statusArquivo string
Status do arquivo
temProc boolean required
Se existir o XML PROC do DF-e, estará true, caso contrário false
tpAmb int32 required
Tipo de ambiente da emissão do DF-e
tpDF int32 required
Tipo do DF-e
vDF double required
Valor do DF-e
]
totalPaginas int32
número total de páginas

{
  "maximoPorPagina": 0,
  "numeroElementos": 0,
  "numeroTotal": 0,
  "pagina": 0,
  "registros": [
    {
      "cfops": [
        "string"
      ],
      "chDFe": "string",
      "dhEmi": "string",
      "dhRecbto": "string",
      "dhRecebtoOobj": "string",
      "digVal": "string",
      "docEmit": "string",
      "ieEmit": "string",
      "mod": 0,
      "nomeEmit": "string",
      "nsu": 0,
      "numero": 0,
      "parcelas": [
        {
          "dataVencimento": "string",
          "nParcela": "string",
          "vParcela": 0
        }
      ],
      "prot": "string",
      "serie": 0,
      "sitDF": "string",
      "statusArquivo": "string",
      "temProc": false,
      "tpAmb": 0,
      "tpDF": 0,
      "vDF": 0
    }
  ],
  "totalPaginas": 0
}

Consultar resumo dos documentos recebidos​

Consultar resumo dos documentos recebidos