Buscar um DFe por chave de acesso
Retorna o XML de um DFe, a partir de uma chave de acesso. O documento 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, autorizados |
CFe | emitente | destinatário, autorizados |
Path Parameters
- empresa string required
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
- chaveAcesso string required
Chave de acesso do documento
Header Parameters
- x-auth-token string required
identificador de sessão
- 200
- 401
- 403
- 404
OK
- */*
- application/json;charset=UTF-8
- Schema
- Example (from schema)
Schema
- 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 int32codigo do tipo de emissao
descricao stringdescricao do tipo de emissao
- xMotivo string
mensagem do status do documento fiscal
{
"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"
}
- Schema
- Example (from schema)
Schema
- 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 int32codigo do tipo de emissao
descricao stringdescricao do tipo de emissao
- xMotivo string
mensagem do status do documento fiscal
{
"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"
}
Unauthorized
Forbidden
Not Found