Este documento é material de especificação dos requisitos de manutenção, trata-se de conteúdo extremamente técnico. |
|---|
Especificação | |||
Produto | TSS | Módulo | NFC-e |
Segmento Executor | Serviços | ||
Chamado/ISSUE | DSERTSS1-11439 | ||
País | ( X ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||
Demonstrar as implementações necessárias para atender a Nota Técnica 2018.004 - versão 1.0 - Dezembro de 2018.
Este documento tem por objetivo a definição das especificações e critérios técnicos necessários para a implementação do evento "Cancelamento por Substituição" (tpEvento=110112).
Conforme a legislação atual, este evento será implementado inicialmente para a NFC-e (modelo 65), aguardando possível alteração da legislação em relação a NF-e (modelo 55).
Prazo previsto para implantação conforme a NT:
O NFC-e sofreu uma implementação, incluindo o evento de cancelamento por substituição.
Conforme o ajuste SINIEF 07/18, que alterou o ajuste 19/6, em sua cláusula décima quinta, alínea "a)", traz a seguinte redação: Na hipótese prevista no inciso I da cláusula segunda, o emitente poderá solicitar o cancelamento da NFC-e, desde que tenha sido emitida uma outra NFC-e em contingência para acobertar a mesma operação, em prazo não superior a 168 horas, podendo ser reduzido a critério de cada unidade federada, contado do momento em que foi concedida a Autorização de Uso da NFC-e. Consulte a Nota Técnica 2018.004 - Evento de cancelamento da NFC-e por Substituição para verificação das alterações na NFC-e, modelo 65. É imprescindível a leitura completa desta Nota Técnica para entendimento das alterações.
Serão utilizados os métodos dos Web Services abaixo:
Serviço: NFESBRA
Método destinado ao envio em lote dos novos eventos da Nota Fiscal Eletrônica – NF-e, Manifestação Eletrônico de Documentos Fiscais – MDF-e e Conhecimento de Transporte Eletrônico – CT-e. Os eventos são recebidos em lote, porém, são tratados e enviados a SEFAZ individualmente..
Os parâmetros de entrada do método são:
<soap:Body>
<USERTOKEN>STRING</USERTOKEN>
<ID_ENT>STRING</ID_ENT>
<XML_LOTE>BINÁRIO</XML_LOTE>
</soap:Body>
| Nome | Pai | Tipo | Tam. | Ocor. | Observações |
|---|---|---|---|---|---|
| REMESSAEVENTO | - | - | - | - | TAG raiz da requisição |
| USERTOKEN | - | A | 5 | 1-1 | Deve ser preenchido com a string “TOTVS” |
| ID_ENT | - | A | 6 | 1-1 | ID da entidade a ser utilizada |
| XML_LOTE | - | BINÁRIO | 1-500k | 1-1 | XML do Lote de envio dos eventos, este XML será definido conforme o Layout de cada evento |
Soap Fault
Fault | Descrição |
Invalid Token | O parâmetro “USERTOKEN” foi passado incorretamente. |
1 | Código da entidade inválida. |
2 | Código da entidade em branco. |
Para o envio dos eventos, foi disponibilizado um leiaute padrão atender a todos os eventos disponibilizados para a NFe,tendo como diferencial para cada evento,apenas 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 | Tam. | Ocor. | 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) |
Evento modelo 65 – NFCe
| Tipo de Evento | Modelo de NFCe | Descrição Evento | Tipo de Autor do Evento | Local Evento |
|---|---|---|---|---|
| 110112 | 65 | Evento de Cancelamento de NFC-e por Substituição | Emitente | SEFAZ Autorizadora |
Campo | Ele | Pai | Tipo | Ocor | Tam. | Descrição |
detEvento | G | - | E | 1-N | - | Informações do Evento (estrutura XML variável, depende do tipo de evento) |
tpEvento | E | CC03 | Num | 1-1 | 06 | Tipo de Evento Informar : 110112 |
chNFe | E | CC03 | Num | 1-1 | 44 | Chave de Acesso do NFC-e a qual o evento será vinculado |
ambiente | E | CC03 | Num | 1-1 | 01 | Informar o ambiente de emissão do NFc-e |
xJust | E | CC03 | Alfa | 1-1 | 15-255 | Informar a justificativa do cancelamento. |
| cOrgaoAutor | E | CC03 | Num | 1-1 | 2 | Código do Órgão Autor do Evento. Informar o Código da UF para este Evento. Nota: Campo exclusivo do Evento “110112 – Cancelamento por substituição”. |
| tpAutor | E | CC03 | Num | 1-1 | 1 | Informar 1=Empresa Emitente. Valores: 1=Empresa Emitente, 2=Empresa destinatária; 3=Empresa; 5=Fisco; 6=RFB; 9=Outros Órgãos; Nota: Campo exclusivo do Evento “110112 – Cancelamento por substituição”. |
| nProt | E | CC03 | Num | 1-1 | 1-15 | Trazer automaticamente o número do protocolo |
| verAplic | E | CC03 | Alfa | 1-1 | 1-20 | Versão do aplicativo do Autor do Evento. Nota: Campo exclusivo do Evento “110112 – Cancelamento por substituição” |
| chNFeRef | E | CC03 | Alfa | 1-1 | 44 | Informa a chave de acesso da NF-e substituta da NF-e a ser cancelada. Nota: Campo exclusivo do Evento "110112 - Cancelamento por substituição" |
- Modelo XML do evento de Cancelamento por substituição:
<envEvento>
<eventos>
<detEvento>
<tpEvento>110112</tpEvento>
<chNFe>13190499113791000199653230000008431998893650</chNFe>
<xCorrecao>Teste de evento de Cancelamento por substituicao da NFC-e</xCorrecao>
<tpAutor>1</tpAutor>
<nProt>113190007099999</nProt> <xJust>Evento <xJust>Evento de cancelamento por substituicao da NFC-e</xJust>
<chNFeRef>13190499113791000199653230000008441998893657</chNFeRef>
</detEvento>
</eventos>
</envEvento>
Soap Fault
Fault | Descrição |
Invalid Token | O parâmetro “USERTOKEN” foi passado incorretamente. |
001 | ID do evento incoreto |
002 | Nota fiscal eletrônica não encontrada |
| 003 | Justificativa não informada |
Schema XML:
envEventoCancNFe_v9.99.xsd (tpEvento=110111)
envEventoCancSubst_v1.0.xsd (tpEvento=110112)
ID | CAMPO | ELE. | PAI | TIPO | OCOR. | TAM. | DESCRIÇÃO \ OBSERVAÇÃO |
| P01 | envEvento | Raiz | - | - | - | - | TAG raiz da mensagem de envio. |
| P02 | versao | A | P01 | N | 1-1 | 2v2 | Versão do leiaute. |
| P03 | idLote | E | P01 | N | 1-1 | 1-15 | Identificador de controle do Lote de envio do Evento. Número sequencial único para identificação do Lote, de uso exclusivo do autor do evento. O Web Service não faz qualquer uso deste identificador. |
| P04 | evento | G | P01 | XML | 1-20 | - | Evento, um lote pode conter até 20 eventos. |
| P05 | versao | A | P04 | N | 1-1 | 2v2 | Versão do leiaute do evento. |
| P06 | infEvento | G | P04 | - | 1-1 | - | Grupo de informações do registro do Evento. |
| P07 | id | ID | P06 | C | 1-1 | 54 | Identificador da TAG a ser assinada, formado por: "ID" + tpEvento + Chave da NF-e + nSeqEvento. |
| P08 | cOrgao | E | P06 | N | 1-1 | 2 | Código do órgão de recepção do Evento, conforme Tabela do IBGE ou: 91 - Ambiente Nacional. Informar o código da UF para este evento. |
| P09 | tpAmb | E | P06 | N | 1-1 | 1 | Identificação do Ambiente: 1=Produção; 2=Homologação. |
| P10 | CNPJ | CE | P06 | N | 1-1 | 14 | Informar o CNPJ do autor do Evento. |
| P11 | CPF | CE | P06 | N | 1-1 | 11 | Informar o CPF do autor do Evento. |
| P12 | chNfe | E | P06 | N | 1-1 | 44 | Chave de Acesso da NF-e à qual o evento será vinculado. |
| P13 | dhEvento | E | P06 | D | 1-1 | - | Data e hora do evento no formato AAAAMMDDThh:mm:ssTZD (UTC – Universal Coordinated Time). |
| P14 | tpEvento | E | P06 | N | 1-1 | 6 | Código do evento: - 110111 - “Cancelamento” - 110112 - “Cancelamento por substituição” |
| P15 | nSeqEvento | E | P06 | N | 1-1 | 1-2 | Sequencial do evento para o mesmo tipo de evento. Informar o valor “1” para este evento. |
| P16 | verEvento | E | P06 | N | 1-1 | 2v2 | Versão do grupo de detalhe do evento. |
| P17 | detEvento | G | P06 | 1-1 | - | Detalhes do evento. | |
| P18 | versao | A | P17 | N | 1-1 | 2v2 | Informar o mesmo valor da tag "verEvento" (P16). |
| P19 | descEvento | E | P17 | C | 1-1 | 5-60 | Ver a descrição do evento, unto com o Tipo de Evento documentado anteriormente. |
| P20 | cOrgaoAutor | E | P17 | N | 1-1 | 2 | Código do Órgão Autor do Evento. Informar o Código da UF para este Evento. Nota: Campo exclusivo do Evento “110112 – Cancelamento por substituição”. |
| P21 | tpAutor | E | P17 | N | 1-1 | 1 | Informar 1=Empresa Emitente. Valores possíveis: 1=Empresa Emitente, 2=Empresa destinatária; 3=Empresa; 5=Fisco; 6=RFB; 9=Outros Órgãos; Nota: Campo exclusivo do Evento “110112 – Cancelamento por substituição” |
| P22 | verAplic | E | P17 | C | 1-1 | 1-20 | Versão do aplicativo do Autor do Evento. Nota: Campo exclusivo do Evento “110112 – Cancelamento por substituição” |
| P23 | nProt | E | P17 | N | 1-1 | 15 | Informar o número do Protocolo de Autorização da NF-e a ser cancelada. |
| P30 | xJust | E | P17 | C | 1-1 | 15-255 | Informar a justificativa do cancelamento. |
| P31 | chNfeRef | E | P17 | N | 1-1 | 44 | Informa a chave de acesso da NF-e substituta da NF-e a ser cancelada. Nota: Campo exclusivo do Evento “110112 – Cancelamento por substituição” |
| P91 | Signature | G | P04 | XML | 1-1 | - | Assinatura Digital do documento XML, a assinatura deverá ser aplicada no elemento infEvento. |
Nota: No caso de evento registrado com sucesso, os campos opcionais serão retornados.
Schema XML:
retEnvEventoCancNFe_v1.0.xsd (tpEvento=110111)
retEventoCancSubst_v1.0.xsd (tpEvento=110112)
ID | CAMPO | ELE. | PAI | TIPO | OCOR. | TAM. | DESCRIÇÃO \ OBSERVAÇÃO |
| R01 | retEnvEvento | Raiz | - | - | - | - | TAG raiz da mensagem de retorno. |
| R02 | versao | A | R01 | N | 1-1 | 2v2 | Versão do leiaute. |
| R03 | idLote | E | R01 | N | 1-1 | 1-15 | Idem a mensagem de entrada. |
| R04 | tpAmb | E | R01 | N | 1-1 | 1 | Idem a mensagem de entrada. |
| R05 | verAplic | E | R01 | C | 1-1 | 1-20 | Versão da aplicação que processou o evento. |
| R06 | cOrgao | E | R01 | N | 1-1 | 2 | Órgão de recepção do Evento, idem a mensagem de entrada. |
| R07 | cStat | E | R01 | N | 1-1 | 3 | Código do status da resposta. |
| R08 | xMotivo | E | R01 | C | 1-1 | 1-255 | Descrição do status da resposta. |
| R09 | retEvento | G | R01 | - | 0-20 | - | Grupo do resultado do processamento do Evento. |
| R10 | versao | A | A | N | 1-1 | 2v2 | Versão do leiaute. |
| R11 | infEvento | G | G | 1-1 | - | Grupo de informações do registro do Evento. | |
| R12 | Id | ID | ID | C | 0-1 | 17 | Identificador da TAG a ser assinada, somente deve ser informado se o órgão de registro assinar a resposta. No caso de assinatura, preencher com o número do protocolo, precedido pela literal “ID” . |
| R13 | tpAmb | E | R11 | N | 1-1 | 1 | Idem a mensagem de entrada. |
| R14 | verAplic | E | R11 | C | 1-1 | 1-20 | Versão da aplicação que registrou o Evento, utilizar literal que permita a identificação do órgão, como a sigla da UF ou do órgão. |
| R15 | cOrgao | E | R11 | N | 1-1 | 2 | Idem a mensagem de entrada. |
| R16 | cStat | E | R11 | N | 1-1 | 3 | Código do status da resposta. |
| R17 | xMotivo | E | R11 | C | 1-1 | 1-255 | Descrição do status da resposta. |
| R18 | chNFe | E | R11 | N | 0-1 | 44 | Idem a mensagem de entrada. |
| R19 | tpEvento | E | R11 | N | 0-1 | 6 | Idem a mensagem de entrada. |
| R20 | xEvento | E | R11 | C | 0-1 | 5-60 | Idem a mensagem de entrada. |
| R21 | nSeqEvento | E | R11 | N | 0-1 | 1-2 | Idem a mensagem de entrada. |
| R22 | cOrgaoAutor | E | R11 | N | 0-1 | 2 | Idem a mensagem de entrada. Nota: Campo exclusivo do Evento “110112 – Cancelamento por substituição” |
| R23 | CNPJDest | CE | R11 | N | 0-1 | 14 | Informar o CNPJ do destinatário da NF-e Nota: Campo exclusivo do Evento “110111 – Cancelamento” |
| R24 | CPFDest | CE | R11 | N | 0-1 | 11 | Informar o CPF do destinatário da NF-e Nota: Campo exclusivo do Evento “110111 – Cancelamento” |
| R25 | emailDest | E | R11 | C | 0-1 | 1-60 | E-mail do destinatário informado na NF-e Nota: Campo exclusivo do Evento “110111 – Cancelamento” |
| R30 | dhRegEvento | E | R11 | D | 1-1 | - | Data e hora de registro do evento no formato AAAA-MMDDTHH:MM:SSTZD (formato UTC). Se o evento for rejeitado informar a data e hora de recebimento do evento. |
| R31 | nProt | E | R11 | N | 0-1 | 15 | Número do Protocolo do Evento 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. |
| R91 | Signature | G | R09 | XML | 0-1 | - | Assinatura Digital do documento XML, a assinatura deverá ser aplicada no elemento infEvento. A decisão de assinar a mensagem fica a critério da UF. |
Regras de validações referentes ao tpEvento 110112 (Cancelamento por Substituição de NFC-e)
| ID | REGRA DE VALIDAÇÃO | APLIC. | MSG | DESCRIÇÃO DO ERRO |
|---|---|---|---|---|
P12-48 | Se <tpEvento> = 110112 e: - <tpEmis> da Chave de Acesso diferente de 1- Normal; - <tpEmis> da Chave de Acesso substituta (tag: chNFeRef) é diferente de 9-Contingência; | Obrig. | 920 | Rejeição: Tipo de Emissão inválido no Cancelamento por Substituição |
| P20-10 | Se <tpEvento> = 110112 e UF do Autor (cOrgaoAutor) diverge da UF da Chave de Acesso | Obrig. | 455 | Rejeição: Órgão Autor do evento difere da UF da Chave de Acesso |
| P31-10 | Se <tpEvento> = 110112, validar a Chave de Acesso substituta (tag chNFeRef): - Dígito verificador inválido | Obrig. | 910 | Rejeição> chave de Acessoo NF-e Substituta inválida (Dígito) |
| P31-14 | Código UF inválido | Obrig. | 910 | Rejeição: Chave de Acesso NF-e Substituta inválida (Código UF) |
| P31-18 | Ano < 06 ou ano maior que o Ano corrente | Obrig. | 910 | Rejeição: Chave de Acesso NF-e Substituta inválida (Ano) |
| P31-22 | Mês = 0 ou Mês > 12 | Obrig. | 910 | Rejeição: Chave de Acesso NF-e Substituta inválida (Mês) |
P31-26 | CNPJ/CPF zerado ou dígito inválido Nota: Considerar a Série para determinar se CNPJ/CPF na Chave de Acesso. CNPJ: Série=[0-909], CPF: Série<>[0-909] | Obrig. | 910 | Rejeição: Chave de Acesso NF-e Substituta inválida (CNPJ/CPF) |
| P31-30 | Modelo diferente de 55 ou 65 | Obrig. | 910 | Rejeição: Chave de Acesso NF-e Substituta inválida (Modelo) |
| P31-34 | Número NF = 0 | Obrig. | 910 | Rejeição: Chave de Acesso NF-e Substituta inválida (Número) |
| P31-38 | Chave de Acesso da NF-e Substituta igual a Chave de Acesso da NF-e a ser cancelada | Obrig. | 911 | Rejeição: Chave de Acesso NF-e Substituta incorreta (mesma Chave de Acesso) |
| P31-42 | Chave de Acesso da NF-e Substituta com UF divergente da Chave de Acesso da NF-e a ser cancelada | Obrig. | 911 | Rejeição: Chave de Acesso NF-e Substituta incorreta (Código da UF) |
P31-46 | Chave de Acesso da NF-e Substituta com CNPJ/CPF divergente da Chave de Acesso da NF-e a ser cancelada Nota: Considerar a Série para determinar se CNPJ/CPF na Chave de Acesso. CNPJ: Série=[0-909], CPF: Série<>[0-909] | Obrig. | 911 | Rejeição: Chave de Acesso NF-e Substituta incorreta (CNPJ/CPF) |
| P31-52 | Chave de Acesso da NF-e Substituta com Modelo divergente da Chave de Acesso da NF-e a ser cancelada | Obrig. | 911 | Rejeição: Chave de Acesso NF-e Substituta incorreta (Modelo) |
| Banco de Dados: NF-e | ||||
2P12-18 | Se <tpEvento> = 110112: - Verificar se NF-e está autorizada há mais de 7 dias (168 horas) Nota: Considera a exceção de prazo definida em legislação estadual | Obrig. | 501 | Rejeição: Prazo de cancelamento superior ao previsto na Legislação |
| Banco de Dados: NF-e_2 | ||||
5P31-10 | Se <tpEvento> = 110112: Acesso BD NFE (Chave: Chave de Acesso Substituta, tag:chNFeRef): - Chave Acesso Substituta inexistente | Obrig. | 912 | Rejeição: NF-e Substituta inexistente |
| 5P31-14 | Situação da NF-e = Denegada ou Cancelada | Obrig. | 913 | Rejeição: NF-e Substituta Denegada ou Cancelada |
| 5P31-20 | Data de emissão da NF-e substituta (chNFeRef) maior que 2 horas da data de emissão da NF-e a ser cancelada (chNFe) | Obrig. | 914 | Rejeição: Data de emissão da NF-e Substituta maior que 2 horas da data de emissão da NF-e a ser cancelada |
| 5P31-24 | Valor total da NF-e substituta (chNFeRef) difere do valor total da NF-e a ser cancelada (chNFe) | Obrig. | 915 | Rejeição: Valor total da NF-e Substituta difere do valor da NF-e a ser cancelada |
| 5P31-28 | Valor total do ICMS da NF-e substituta (chNFeRef) difere do valor total do ICMS da NFe a ser cancelada (chNFe) | Obrig. | 916 | Rejeição: Valor total do ICMS da NF-e Substituta difere do valor da NF-e a ser cancelada |
| 5P31-32 | Se foi identificado o destinatário na NF-e original (CNPJ/CPF/ID Estrangeiro): - Identificação do destinatário (CNPJ/CPF/ID Estrangeiro, IE) da NF-e substituta (chNFeRef) difere da identificação do destinatário da NF-e a ser cancelada (chNFe). | Obrig. | 917 | Rejeição: Identificação do destinatário da NF-e Substituta difere da identificação do destinatário da NF-e a ser cancelada. |
| 5P31-36 | Quantidade de Itens da NF-e substituta (chNFeRef) difere da quantidade de itens da NFe a ser cancelada (chNFe) | Obrig. | 918 | Rejeição: Quantidade de itens da NF-e Substituta difere da quantidade de itens da NF-e a ser cancelada |
| 5P31-40 | Verificar se o item da NF-e substituta (chNFeRef) difere do respectivo item da NF-e a ser cancelada (chNFe). Nota: Verificar divergência para os campos cProd, cEAN, xProd, NCM, CFOP, uCom, qCom, vUnCom, vProd, indTot | Obrig. | 919 | Rejeição: Item da NF-e Substituta difere do mesmo item da NF-e a ser cancelada. |
- Implementação no XML do Cancelamento por Substituição, ex:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:nfs="http://webservices.totvs.com.br/nfsebra.apw">
<soapenv:Header/>
<soapenv:Body>
<nfs:CANCELAEVENTO>
<nfs:USERTOKEN>?</nfs:USERTOKEN>
<nfs:ID_ENT>?</nfs:ID_ENT>
<!--Optional:-->
<nfs:DOC_ID>?</nfs:DOC_ID>
<!--Optional:-->
<nfs:MOTIVO>?</nfs:MOTIVO>
<!--Optional:-->
<nfs:XML_LOTE>ew0KIlRQRVZFTlRPIiA6ICIxMTAxMTIiLA0KIk9SR19BVVQiOiJTUCIsDQoiVFBfQVVUIjoiMSIsDQoiRE9DX0lEX1NVQlMiOiIzMjIwMDAwMDA4MTYiDQp9</nfs:XML_LOTE>
<nfs:SINCRONO>?</nfs:SINCRONO>
</nfs:CANCELAEVENTO>
</soapenv:Body>
</soapenv:Envelope>
- Ajustar os métodos de RETORNO e MONITORAÇÃO dos eventos de cancelamento (NFeMonitorLoteEvento, NFeRetornaEvento, MonitorFaixa, MonitorX...) para adequar as mensagens de retorno com a nova tag.
- Exibir o status da mensagem no monitor, referente ao cancelamento por substituição, ex: Evento cancelado por substituição
Nota: A SEFAZ autorizadora poderá aceitar o cancelamento fora de prazo, mantendo um código de retorno diferente para estes casos. Nestes casos, deverá ser utilizado o Status “155-Cancelamento homologado fora de prazo”.
| CÓDIGO | MOTIVO DE NÃO ATENDIMENTO DA SOLICITAÇÃO |
|---|---|
| 910 | Rejeição: Chave de Acesso NF-e Substituta inválida (<Nome do campo>). |
| 911 | Rejeição: Chave de Acesso NF-e Substituta incorreta (<Nome do campo>). |
| 912 | Rejeição: NF-e Substituta inexistente. |
| 913 | Rejeição: NF-e Substituta Denegada ou Cancelada. |
| 914 | Rejeição: Data de emissão da NF-e Substituta maior que 2 horas da data de emissão da NFe a ser cancelada. |
| 915 | Rejeição: Valor total da NF-e Substituta difere do valor da NF-e a ser cancelada. |
| 916 | Rejeição: Valor total do ICMS da NF-e Substituta difere do valor da NF-e a ser cancelada. |
| 917 | Rejeição: Identificação do destinatário da NF-e Substituta difere da identificação do destinatário da NF-e a ser cancelada. |
| 918 | Rejeição: Quantidade de itens da NF-e Substituta difere da quantidade de itens da NF-e a ser cancelada. |
| 919 | Rejeição: Item da NF-e Substituta difere do mesmo item da NF-e a ser cancelada. |
| 920 | Rejeição: Tipo de Emissão inválido no Cancelamento por Substituição. |
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
|---|
