Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


CONTEÚDO

Índice
minLevel2
excludeCONTEÚDO
stylenone


01. VISÃO GERAL

Este evento tem como finalidade consultar documentos fiscais eletrônicos (NF-e) emitidos contra o CNPJ do estabelecimento.

02. CONSULTA VIA

...

É possível enviar a consulta de NF-e emitidas contra o CNPJ do estabelecimento via API no formato Json.

...

Método:

...

POST

...

Descrição:

...

Utilize este recurso para consultar documentos fiscais emitidos contra o CNPJ do destinatário.

...

Modelo JSON (Envio e Retorno):

...

https://plataformafiscal.totvs.com.br/api/v1/dfe/consultar/nfe

A consulta pode ser realizada de duas formas: com o NSU (Número Sequencial Único) ou com a chave de acesso da NFe.

Segue exemplo de Json:

- Consulta com NSU:

Bloco de código
languagejava
{
	"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."
	}
}

- Retorno:

- Consulta com a Chave de Acesso:

Bloco de código
languagejava
{
   "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."
   }
}

- Retorno:

...

TELA

Para realizar a consulta completa manualmente é necessário ter permissão. As permissões são configuradas no Perfil (Processos Fiscais>> Perfis de segurança), para habilitar a consulta completa é necessário que o usuário tenha a permissão: "NFE-e Consulta Completa".

...

Card documentos
InformacaoPara realizar a Consulta Completa dos documentos recebidos é necessário ter o certificado digital configurado.
TituloIMPORTANTE!

03. CONSULTA VIA API

É possível enviar a consulta de NF-e emitidas contra o CNPJ do estabelecimento via API no formato Json.

A consulta pode ser realizada de duas formas: com o NSU (Número Sequencial Único) ou com a chave de acesso da NFe:


  1. 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):


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):

04. ASSUNTOS RELACIONADOS

...