Download de Documentos

Está página apresenta os métodos disponíveis na API com exemplos de consumo e as tabelas dos campos esperados e retornados por cada método.

Documento específico

Retorna dados de uma NF-e ou CT-e a partir do fornecimento da chave de acesso.

Confira os limites de acesso em Limites de acesso.

Fluxo de processamento

URL

https://ddfe.ns.eti.br/dfe/unique

Dados de entrada

Campo	Descrição	Ocorrência	Aplicado em	Tipo	Comentários
X-AUTH-TOKEN	Token de acesso do usuário (fornecido pelo método Login)	1-1	Todos	String
CNPJInteressado	CNPJ do interessado em receber o documento	1-1	Todos	String	Ex.: CNPJ da transportadora, destinatário, terceiro referenciado no XML, etc...
nsu	Número sequencial único	0-1	Todos	Integer	Se informado, os campo chave, apenasComXml e comEventos serão ignoradosDeverá ser obrigatoriamente informado se o campo chave não for informado
modelo	Modelo do documento	0-1	Todos	Integer	Considerado apenas quando a consulta for feita utilizando o nsuPossíveis valores: 55 - NF-e (valor padrão) 57 - CT-e 98 - NFSe SP
chave	Chave de acesso do documento	0-1	NF-e e CT-e	String	Deverá ser obrigatoriamente informado se o campo nsu não for informado
apenasComXml	Carregar apenas documentos com XMLs disponíveis	0-1	NF-e	Boolean	O documento não possui XML disponível quando foi autorizado na Sefaz, mas ainda não foi manifestado pelo destinatário Valor padrão: False
comEventos	Incluir eventos vinculados ao documento disponíveis	0-1	NF-e e CT-e	Boolean	Se for true e existirem eventos vinculados ao documento disponíveis para download, o retorno conterá uma lista de documentoscontendo o documento consultado e todos os eventos vinculadosValor padrão: False
tpAmb	Tipo de ambiente	0-1	NF-e e CT-e	Integer	1 - Produção 2 - Homologação Valor padrão: Carregará documentos em produção e homologação
incluirPDF	Incluir do documento auxiliar	0-1	NF-e e CT-e	Boolean	DANFE para NF-es e DACTE para CT-es. Valor padrão: False

Exemplo de requisição

curl -i -X POST \
-H "Content-Type: application/json" \
-d '{
     "X-AUTH-TOKEN":"...",
     "chave":"..."
     }' \
https://ddfe.ns.eti.br/dfe/unique

Dados retornados

Campo	Descrição	Tipo	Observação
status	Código de status da requisição.	Integer
listaDocs	Lista de documentos	Boolean	True se o retorno possui uma lista de documento ou False se o retorno possui apenas 1 documento
nsu	Número sequencial único identificador da NF-e	Integer	Apenas se listaDocs = false
chave	Chave de acesso da NF-e	String	Apenas se listaDocs = false
emitCnpj	CNPJ do emitente do documento	String	Apenas se listaDocs = false
emitRazao	Razão social do emitente do documento	String	Apenas se listaDocs = false
cSitNFe	Código da situação da NF-e	Integer	Somente para resumo de NF-es 1 - Uso autorizado; 2 - Uso denegado; 3 - NF-e Cancelada;
modelo	Modelo do documento	Integer	Possíveis valores: 55 - NF-e (valor padrão) 57 - CT-e
vNF	Valor da Nota Fiscal Eletrônica	Double	Apenas se listaDocs = false e o documento possui valor fiscal
tpEvento	Código do evento	String	Apenas se listaDocs = false e o documento for evento
xml	XML da NF-e	String	Apenas se listaDocs = false
pdf	PDF do documento auxiliar em Base64	String	Se solicitado na requisição
xmls	Lista de documentos encontrados	Array	Apenas se listaDocs = trueCada item presente no array possui os mesmos campos descritos acima (nsu, chave, emitCnpj, emitRazao, cSitNFe, modelo, vNF, xml e pdf)Se o documento retornado for um resumo de NF-e, este campo terá o valor NULL.

Exemplo de retorno

Retorno com 1 documentos

{
    "status": 200,
    "listaDocs": false,
    "nsu": 1234,
    "chave": "35160324110220000136550010000000351895912462",
    "emitCnpj": "24110220000136",
    "emitRazao": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
    "modelo": 55,
    "vNF": "96.9",
    "xml": "<nfeProc versao=\"3.10\" xmlns=\"http://www.portalfiscal.inf.br/nfe\">...</nfeProc>"
}

Retorno com lista de documentos

{
    "status": 200,
    "listaDocs": true,
    "xmls": [
        {
            "nsu": 1234,
            "chave": "35160324110220000133550010000000351895912462",
            "emitCnpj": "24110220000133",
            "emitRazao": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
            "modelo": 55,
            "vNF": : "96.9",
            "xml": "<nfeProc versao=\"3.10\" xmlns=\"http://www.portalfiscal.inf.br/nfe\">...</nfeProc>"
        },
        {
            "nsu": 1235,
            "chave": "35160324110220000133550010000000351895922960",
            "emitCnpj": "24110220000133",
            "emitRazao": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
            "modelo": 55,
            "tpEvento": "110111",
            "xml": "<procEventoNFe versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\">...</procEventoNFe>"
        }
    ]
}

Lote de documentos

Retorna um lote de NF-es ou CT-es a partir do último NSU enviado. O lote de retorno contém no máximo 50 documentos, carregados em ordem crescente a partir de seu NSU.

Ex.: Se o último NSU enviado for 10, os documentos carregados serão os que contém o NSU > 10, ou seja, 11, 12, 13, etc… Caso existam mais de 50 documentos com NSU maior que 10, apenas os 50 primeiros serão retornados.

A sequência de NSUs é individual para NF-es e CT-es. É possível existir uma NF-e com NSU 10 e um CT-e com NSU 10.

Por isso, os NSUs (campos nsu e ultNSU) dos dados de entrada e saída, terão valores de acordo com o tipo de documento informado no campo documento, observando que, se não for informado este campo, o tipo de documento padrão NF-e será considerado.

Confira os limites de acesso em Limites de acesso.

Fluxo de processamento

URL

https://ddfe.ns.eti.br/dfe/bunch

Dados de entrada

Campo	Descrição	Ocorrência	Aplicado em	Tipo	Comentários
X-AUTH-TOKEN	Token de acesso do usuário (fornecido pelo método Login)	1-1	Todos	String
CNPJInteressado	CNPJ do interessado em receber o documento	1-1	Todos	String	Ex.: CNPJ da transportadora, destinatário, terceiro referenciado no XML, etc...
ultNSU	Último NSU recebido pelo consumidor e a partir do qual deseja consultar NF-es ou CT-es	1-1	Todos	Integer	Obrigatório quando não informadas dhInicial e dhFinal
dhInicial	Data e hora com fuso horário do período de emissão inicial a ser consultado	1-1	Todos	String	Obrigatório quando não informado ultNSU Exemplo: "03/09/2019 17:19:00-03:00"
dhFinal	Data e hora com fuso horário do período de emissão final a ser consultado	1-1	Todos	String	Obrigatório quando não informado ultNSU Exemplo: "06/09/2019 17:19:00-03:00"
apenasPendManif	Carregar apenas documentos pendentes de manifestação	0-1	NF-e	Boolean	Se informado e possuir o valor true os campos apenasComXml e comEventos serão desconsiderados Valor padrão: False
apenasComXml	Carregar apenas documentos com XMLs disponíveis	0-1	NF-e	Boolean	O documento não possui XML disponível quando foi autorizado na Sefaz, mas ainda não foi manifestado pelo destinatário Valor padrão: False
comEventos	Incluir eventos vinculados ao documento	0-1	NF-e e CT-e	Boolean	Valor padrão: False
removerEventosCodigos	Códigos dos eventos a serem removidos do retorno	0-1	NF-e e CT-e	Array	Apenas quando comEventos = True Possíveis códigos na tabela abaixo
modelo		0-1	Todos	Integer	Possíveis valores: 55 - NF-e (valor padrão) 57 - CT-e 98 - NFSe SP
tpAmb	Tipo de ambiente	0-1	NF-e e CT-e	Integer	1 - Produção 2 - Homologação Valor padrão: Carregará documentos em produção e homologação
incluirPDF	Incluir do documento auxiliar	0-1	NF-e e CT-e	Boolean	DANFE para NF-es e DACTE para CT-es. Valor padrão: False

Códigos de eventos

Código	Descrição
110110	Carta de Correção
110111	Cancelamento
210200	Confirmação da Operação
210210	Ciência da Operação
210220	Desconhecimento da Operação
210240	Operação não Realizada
310610	MDF-e Autorizado para CT-e
310611	MDF-e Cancelado Vinculado a CT-e
310620	Registro de Passagem
510620	Registro de Passagem BRID
610500	Registro Passagem NF-e
610510	Registro de Passagem de NFe propagado pelo MDFe
610514	Registro de Passagem de NFe propagado pelo MDFe/CTe
610501	Registro de Passagem para NF-e Cancelado
610550	Registro de Passagem NFe RFID
610552	Registro de Passagem Automatico MDFe
610554	Registro de Passagem Automatico MDF-e com CT-e
610600	CT-e Autorizado para NF-e
610601	CT-e Cancelado
610610	MDF-e Autorizado para NF-e
610611	MDF-e Cancelado
610614	MDF-e Autorizado com CT-e
610615	Cancelamento de MDF-e Autorizado com CT-e
790700	Averbação para Exportação

Exemplo de requisição

curl -i -X POST \
-H "Content-Type: application/json" \
-d '{
     "X-AUTH-TOKEN":"...",
     "ultNSU":"10"
     }' \
https://ddfe.ns.eti.br/dfe/bunch

Dados retornados

Campo	Descrição	Tipo	Comentários
status	Código de status da requisição	Integer
ultNSU	Último NSU disponível para consulta Obs.: Útil para indentificar se ainda existem documentos não recebidos e que não foram retornados	Integer
xmls	Array de NF-es ou CT-es	Array
Cada item do array xmls possui os campos abaixo
nsu	Número sequencial único identificador do documento	Integer
chave	Chave de acesso do documento	String
emitCnpj	CNPJ do emitente do documento	String
emitRazao	Razão social do emitente do documento	String
cSitNFe	Código da situação da NF-e	Integer	Somente para resumo de NF-es 1 - Uso autorizado; 2 - Uso denegado; 3 - NF-e Cancelada;
modelo	Modelo do documento	Integer	Possíveis valores: 55 - NF-e 57 - CT-e
vNF	Valor da Nota Fiscal Eletrônica	Double	Apenas se o documento possui valor fiscal
tpEvento	Código do evento	String	Apenas o documento for evento
xml	XML do documento	String
pdf	PDF do documento auxiliar em Base64	String	Se solicitado na requisição

Exemplo de retorno

{
    "status": 200,
    "ultNSU": 1401674,
    "xmls": [
        {
            "nsu": 1401671,
            "chave": "35160324110220000133550010000000351895912462",
            "emitCnpj": "24110220000133",
            "emitRazao": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
            "modelo": 55,
            "xml": "<nfeProc versao=\"3.10\" xmlns=\"http://www.portalfiscal.inf.br/nfe\">...</nfeProc>"
        },
        {
            "nsu": 1401672,
            "chave": "35160324110220000133550010000000351895922960",
            "emitCnpj": "24110220000133",
            "emitRazao": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
            "modelo": 55,
            "xml": "<nfeProc versao=\"3.10\" xmlns=\"http://www.portalfiscal.inf.br/nfe\">...</nfeProc>"
        }
    ]
}

NS DDFe

Documento específico

Fluxo de processamento

URL

Dados de entrada

Exemplo de requisição

Dados retornados

Exemplo de retorno

Lote de documentos

Fluxo de processamento

URL

Dados de entrada

Códigos de eventos

Exemplo de requisição

Dados retornados

Exemplo de retorno

Como podemos ajudar?