Páginas filhas
  • ER_NT2015/001_Pedido_de_Prorrogação

Versões comparadas

Chave

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

 Este documento é material de especificação dos requisitos de manutenção, trata-se de conteúdo extremamente técnico.                                                             

  

Informações Gerais

 

Especificação

Produto

TSS

Módulo

NFE

Segmento Executor

Serviços

Chamado

TSTJQQ

Release de Entrega Planejada

 

Réplica

 

País

(X) Brasil  (  ) Argentina  (  ) Mexico  (  ) Chile  (  ) Paraguai  (  ) Equador

(  ) USA  (  ) Colombia   (  ) Outro _____________.

Objetivo

Esta Nota Técnica consiste na implementação do pedido de prorrogação da suspensão do ICMS, na remessa para industrialização, após decorridos 180 dias.

O evento de pedido de prorrogação substitui uma petição em papel do contribuinte frente à administração pública, com um arquivo xml assinado.

 

Definição da Regra de Negócio


Serão utilizados os métodos do Web Service SPEDCFGNFE 

Através do método CFGCCE sera configurado a versão do Evento de Pedido de Prorrogação.


Método CFGCCE

Método de configuração dos parâmetros da Carta de Correção Eletrônica (CC-e) e  Evento de Pedido de Prorrogação (EPP) 

Os parâmetros de entrada do método são: 

   <soapenv:Body> 

      <CFGCCE> 

         <USERTOKEN>STRING</USERTOKEN> 

         <ID_ENT>STRING</ID_ENT> 

         <AMBIENTECCE>INTEGER</AMBIENTECCE> 

         <VERCCELAYOUT>STRING</VERCCELAYOUT> 

         <VERCCELAYEVEN>STRING</VERCCELAYEVEN> 

         <VERCCEEVEN>STRING</VERCCEEVEN> 

         <VERCCE>STRING</VERCCE> 

         <HORAVERAOCCE>STRING</HORAVERAOCCE> 

         <HORARIOCCE>STRING</HORARIOCCE> 

         <VEREPPLAYOUT>STRING</VEREPPLAYOUT>

         <VEREPPLAYEVEN>STRING</VEREPPLAYEVEN> 

         <VEREPPEVEN>STRING</VEREPPEVEN> 

         <VEREPP>STRING</VEREPP>  

         <SEQLOTECCE>INTEGER</SEQLOTECCE> 

        <SEQLOTEEPP>INTEGER</SEQLOTEEPP> 

      </sped:CFGCCE> 

   </soapenv:Body> 

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

CFGCCE

-

-

-

1-1

Tag raíz.

USERTOKEN

CFGCCE

A

5

1-1

Deverá ser preenchido com o valor “TOTVS”.

ID_ENT

CFGCCE

A

6

1-1

ID da entidade a ser utilizada.

AMBIENTECCE

CFGCCE

N

1

1-1

Identificação do Ambiente:

 1-Produção ou 2-Homologação.

VERCCELAYOUT

CFGCCE

A

1-4

1-1

Versão do Layout.

VERCCELAYEVEN

CFGCCE

A

1-4

1-1

Versão do Layout do evento.

VERCCEEVEN

CFGCCE

A

1-4

1-1

Versão do evento.

VERCCE

CFGCCE

A

1-4

1-1

Versão  da carta de correção.

HORAVERAOCCE

CFGCCE

A

1

1-1

Identificação de Horário de Verão:

1-Sim ou 2-Não

HORARIOCCE

CFGCCE

A

1

1-1

Identificação do Horário:

1-Fernando de Noronha; 2-Brasília e

3-Manaus

VEREPPLAYOUT

CFGCCERESULT

A

1-4

0-1

Versão do layout do pedido de prorrogação.

VEREPPLAYEVEM

CFGCCERESULT

A

1-4

0-1

Versão do layout do evento de pedido de prorrogação.

VEREPPEVEN

CFGCCERESULT

A

1-4

0-1

Versão do evento do pedido de prorrogação.

VEREPP

CFGCCERESULT

A

1-4

0-1

Versão  do pedido de prorrogação.

SEQLOTECCE

CFGCCE

N

-

1-1

Número sequencial do lote.

SEQLOTEEPP

CFGCCE

N

-

0-1

Número sequencial do lote do evento de pedido de prorrogação .

 

Os parâmetros de saída do método são:

  <soap:Body>   

   <CFGCCERESPONSE> 

         <CFGCCERESULT> 

            <AMBIENTE>STRING</AMBIENTE> 

            <HORARIOCCE>STRING</HORARIOCCE> 

            <HORAVERAOCCE>STRING</HORAVERAOCCE> 

            <SEQLOTECCE>INTEGER</SEQLOTECCE> 

           <SEQLOTEEPP>INTEGER</SEQLOTEEPP> 

            <VERCCE>STRING</VERCCE> 

            <VERCCEEVEN>STRING</VERCCEEVEN> 

            <VERCCELAYEVEN>STRING</VERCCELAYEVEN> 

            <VERCCELAYOUT>STRING</VERCCELAYOUT> 

            <VEREPP>STRING</VEREPP> 

           <VEREPPEVEN> STRING</VEREPPEVEN> 

           <VEREPPLAYEVEM>STRING</VEREPPLAYEVEM> 

           <VEREPPLAYOUT>STRING</VEREPPLAYOUT> 

            </CFGCCERESULT> 

      </CFGCCERESPONSE> 

   </soap:Body>

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

CFGCCERESPONSE

-

-

-

1-1

Tag raíz.

CFGCCERESULT

CFGCCERESPONSE

 

 

 

 

AMBIENTE

CFGCCERESULT

A

1

0-N

Identificação do Ambiente:

 1-Produção ou 2-Homologação.

HORARIOCCE

CFGCCERESULT

A

1-4

1-N

Identificação do Horário:

1-Fernando de Noronha; 2-Brasília e

3-Manaus

HORAVERAOCCE

CFGCCERESULT

A

1-4

1-N

Identificação de Horário de Verão:

1-Sim ou 2-Não

SEQLOTECCE

CFGCCERESULT

N

1-4

1-N

Número sequencial do lote.

SEQLOTEEPP

CFGCCERESULT

N

-

1-1

Número sequencial do lote do evento de pedido de prorrogação

VERCCE

CFGCCERESULT

A

1-4

1-N

Versão  da carta de correção.

VERCCEEVEN

CFGCCERESULT

A

1

1-N

Versão do evento.

VERCCELAYEVEN

CFGCCERESULT

A

1

1-N

Versão do Layout do evento.

VERCCELAYOUT

CFGCCERESULT

A

15

1-N

Versão do Layout.

VEREPP

CFGCCERESULT

A

1-4

1-1

Versão  do evento de pedido de prorrogação.

VEREPPEVEN

CFGCCERESULT

A

1-4

1-1

Versão do evento.

VEREPPLAYEVEM

CFGCCERESULT

A

1-4

1-1

Versão do Layout do evento.

VEREPPLAYOUT

CFGCCERESULT

A

1-4

1-1

Versão do Layout.

 

Soup Fault:

 

Fault

Descrição

Invalid Token

O parâmetro USERTOKEN foi passado incorretamente

1

Código da entidade invalida

2

Código da entidade em branco

3

Código do ambiente inválido. Valores válidos: 1-Produção e 2-Homologação

4

Versão do Layout inválida.

5

Versão do Layout do evento inválida.

6

Versão do evento inválida.

7

Versão da carta de correção eletrônica inválida.

8

Horário de verão inválido. Valores válidos: 1-Sim e 2-Não

9

Horário inválido. Valores válidos: 1-Fernando de Noronha, 2-Brasilia e 3-Manaus

 

 

Serão utilizados os métodos do Web Service NFESBRA.

 

Através do método REMESSAEVENTO será enviado os eventos de pedido de prorrogação e os eventos de cancelamento de pedido de prorrogação, ambos diferenciados através do TpEvento.

               

  • Evento Pedido de Prorrogação;
    • Pedido de prorrogação 1º. Prazo (tpEvento=111500,”EPP1”)
    • Pedido de prorrogação 2º. Prazo (tpEvento=111501,” EPP2”)

 

  •  Evento Cancelamento de Pedido de Prorrogação;
    • Cancelamento de Pedido de Prorrogação 1º. Prazo (tpEvento=111502,“ECPP1”)
    • Cancelamento de Pedido de Prorrogação 2º. Prazo (tpEvento=111503,“ECPP2”)



Método REMESSAEVENTO

Método destinado ao envio em lote dos novos eventos onde são tratados e enviados a SEFAZ individualmente.

 

Os parâmetros de entrada do método são:

<soap:Body>

   <REMESSAEVENTO>

   <USERTOKEN>STRING</USERTOKEN>

   <ID_ENT>STRING</ID_ENT>

   <XML_LOTE>BINÁRIO</XML_LOTE>

   <REMESSAEVENTO>

</soap:Body>

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

REMESSAEVENTO

-

-

-

1-1

Tag raíz.

USERTOKEN

REMESSAEVENTO

A

5

1-1

Deverá ser preenchido com o valor “TOTVS”.

ID_ENT

REMESSAEVENTO

A

6

1-1

ID da entidade a ser utilizada.

XML_LOTE

REMESSAEVENTO

Binário

1-500K

1-1

XML do Lote de envio dos eventos, este XML será definido conforme o Layout de cada evento

 

Para o envio dos eventos, foi disponibilizado um leiaute padrão para atender a todos os eventos disponibilizados para o Pedido de Prorrogação, tendo como diferencial para cada evento a tag detEvento, que deverá conter  os elementos de acordo com evento a ser enviado.O Xml deverá respeitar a seguinte estrutura:

 

Nome

Pai

Tipo

Tamanho

Ocorrências

Observações

envEvento

-

-

-

1-1

Tag raiz

Eventos

envEvento

G

-

1-1

Evento

detEvento

Eventos

G

-

1-N

Informações do Evento (estrutura XML variável, depende do tipo de evento)

 

detEventoPedido de Prorrogação

Nome

Pai

Tipo

Tamanho

Ocorrências

Observações

detEvento

Eventos

G

-

1-N

Tag raiz

tpEvento

detEvento

A

6

1-1

Tipo de Evento

Informar : 111500/ 111501/ 111502/ 111503

chNFe

detEvento

N

44

1-N

Chave de Acesso da NFe.

itemPedido

detEvento

G

-

1-N

Grupo de Informações do item do Pedido

numItem

itemPedido

N

1-3

1-1

Número do item da NF-e. O
número do item deverá ser o
mesmo número do item na NF-e

qtdeItem

itemPedido

N

1-3

1-1

Quantidade de comercialização
do item que será solicitada a
prorrogação de prazo

Exemplo de XML para o Evento de Pedido de Prorrogação 1º e 2º prazo.

 

<envEvento>

  <eventos>

      <detEvento>

      <tpEvento>111500</tpEvento>

      <chNFe>99999999999999999999999999999999999999999998</chNFe>

                  <itemPedido>

                               <numItem>1</numItem>

                               <qtdeItem>10</qtdeItem>

                  </itemPedido>

                  <itemPedido>

                               <numItem>2</numItem>

                               <qtdeItem>12</qtdeItem>

                  </itemPedido>

                  <itemPedido>

                               <numItem>3</numItem>

                               <qtdeItem>14</qtdeItem>

                  </itemPedido>

     </detEvento>

     <detEvento>

     <tpEvento>111501</tpEvento>

     <chNFe>99999999999999999999999999999999999999999999</chNFe>

                   <itemPedido>

                               <numItem>1</numItem>

                               <qtdeItem>10</qtdeItem>

                  </itemPedido>

                  <itemPedido>

                               <numItem>2</numItem>

                               <qtdeItem>11</qtdeItem>

                  </itemPedido>

    </detEvento>

  </eventos>

</envEvento>

 

Exemplo de XML para evento de Cancelamento do Pedido de Prorrogação 1º e 2º prazo.


<envEvento>

  <eventos>

    <detEvento>

           <tpEvento>111502</tpEvento>

           <chNFe>99999999999999999999999999999999999999999998</chNFe>

    </detEvento>

    <detEvento>

            <tpEvento>111503</tpEvento>

            <chNFe>99999999999999999999999999999999999999999999</chNFe>

    </detEvento>

  </eventos>

</envEvento>

 

Os parâmetros de saída do método são:

<soap:Body>

  <REMESSAEVENTORESPONSE>

     <REMESSAEVENTORESULT>

        <STRING>STRING</STRING>

     </REMESSAEVENTORESULT>

  </REMESSAEVENTORESPONSE>

</soap:Body>

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

REMESSAEVENTORESPONSE

-

-

-

1-1

Tag raíz.

REMESSAEVENTORESULT

REMESSAEVENTORESPONSE

 

 

 

 

STRING

REMESSAEVENTORESULT

A

54

0-N

Identificador do Evento, a regra de formação do Id é: “ID”+Código do Evento+Chave da NF-e+Sequencia do Evento.

 

Soup Fault:

 

Fault

Descrição

Invalid Token

O parâmetro USERTOKEN foi passado incorretamente

1

Código da entidade invalida

2

Código da entidade em branco

3

Excedeu o limite de eventos por lote

 

Método NFEMONITORLOTEEVENTO

Método destinado ao monitoramento dos lotes dos novos eventos enviados à SEFAZ

 

Os parâmetros de entrada do método são:

 

<soap:Body>

  <NFEMONITORLOTEEVENTO>

     <USERTOKEN>STRING</USERTOKEN>

     <ID_ENT>STRING</ID_ENT>

     <EVENTO>STRING</EVENTO>

     <LOTE_INICIAL>INTEGER</LOTE_INICIAL>

     <LOTE_FINAL>INTEGER</LOTE_FINAL>

     <CHVINICIAL>INTEGER</CHVINICIAL>

     <CHVFINAL>INTEGER</CHVFINAL>

     <CHAVES>STRING</CHAVES>

  </NFEMONITORLOTEEVENTO>

</soap:Body>

 

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

NFEMONITORLOTEEVENTO

-

-

-

1-1

Tag raíz.

USERTOKEN

NFEMONITORLOTEEVENTO

A

5

1-1

Deverá ser preenchido com o valor “TOTVS”.

ID_ENT

NFEMONITORLOTEEVENTO

A

6

1-1

ID da entidade a ser utilizada.

LOTE_INICIAL

NFEMONITORLOTEEVENTO

N

15

0-1

Número do Lote Inicial

LOTE_FINAL

NFEMONITORLOTEEVENTO

N

15

0-1

Número do Lote Final

EVENTO

 

NFEMONITORLOTEEVENTO

A

6

0-1

Código do evento a ser buscado.

CHVINICIAL

NFEMONITORLOTEEVENTO

N

44

0-1

Chave da nfe inicial

CHVFINAL

NFEMONITORLOTEEVENTO

N

44

0-1

Chave da nfe final

CHAVES

NFEMONITORLOTEEVENTO

A

1-500k

0-1

Numero das chaves entre aspas  separada por virgula

 

Os parâmetros de saída do método 

 

<soap:Body>

  <NFEMONITORLOTEEVENTORESPONSE>

    <NFEMONITORLOTEEVENTORESULT>

    <NFEMONITOREVENTO>

    <LOTE>INTEGER</LOTE>

    <ID_EVENTO>STRING</ID_EVENTO>

    <AMBIENTE>INTEGER</AMBIENTE>

    <PROTOCOLO>INTEGER</PROTOCOLO>

    <DHREGEVEN>STRING</DHREGEVEN>

    <CORGAO>INTEGER</CORGAO>

    <MENSAGEM>STRING</MENSAGEM>

    <MENSAGEMCANC>STRING</MENSAGEMCANC>

    <STATUS>INTEGER</STATUS>

    <STATUSCANC>INTEGER</STATUSCANC>

    <CSTATENV>INTEGER</CSTATENV>

    <CMOTENV>STRING</CMOTENV>

    <CSTATEVEN>INTEGER</CSTATEVEN>

    <CMOTEVEN>STRING</CMOTEVEN>

    <TIPOEVENTO>INTEGER</TIPOEVENTO>

    </NFEMONITOREVENTO>

    </NFEMONITORLOTEEVENTORESULT>

  </NFEMONITORLOTEEVENTORESPONSE>

</soap:Body>

 

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

NFEMONITORLOTEEVENTORESPONSE

-

-

-

1-1

Tag raíz.

NFEMONITORLOTEEVENTORESULT

NFEMONITORLOTEEVENTORESPONSE

-

-

1-1

 

NFEMONITOREVENTO

NFEMONITORLOTEEVENTORESULT

-

-

1-N

 

LOTE

NFEMONITOREVENTO

N

1-15

1-1

Lote de envio do Evento

ID_EVENTO

NFEMONITOREVENTO

A

54

0-1

Identificador do Evento, a regra de formação do Id é:

“ID”+Código do Evento+Chave da NF-e+Sequencia do Evento

AMBIENTE

NFEMONITOREVENTO

N

1

0-1

Identificação do ambiente:

1 – Produção / 2 – Homologação

PROTOCOLO

NFEMONITOREVENTO

A

15

0-1

Número do Protocolo da NF-e 1 posição (1-Secretaria da Fazenda Estadual,2-RFB), 2 posições para o código da UF, 2 posições para o ano e 10 posições para o sequencial no ano

DHREGEVEN

NFEMONITOREVENTO

A

22

0-1

Data e hora de registro do evento no formato AAAA-MMDDTHH:MM:SSTZD (formato UTC, onde TZD é +HH:MM ou –HH:MM), se o evento for rejeitado informar a data e hora de recebimento do evento

CORGAO

NFEMONITOREVENTO

N

2

0-1

Código da UF que registrou o evento. Utilizar 90 para o ambiente nacional

MENSAGEM

NFEMONITOREVENTO

A

1-255

0-1

Mensagem de retorno do processamento

MENSAGEMCANC

NFEMONITOREVENTO

A

1-255

0-1

Mensagem de retorno do evento de cancelamento

STATUS

NFEMONITOREVENTO

N

1

0-1

Status do Evento

[1] Evento Recebido

[2] Evento Assinado

[3] Evento com falha no schema XML

[4] Evento transmitido

[5] Evento com problemas

[6] Evento registrado e vinculado a NF-e

STATUSCANC

NFEMONITOREVENTO

N

8

0-1

Código de status do cancelamento.

CSTATENV

NFEMONITOREVENTO

N

8

0-1

Código do status do retorno do envio do evento

CMOTENV

NFEMONITOREVENTO

A

1-250

0-1

Descrição do status do retorno do envio do evento

CSTATEVEN

NFEMONITOREVENTO

N

8

0-1

Código do status do retorno do evento

CMOTEVEN

NFEMONITOREVENTO

A

1-255

0-1

Descrição do status do retorno do evento

TIPOEVENTO

NFEMONITOREVENTO

N

8

0-1

Código do tipo de evento retornado.

 

Soup Fault:

 

Fault

Descrição

Invalid Token

O parâmetro USERTOKEN foi passado incorretamente

1

Código da entidade invalida

2

Código da entidade em branco

3

Faixa de lotes inválida

 

Método NFERETORNASEQEVENTO

Método destinado ao retorno da sequencia do evento.

 

Os parâmetros de entrada do método são:

<soap:Body>

  <NFEMONITORLOTEEVENTO>

     <USERTOKEN>STRING</USERTOKEN>

    <ID_ENT>STRING</ID_ENT>

     <CHVNFE>STRING</CHVNFE>

    <TPEVENTO>INTEGER</TPEVENTO>

  </NFEMONITORLOTEEVENTO>

</soap:Body>

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

NFERETORNASEQEVENTO

-

-

-

1-1

Tag raíz.

USERTOKEN

NFERETORNASEQEVENTO

A

5

1-1

Deverá ser preenchido com o valor “TOTVS”.

ID_ENT

NFERETORNASEQEVENTO

A

6

1-1

ID da entidade a ser utilizada.

CHVNFE

NFERETORNASEQEVENTO

A

44

1-1

Chave da NF-e

TPEVENTO

NFERETORNASEQEVENTO

N

6

0-1

Codigo do evento

 

Os parâmetros de saida do método são:

 

<soap:Body>

      <NFEMONITORLOTEEVENTORESPONSE>

         <NFEMONITORLOTEEVENTORESULT>

            <NFEMONITOREVENTO>

               <NFERETSEQEVENRESULT>INTEGER</NFERETSEQEVENRESULT>

            </NFEMONITOREVENTO>

        </NFEMONITORLOTEEVENTORESULT>

       </NFEMONITORLOTEEVENTORESPONSE>

</soap:Body> 

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

NFEMONITORLOTEEVENTORESPONSE

-

-

-

1-1

Tag raíz.

NFEMONITORLOTEEVENTORESULT

NFEMONITORLOTEEVENTORESPONSE

 

 

 

 

NFEMONITOREVENTO

NFEMONITORLOTEEVENTORESULT

 

 

 

 

NFERETSEQEVENRESULT

NFEMONITOREVENTO

N

1

1-1

Número sequencial do último evento.

 

Soup Fault:

 

Fault

Descrição

Invalid Token

O parâmetro USERTOKEN foi passado incorretamente

1

Código da entidade invalida

2

Código da entidade em branco

3

ID do evento incorreto

 

 

Método NFERETORNAEVENTO 

Método destinado ao retorno dos eventos vinculados a nota fiscal eletrônica.

 

Os parâmetros de entrada do método são:

<soapenv:Body>

   <NFERETORNAEVENTO>

      <USERTOKEN>STRING</USERTOKEN>

      <ID_ENT>STRING</ID_ENT>

      <ID_EVENTO>STRING</ ID_EVENTO>

      <EVENCHVNFE>STRING</EVENCHVNFE>

   </NFERETORNAEVENTO>

</soapenv:Body>

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

NFERETORNAEVENTO

-

-

-

1-1

Tag raíz.

USERTOKEN

NFERETORNAEVENTO

A

5

1-1

Deverá ser preenchido com o valor “TOTVS”.

ID_ENT

NFERETORNAEVENTO

A

6

1-1

ID da entidade a ser utilizada.

ID_EVENTO

NFERETORNAEVENTO

A

54

1-1

Identificador do Evento, a regra de formação do Id é:

“ID”+Código do Evento+Chave da NF-e+Sequencia do Evento

(Opcional no caso de se querer retornar apenas um evento).

EVENCHVNFE

NFERETORNAEVENTO

A

44

0-1

Chave da NF-e (Opcional no caso de se querer retornar todos os eventos de uma NF-e).

 

Os parâmetros de saída do método são:

<soap:Body>

  <NFERETORNAEVENTORESPONSE>

     <NFERETORNAEVENTORESULT>

        <NFERETORNAEVENTO>

          <ID_ENT>STRING</ID_ENT>

          <LOTE>INTEGER</LOTE>

          <ID_EVENTO>STRING</ID_EVENTO>

          <VERSAO>INTEGER</VERSAO>

          <AMBIENTE>INTEGER</AMBIENTE>

          <CORGAO>INTEGER</CORGAO>

          <CSTAT>INTEGER</CSTAT>

          <STATUS>INTEGER</STATUS>

          <XML_RET>STRING</XML_RET>

          <XML_SIG>STRING</XML_SIG>

          <XMOTIVO>STRING</XMOTIVO>

          </NFERETORNAEVENTO>

      </NFERETORNAEVENTORESULT>

  </NFERETORNAEVENTORESPONSE>

</soap:Body>

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

NFERETORNAEVENTORESPONSE

-

-

-

1-1

Tag raíz.

NFERETORNAEVENTORESULT

NFERETORNAEVENTORESPONSE

-

-

 

 

NFERETORNAEVENTO

NFERETORNAEVENTORESULT

-

-

 

 

ID_ENT

NFERETORNAEVENTO

A

6

1-1

ID da entidade a ser utilizada.

LOTE

NFERETORNAEVENTO

N

8

1-1

Lote de envio do Evento

ID_EVENTO

NFERETORNAEVENTO

A

54

1-1

Identificador do Evento, a regra de formação do Id é:

“ID”+Código do Evento+Chave da NF-e+Sequencia do Evento

VERSAO

NFERETORNAEVENTO

N

3

1-1

Versão do Layout

AMBIENTE

NFERETORNAEVENTO

N

1

1-1

Identificação do ambiente:

1 – Produção / 2 – Homologação

CORGAO

NFERETORNAEVENTO

N

2

1-1

Código da UF que registrou o evento. Utilizar 90 para o ambiente nacional

CSTAT

NFERETORNAEVENTO

N

8

1-1

Código do status da resposta do envio do evento, conforme tabela de códigos de erros e descrições de mensagens de erros

STATUS

NFERETORNAEVENTO

N

8

1-1

Status do Evento

XML_RET

NFERETORNAEVENTO

Binário

1-500k

1-1

XML de retorno da mensagem de registro de Eventos (Layout Mensagem de Retorno), conforme Layout definido na Nota Técnica 2011/003

XML_SIG

NFERETORNAEVENTO

Binário

1-500k

1-1

XML de envio da mensagem de registro de Eventos (Layout Mensagem Entrada), conforme Layout definido na Nota Técnica 2011/003

XMOTIVO

NFERETORNAEVENTO

A

1-250

1-1

Descrição do status da resposta do envio do evento, conforme tabela de códigos de erros e descrições de mensagens de erros

 

Soup Fault:

 

Fault

Descrição

Invalid Token

O parâmetro USERTOKEN foi passado incorretamente

1

Código da entidade invalida

2

Código da entidade em branco

3

ID do evento incorreto

 

Método NFEEXPORTAEVENTO

Método destinado a exportação do arquivo de xml.

 

Os parâmetros de entrada do método são:

<soapenv:Body>

   <NFEEXPORTAEVENTO>

      <USERTOKEN>STRING</USERTOKEN>

      <ID_ENT>STRING</ID_ENT>

      <ID_EVENTO>STRING</ID_EVENTO>

      <CHVINICIAL>STRING</CHVINICIAL>

      <CHVFINAL>STRING</CHVFINAL>

   </NFEEXPORTAEVENTO>

</soapenv:Body> 

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

NFEEXPORTAEVENTO

-

-

-

1-1

Tag raíz.

USERTOKEN

NFEEXPORTAEVENTO

 

A

5

1-1

Deverá ser preenchido com o valor “TOTVS”.

ID_ENT

NFEEXPORTAEVENTO

A

6

1-1

ID da entidade a ser utilizada.

ID_EVENTO

NFEEXPORTAEVENTO

A

54

1-1

Id de identificação do Evento

CHVINICIAL

NFEEXPORTAEVENTO

A

44

1-1

Chave da NFe inicial para o processamento

CHVFINAL

NFEEXPORTAEVENTO

A

44

1-1

Chave da NFe final para o processamento

 

Os parâmetros de saída do método são:

 

<soap:Body>

   <NFEEXPORTAEVENTORESPONSE>

      <NFEEXPORTAEVENTORESULT>

         <STRING>STRING</STRING>

      </NFEEXPORTAEVENTORESULT>

   </NFEEXPORTAEVENTORESPONSE>

</soap:Body>

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

NFEEXPORTAEVENTORESPONSE

-

-

-

1-1

Tag raíz.

NFEEXPORTAEVENTORESULT

NFEEXPORTAEVENTORESPONSE

-

 

 

 

STRING

NFEEXPORTAEVENTORESULT

A

54

0-N

XML de retorno 

 

Soup Fault:

 

Fault

Descrição

Invalid Token

O parâmetro USERTOKEN foi passado incorretamente

1

Código da entidade invalida

2

Código da entidade em branco

3

Entidade não Configurada para Utilizar TOTVS COLABORACAO

 

 

Método CONSULTACHAVENFE 

Método destinado a exportação do arquivo de xml.

 

Os parâmetros de entrada do método são:

<soap:Body>
    <USERTOKEN>STRING</USERTOKEN>
    <ID_ENT>STRING</ID_ENT>
    <CCHVNFE>STRING</CCHVNFE>
</soap:Body>

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

CONSULTACHAVENFE

-

-

-

1-1

Tag raíz.

USERTOKEN

CONSULTACHAVENFE

 

A

5

1-1

Deverá ser preenchido com o valor “TOTVS”.

ID_ENT

CONSULTACHAVENFE

A

6

1-1

ID da entidade a ser utilizada.

CCHAVE

CONSULTACHAVENFE

A

44

1-1

Chave de acesso da NFE, quando informado este parâmetro pelo ERP será realizada a consulta de qualquer NFE.  estando ou não na base de dados.Tomando como padrão o ambiente e modalidade de consulta que está configurado nos parâmetros da Tabela SPED000.

 

Os parâmetros de saída do método são:

<soap:Body>
   <NFEPROTOCOLO>
   <AMBIENTE>INTEGER</AMBIENTE>
   <CODRETNFE>STRING</CODRETNFE>
   <ID>STRING</ID>
   <MSGRETNFE>STRING</MSGRETNFE>
   <PROTOCOLO>STRING</PROTOCOLO>
   <RECBTO>DATE</RECBTO>
   <VERSAO>STRING</VERSAO>
   </NFEPROTOCOLO>
</soap:Body>

 

 

Parâmetro

Tipo

Tam

Pai

Observação

NFEPROTOCOLO

Estrutura

 

 

 

AMBIENTE

Inteiro

001

NFEPROTOCOLO

Ambiente de processamento da NFe. Produção ou homologação.

CODRETNFE

Alfanumérico

003

NFEPROTOCOLO

Código do retorno de processamento da NFe retornado pela SEFAZ

ID

Alfanumérico

1-250

NFEPROTOCOLO

Id de identificação do XML da NFe com o ERP.

MSGRETNFE

Alfanumérico

1-250

NFEPROTOCOLO

Mensagem de retorno de processamento da NFe retornado pela SEFAZ

PROTOCOLO

Alfanumérico

15

NFEPROTOCOLO

Número do protocolo da NFe para cancelamento, inutilização e autorização.

RECBTO

Data

-

NFEPROTOCOLO

Data de processamento 

VERSAO

Alfanumérico

1-20

NFEPROTOCOLO

Versão do aplicativo de processamento
XML_RETAlfanumérico1-500kNFEPROTOCOLO

Retorno do XML completo incluído a resposta dos métodos de EPP. (411500, 411501,  411502 e 411503)

 

Soap Fault:

 

Fault

Descrição

Invalid Token

O parâmetro USERTOKEN foi passado incorretamente

001

Código da entidade invalida

002

Código da entidade em branco

003

Falha de execução da consulta na SEFAZ

 

Serão utilizados os métodos do Web Service MANIFESTACAODESTINATARIO.

 

Através do método SINCRONIZARDOCUMENTOS é que a Sefaz envia a resposta do evento de pedido de prorrogação sendo ele diferido ou não, as respostas são armazenas na tabela SPED150 para futuras consultas.

 

Os parâmetros de entrada do método são:

 

   <soap:Body>

      <SINCRONIZARDOCUMENTOS>

         <USERTOKEN>STRING<USERTOKEN>

         <IDENT>STRING<IDENT>

         <INDNFE>STRING<INDNFE>

         <INDEMI>STRING<INDEMI>

      </man:SINCRONIZARDOCUMENTOS>

   </soap:Body>

 

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

SINCRONIZARDOCUMENTOS

-

-

-

1-1

Tag raíz.

USERTOKEN

SINCRONIZARDOCUMENTOS

A

 5

1-1

 Deverá ser preenchido com o valor “TOTVS”.

IDENT

SINCRONIZARDOCUMENTOS

A

6

1-1

ID da entidade a ser utilizada. 

INDNFE

SINCRONIZARDOCUMENTOSA10-1

Indicação para quais NF-e sincronizar.

Os valores possíveis são:

0 – Todas as NF-e;

1 – Somente as NF-e que ainda não tiveram manifestação do destinatário;

2 – Idem opção 1 incluindo também as NF-e que não tiveram Ciência da Operação declarada.

Caso não seja informado, será utilizado o valor “0” como padrão.

INDEMISINCRONIZARDOCUMENTOSA10-1

Indicação para quais emitentes buscar as NF-e para sincronizar.

Os valores possíveis são:

0 – Todos os emitentes;

1 – Apenas emitentes aonde a raiz do CNPJ seja diferente do destinatário (evitando transferências entre filiais).

Caso não seja informado, será utilizado o valor “0” como padrão.

 

 

Os parâmetros de saída do método são:

 

   <soap:Body>

      <SINCRONIZARDOCUMENTOSRESPONSE>

         <SINCRONIZARDOCUMENTOSRESULT>

            <AMBIENTE>STRING</AMBIENTE>

            <DOCUMENTOS>

               <SINCDOCUMENTOINFO>

                  <CANCNSU>STRING</CANCNSU>

                  <CHAVE>STRING</CHAVE>

                  <CODEVENTO>STRING</CODEVENTO>

                  <SITCONF>STRING</SITCONF>

               </SINCDOCUMENTOINFO>

            </DOCUMENTOS>

            <IDENT>STRING</IDENT>

            <INDCONT>STRING</INDCONT>

         </SINCRONIZARDOCUMENTOSRESULT>

      </SINCRONIZARDOCUMENTOSRESPONSE>

   </soap:Body>

 

 

 

Nome

Pai

Tipo

Tam.

Ocor.

Observações

SINCRONIZARDOCUMENTOSRESULT

-

-

-

1-1

Tag raíz.

AMBIENTE

SINCRONIZARDOCUMENTOSRESULT

A

1

1-1

Ambiente consultado.

Os valores possíveis são:

1 – Produção;

2 –Homologação.

DOCUMENTOS

SINCRONIZARDOCUMENTOSRESULT

-

-

-

Tag raíz para os documentos sincronizados.

SINCDOCUMENTOINFO

DOCUMENTOS---

Tag raíz para as informações de um documento sincronizado

CANCNSUSINCDOCUMENTOINFOA150-1

NSU do cancelamento.

CHAVESINCDOCUMENTOINFOA440-1Chave do documento sincronizado.
CODEVENTOSINCDOCUMENTOINFOA60-1 Tipo do evento
SITCONFSINCDOCUMENTOINFOA10-1 

Código da situação da confirmação do documento.

Os valores possíveis são:

0 – Sem manifestação do destinatário;
1 – Confirmada operação;
2 – Desconhecida;
3 – Operação não realizada; 

4 – Ciência.
IDENTSINCDOCUMENTOINFOA61-1 Código da entidade. 
INDCONTSINCDOCUMENTOINFOA11-1Indicador de continuação:

0 - SEFAZ não possui mais documentos para o CNPJ informado;

1 - SEFAZ possui mais documentos para o CNPJ informado, ou ainda não avaliou a totalidade da sua base de dados.

 

Soup Fault:

 

Fault

Descrição

Invalid Token

O parâmetro USERTOKEN foi passado incorretamente

1

Código da entidade em branco.

2

Código da entidade inválido.

3

Alguma falha ocorreu no processo interno do método.

Falha de PostFalha de execução em post: https://

 

 

Na Tag CODEVENTO quando o evento sincronizado for referente ao evento de pedido de prorrogação, a tag estará  preenchida com o tipo do eventos( 411500, 411501, 411502 ou 411503). Para qualquer outro tipo de evento a tag vem em branco.

 

Após a nota ser sincronizada corretamente os métodos  abaixo estaram disponíveis para consulta:

  • NFEEXPORTAEVENTO
  • NFERETORNASEQEVENTO
  • NFERETORNAEVENTO
  • NFEMONITORLOTEEVENTO
Método destinado a exportação do arquivo de xml.
Os parâmetros de entrada do método são:

 Este documento é material de especificação dos requisitos de Manutenção, trata-se de conteúdo extremamente técnico.