...
A consulta pode ser realizada de duas formas: com o NSU (Número Sequencial Único) ou com a chave de acesso da NFe:
- Consulta com NSU:
Método: | POST |
Descrição: | Utilize este recurso para consultar documentos fiscais emitidos contra o CNPJ do estabelecimento, sendo o destinatário por NSU. |
Endpoint: | https://plataformafiscal.totvs.com.br/api/v1/dfe/consultar/nfe |
Modelo JSON (Envio): | { "ambiente":"Identificação do Ambiente: 1=Produção / 2=Homologação", "codigoUf":"Código da UF do Autor", "cnpj":"CNPJ do interessado no DF-e", "nsuRequest": { "ultimoNsu":"Último NSU recebido pelo ator. Caso seja informado com zero, ou com um NSU muito antigo, a consulta retornará unicamente as informações resumidas e documentos fiscais eletrônicos que tenham sido recepcionados pelo Ambiente Nacional nos últimos 3 meses." } }
|
Modelo JSON (Retorno): | { "retornoSefaz": { "tpAmb": "Ambiente que consulta foi realizada 1-Produção/ 2-Homologação", "verAplic": "1.3.9", "dhResp": "Data/Hora do retorno", "ultNSU": "Ultimo NSU consultado", "maxNSU": "Ultimo NSU que consta na SEFAZ", "loteDistDFeInt": { "docZip": [{ "value": "base64doArquivo", "nsu": "NSU da NF-e", "schema": "procEventoNFe_v1.00.xsd" }] } "versao": "1.01", "xmotivo": "Documento(s) localizado(s)", "cstat": "138" } } |
2. Consulta por Chave de Acesso:
Método: | POST |
Descrição: | Utilize este recurso para consultar documentos fiscais emitidos contra o CNPJ do estabelecimento, sendo o destinatário por Chave de Acesso |
Endpoint: | https://plataformafiscal.totvs.com.br/api/v1/dfe/consultar/nfe |
Modelo JSON (Envio): | { "ambiente":"Identificação do Ambiente: 1=Produção /2=Homologação", "codigoUf":"Código da UF do Autor", "cnpj":"CNPJ do interessado no DF-e", "chaveNFeRequest": { "chaveNFe":"Chave de acesso específica." } } |
Modelo JSON (Retorno): | { "retornoSefaz": { "tpAmb": "Ambiente que consulta foi realizada 1-Produção/ 2-Homologação", "verAplic": "1.3.9", "dhResp": "Data/Hora do retorno", "ultNSU": null, "maxNSU": null, "loteDistDFeInt": {"docZip": [ { "value": "base64doArquivo", "nsu": "NSU da NF-e", "schema": "resNFe_v1.01.xsd" }] }, "versao": "1.01", "xmotivo": "Documento localizado", "cstat": "138" } } |
Card documentos |
---|
Informacao | Para realizar a consulta dos documentos emitidos contra o CNPJ do estabelecimento, ou seja, documentos recebidos é necessário ter o certificado digital configurado. |
---|
Titulo | IMPORTANTE! |
---|
|
...