Listar DFes por empresa

Retorna uma lista com os DFes separados por modelo, a partir de um período de tempo (data inicial e final) e da relação do DFe com o CNPJ. O CNPJ do envolvido é filtrado conforme a tabela abaixo:

Modelo DFe	Conta com módulo de emissão/importação	Conta com módulo de recebimento
NFe	emitente	destinatário, transportador, autorizados
NFCe	emitente	destinatário, transportador, autorizados
NFSe	emitente/prestador	destinatário/tomador, autorizados
MDFe	emitente	autorizados
CTe	emitente	destinatário, tomador, expedidor, recebedor, remetente, autorizados
CTe OS	emitente	tomador, autorizados
CFe	emitente	destinatário, autorizados

Pode ainda ser considerado o status da nota, seguindo a tabela

Status	Código do status
Qualquer status	99
Não Processada	0
Autorizada	1
Cancelada	2
Denegada	3
Rejeitada	4
Inutilizada	5
Encerrada	6
Não verificado	9
Falha ao consultar	10
Não encontrado	11
Substituída	12
Consulta Rejeitada	13
Em Processamento	16
Chave de Acesso inválida	18
Processamento Interrompido	21

Path Parameters

• empresa string required

  CPF/CNPJ da empresa

• relacao string required

  Possible values: [emitente, destinatario, transportador, remetente, recebedor, expedidor, tomador, autorizado]

  Relação do cliente com o documento

• 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

• dataInicial date-time required

  Data inicial (yyyy-MM-dd)

• dataFinal date-time required

  Data final (yyyy-MM-dd)

Query Parameters

• pagina int32

  Default value: 1

  Pagina de registros onde 1 significa a primeira pagina

• comXml boolean

  Se deve retornar os XMLs

• considerarDataDeRecebimento boolean

  Se deve usar a data de recebimento

• status int32

  Default value: 99

  Status da nota

Header Parameters

• x-auth-token string required

  identificador de sessão

Responses

• 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 [

  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
}

application/json;charset=UTF-8

• 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
}

Unauthorized

Forbidden

Not Found

Loading...