- 5. Web Service da DC-e
5.2. Cancela DC-e - 5.1. EnviaDCe
« Anterior - 5.3. Consulta DC-e
Próximo »
5.2. Cancela DC-e
Cancelamento da DC-e
Assinatura
string CancelaDCe(string siglaWS, int tipoAmbiente, string nomeCertificado, string versao, out string msgDados, out string msgRetWS, out int resultado, out string msgResultado, string chaveDCe, string nProtocolo, string justificativa, string dataEvento, out string nProtocoloCanc, out string dProtocoloCanc, string proxy, string usuario, string senha, string licenca)
Descrição:
Funcionalidade para Cancelamento da DC-e.
Condições para Cancelamento
- DC-e autorizado há menos de 24 horas;
- Ainda não tenha ocorrido o início do transporte;
- Possuir o número do protocolo de autorização de uso.
Prazo de cancelamento
Em até 24 horas da autorização de uso da DC-e objeto do cancelamento.
Número do Protocolo de Autorização de Uso da DC-e objeto do cancelamento
Informar o Número do Protocolo de Autorização de uso da DC-e.
justificativa de cancelamento
Informar a justificativa do cancelamento com pelo menos 15 caracteres, não é permitido a existência de espaços em branco no início ou fim da justificativa e nem são permitidos caracteres de formatação como quebra de linha/tabulação/etc. no texto da justificativa.
dataEvento
informar a data e hora do evento de cancelamento. Se a data e hora informada for maior que a data do WS vai ocorrer o erro "635 - Rejeição: A data do evento não pode ser maior que a data do processamento", examine a tag dhRecbto do retorno do WS e verifique se o horário do equipamento não está adiantado em relação ao horário do WS.
Parâmetros da chamada:
nome | tipo | fluxo | descrição |
---|---|---|---|
siglaWS | string | entrada | informar a sigla "RS" |
tipoAmbiente | inteiro | entrada | informar o código do ambiente que será processado o evento de cancelamento de Manifesto: 1- produção ou 2-homologação |
nomeCertificado | string | entrada | informar nome do titular do certificado a ser utilizado na assinatura e conexão SSL com o WS: É permitido o uso do certificado digital que tenha o mesmo CNPJ base (oito primeiros dígitos do CNPJ) do emissor da DC-e. 1. informar o assunto do certificado digital que deve existir no repositório MY do current user, ex.: "CN=NFe - Associacao NF-e:99999090910270, C=BR, L=PORTO ALEGRE, O=Teste Projeto NFe RS, OU=Teste Projeto NFe RS, S=RS". 2. informar: NUMEROSERIE|[número de série] quando não seja possível localizar o certificado digital pelo assunto; 3. informar: ARQUIVO | [nome do arquivo pfx com caminho completo] | [senha do arquivo] para uso do certificado digital em arquivo pfx, ex.: "ARQUIVO|c:\certificado.pfx|senha". 4. informar: CERTIFICADO | [string base64 do arquivo pfx] | [senha do arquivo] no parâmetro NomeCertificado para passar uma string contendo um certificado digital em base64, ex.:"CERTIFICADO|MIIGoDCCBYigAwIBAgIQep(arquivo pfx do certificado digital convertido em base64...)QQDExNBQy|senha". |
versao | string | entrada | informar a versão da mensagem do WS: "1.00" ou "3.00" |
msgDados | string | saída | retorna a mensagem XML do pedido de cancelamento que foi enviado ao WS. |
msgRetWS | string | saída | retorna a mensagem XML de resposta do WS |
resultado | inteiro | saída | retorna o resultado do processamento do pedido de cancelamento, veja a tabela de retorno. Teremos o retorno do código 135 quando o cancelamento for homologado, o retorno de código diferente de 135 significa que houve algum problema no processamento do pedido de cancelamento do Manifesto. |
msgResultado | string | saída | retorna a literal do resultado da chamada do WS |
chaveDCe | string | entrada | informar chave de Acesso da DC-e que se pretende cancelar |
nProtocolo | string | entrada | informar o número do protocolo de autorização de uso da DC-e objeto do cancelamento |
justificativa | string | entrada | informar a justificativa do cancelamento com pelo menos 15 caracteres. Não é permitido a existência de espaços em branco no início ou fim da justificativa e nem são permitidos caracteres de formatação como quebra de linha/tab/etc. no texto da justificativa. |
dataEvento | string | entrada | informar a data e hora da data do cancelamento no formato UTC (data e hora com fuso horário): "AAAA-MM-DDTHH:MM:SS-HH:00". Exemplos: 2025-01-13T12:34:00-02:00 (fuso horário de Brasília no horário de verão). 2025-01-13T12:34:00-03:00 (fuso horário de Brasília). Se nada for informado (""), a DLL utilizará a data e hora e fuso horário do equipamento. |
nProtocoloCanc | string | saída | retorna o número do protocolo de homologação de cancelamento. |
dProtocoloCanc | string | saída | retorna a data e hora de homologação do cancelamento. |
proxy | string | entrada | informar 'http://proxyserver:port' quando existir uso de proxy no ambiente. verificar com o cliente qual é o endereço do servidor proxy e a porta https, a porta padrão do https é 443, assim teríamos algo do tipo 'http://192.168.15.1:443' |
usuario | string | entrada | informar o usuário para autenticação no proxy, se necessário |
senha | string | entrada | informar a senha de autenticação no proxy, se necessário |
licenca | string | entrada | informar a chave da licenca de uso ou registro, esta funcionalidade pode ser utilizada sem qualquer restrição no ambiente de homologação. O uso em ambiente de produção requer o licenciamento ou registro, para maiores detalhes veja as condições de uso |
XML do Retorno da chamada:
Quando o cancelamento for homologado pelo Web Service, haverá o retorno do XML composto pelo evento de pedido de cancelamento da DC-e e respectivo protocolo de homologação de cancelamento da DC-e.
O emissor deve manter este XML.
Tabela de códigos de Retorno do parâmetro resultado:
código | Mensagem | origem | regra |
---|---|---|---|
5101 | Erro: A mensagem de retorno do WS não é um XML válido: [mensagem de retorno] | DLL | - |
5102 | Erro: Tag cStat inexistente na mensagem de retorno [mensagem de erro] | DLL | - |
5103 | Erro: Tag xMotivo inexistente na mensagem de retorno [mensagem de erro] | DLL | - |
5104 | Erro: Tag [nome tag] inexistente na mensagem de retorno [mensagem de erro] | DLL | - |
5105 | Erro: O WS não devolveu nenhum resultado | DLL | - |
5201 | Erro: O código do tipo de ambiente [tipo de ambiente recebido pela DLL] informado diferente de 1 - produção e 2 - homologação | DLL | - |
5202 | Erro: A sigla da UF [sigla recebida pela DLL] informada é inválida | DLL | - |
5203 | Erro: Inexiste url para a UF [sigla UF] informada no ambiente [ambiente informado] desejado, verifique se existe atualização do arquivo [nome arquivo] disponível. | DLL | - |
5204 | Erro: Arquivo que contem a URL do WS não localizado em [caminho da aplicação] | DLL | - |
5205 | Erro: Ocorreu um erro inesperado no processamento da URL (URL) : [mensagem de ERRO DO WINDOWS] | DLL | - |
5206 | Erro: Ocorreu um erro de validação do XML (nome XML) : [mensagem de ERRO DO WINDOWS] | DLL | - |
5403 | Erro: Falha ao acessar certificado digital [mensagem de ERRO DO WINDOWS] | DLL | - |
5404 | Erro: Nenhum certificado digital selecionado | DLL | |
5405 | Erro: Nenhum certificado válido foi encontrado com o nome [NomeCertificado] informado no repositório [MY do CurrentUser] | DLL | - |
5406 | Erro: Falha no tratamento do parâmetro nome: [nome informado] | DLL | - |
5407 | Erro: Quantidade de parâmetros inválido: [nome informado] | DLL | - |
5408 | Erro: Falha na criação do objeto certificate: [mensagem do ERRO DO WINDOWS] | DLL | - |
6501 | Erro: O parâmetro siglaWS deve ser informado | DLL | - |
6502 | Erro: O parâmetro tipoAmbiente deve ser informado | DLL | - |
6503 | Erro: O parâmetro tipoAmbiente [valor informado] deve ser 1 ou 2 | DLL | - |
6504 | Erro: O nome do titular do certificado deve ser informado | DLL | - |
6505 | Erro: O parâmetro chaveDCe não informado | DLL | - |
6506 | Erro: O tamanho [tamanho] do parâmetro chaveDCe informado não tem 44 caracteres | DLL | - |
6507 | Erro: As posições correspondentes (1,2) ao código da UF [valor informado] do parâmetro chaveDCe não é um código de UF válido | DLL | - |
6508 | Erro: O conteúdo do parâmetro número do protocolo: [valor informado] deve ter 16 posições | DLL | - |
6509 | Erro: O conteúdo do parâmetro justificativa: [valor informado] deve ter pelo menos 15 posições | DLL | - |
6510 | Erro: O parâmetro número do protocolo deve ser informado | DLL | - |
6511 | Erro: O parâmetro justificativa deve ter se informado | DLL | - |
6512 | Erro: O parâmetro versao não foi informado | DLL | - |
6513 | Erro: O parâmetro dataEvento é inválida: [valor informado] | DLL | - |
6514 | Erro: O conteúdo do parâmetro versao informado é inválido: [valor informado], a DLL espera: [valor esperado] | DLL | - |
6515 | Erro: A chave da DC-e do retEventoDCe: [chaveDCe] é divergente da chave da DC-e do Evento: [chaveDCe] | DLL | - |
7001 | Erro: A licença não foi informada [Identificação da versão da DLL em uso] | DLL | - |
7002 | Erro: A licença informada: [valor informado] tem tamanho:[tamanho] diferente de 128 - [Identificação da versão da DLL em uso] | DLL | - |
7003 | Erro: A licença informada: [valor informado] não pertence ao CNPJ:[valor informado] [Identificação da versão da DLL em uso] | DLL | - |
135 | Evento registrado e vinculado a MDF-e | WS | - |
136 | Evento registrado, mas não vinculado a MDF-e | WS | - |
108 | Serviço Paralisado Momentaneamente (curto prazo) | WS | B03 |
109 | Serviço Paralisado sem Previsão | WS | B04 |
203 | Rejeição: Emissor não habilitado para emissão da DC-e | WS | K03 |
213 | Rejeição: CNPJ-Base do Emitente difere do CNPJ-Base do Certificado Digital | WS | F03 |
214 | Rejeição: Tamanho da mensagem excedeu o limite estabelecido | WS | B01 |
215 | Rejeição: Falha no schema XML | WS | D01 |
217 | Rejeição: MDF-e não consta na base de dados da SEFAZ | WS | J16 |
218 | Rejeição: MDF-e já está cancelado na base de dados da SEFAZ. | WS | K04 |
219 | Rejeição: Circulação da DC-e verificada | WS | K08 |
220 | Rejeição: MDF-e autorizado há mais de 24 horas | WS | K05 |
222 | Rejeição: Protocolo de Autorização de Uso difere do cadastrado | WS | K06 |
226 | Rejeição: Código da UF do Emitente diverge da UF autorizadora | WS | J02 |
236 | Rejeição: Chave de Acesso com dígito verificador inválido | WS | J07 |
238 | Rejeição: Cabeçalho - Versão do arquivo XML superior a Versão vigente | WS | C05 |
239 | Rejeição: Cabeçalho - Versão do arquivo XML não suportada | WS | C06 |
242 | Rejeição: Elemento mdfeCabecMsg inexistente no SOAP Header | WS | C01 |
243 | Rejeição: XML Mal Formado | WS | B02 |
249 | Rejeição: UF da Chave de Acesso diverge da UF autorizadora | WS | K01 |
252 | Rejeição: Ambiente informado diverge do Ambiente de recebimento | WS | G001 |
280 | Rejeição: Certificado Transmissor inválido | WS | A01 |
281 | Rejeição: Certificado Transmissor Data Validade | WS | A02 |
282 | Rejeição: Certificado Transmissor sem CNPJ | WS | A07 |
283 | Rejeição: Certificado Transmissor - erro Cadeia de Certificação | WS | A03 |
284 | Rejeição: Certificado Transmissor revogado | WS | A05 |
285 | Rejeição: Certificado Transmissor difere ICP-Brasil | WS | A06 |
286 | Rejeição: Certificado Transmissor erro no acesso a LCR | WS | A04 |
290 | Rejeição: Certificado Assinatura inválido | WS | E01 |
291 | Rejeição: Certificado Assinatura Data Validade | WS | E02 |
292 | Rejeição: Certificado Assinatura sem CNPJ | WS | E03 |
293 | Rejeição: Certificado Assinatura - erro Cadeia de Certificação | WS | E04 |
294 | Rejeição: Certificado Assinatura revogado | WS | E06 |
295 | Rejeição: Certificado Assinatura difere ICP-Brasil | WS | E07 |
296 | Rejeição: Certificado Assinatura erro no acesso a LCR | WS | E05 |
297 | Rejeição: Assinatura difere do calculado | WS | F02 |
298 | Rejeição: Assinatura difere do padrão do Projeto | WS | F01 |
402 | Rejeição: XML da área de dados com codificação diferente de UTF-8 | WS | D03 |
404 | Rejeição: Uso de prefixo de namespace não permitido | WS | D02 |
409 | Rejeição: Campo cUF inexistente no elemento mdfeCabecMsg do SOAP Header | WS | C02 |
410 | Rejeição: UF informada no campo cUF não é atendida pelo WebService | WS | C03 |
411 | Rejeição: Campo versaoDados inexistente no elemento mdfeCabecMsg do SOAP Header | WS | C04 |
592 | Rejeição: Chave de acesso inválida (Ano < 2012 ou Ano maior que Ano corrente) | WS | J08 |
593 | Rejeição: Chave de acesso inválida (Mês = 0 ou Mês > 12) | WS | J09 |
594 | Rejeição: Chave de acesso inválida (CNPJ zerado ou digito inválido) | WS | J10 |
595 | Rejeição: Chave de acesso inválida (modelo diferente de 58) | WS | J11 |
596 | Rejeição: Chave de acesso inválida (numero DCe = 0) | WS | J12 |
598 | Rejeicao: Usar somente o namespace padrao da DC-e | WS | D02 |
599 | Rejeicao: Nao eh permitida a presenca de caracteres de edicao no inicio/fim da mensagem ou entre as tags da mensagem | WS | D03 |
600 | Rejeição: Chave de Acesso difere da existente em BD | WS | J17 |
609 | Rejeição: MDF-e já está encerrado na base de dados da SEFAZ | WS | K07 |
627 | Rejeição: CNPJ do autor do evento inválido | WS | J03 |
628 | Rejeição: Erro Atributo ID do evento não corresponde a concatenação dos campos (ID + tpEvento + chDCe + nSeqEvento) | WS | J04 |
629 | Rejeição: O tpEvento informado inválido | WS | J05 |
630 | Rejeição: Falha no Schema XML específico para o evento | WS | J06 |
631 | Rejeição: Duplicidade de evento | WS | J13 |
632 | Rejeição: O autor do evento diverge do emissor da DC-e | WS | J14 |
633 | Rejeição: O autor do evento não é um órgão autorizado a gerar o evento | WS | J15 |
634 | Rejeição: A data do evento não pode ser menor que a data de emissão da DC-e | WS | J18 |
635 | Rejeição: A data do evento não pode ser maior que a data do processamento | WS | J20 |
636 | Rejeição: O numero sequencial do evento é maior que o permitido | WS | K02 |
637 | Rejeição: A data do evento não pode ser menor que a data de autorização da DC-e | WS | J19 |
Tratamento de Erro:
Caso ocorra algum erro na chamada do WS (5001-7003) ou a requisição não seja atendida pelo WS (214-999), será gravado um log na pasta log, com as seguintes informações que devem ser úteis para identificação do problema:
- Timestamp - data e hora da ocorrência do erro
- WS - nome do WS acessado
- URL - URL do WS acessado
- ambiente - código do ambiente
- certificado - nome do titular (assunto) do certificado digital utilizado
- erro - código e descrição do erro
- msgDados - mensagem gerada pela DLL enviada ao WS
- msgRetWS - conteúdo do retorno do WS
Os erros com código > 5000 são erros tratados pela DLL e ocorrem nas seguintes situações:
- 5001 - 5017 - falha na tentativa de consumir o WS (problema de conexão/rede)
- 5101 - 5105 - falha no tratamento do XML de resposta do WS (problema na resposta do WS)
- 5201 - 5206 - falha na recuperação da URL do WS desejado (problema no arquivo de configuração da URL)
- 5403 - 5408 - falha no acesso ao certificado digital
- 6501 - 6515 - falha no tratamento dos parâmetros da chamada da DLL
- 7001 - 7003 - falha na validação da licença de uso
Histórico de atualização:
- 2025-05-20 - versão inicial
Exemplo de XML de Evento de Pedido de Cancelamento de um MDF-e
<eventoDCe xmlns="http://www.portalfiscal.inf.br/dce" versao="1.00"> <infEvento Id="ID11011135250510142785000190990000000000011308085037001"> <cOrgao>35</cOrgao> <tpAmb>2</tpAmb> <tpEmit>3</tpEmit> <CNPJAutor>10142785000190</CNPJAutor> <CNPJUsEmit>00000000037940</CNPJUsEmit> <chDCe>35250510142785000190990000000000011308085037</chDCe> <dhEvento>2025-05-17T21:49:27-03:00</dhEvento> <tpEvento>110111</tpEvento> <nSeqEvento>1</nSeqEvento> <detEvento versaoEvento="1.00"> <evCancDCe> <descEvento>Cancelamento</descEvento> <nProt>1351200000000200</nProt> <xJust>Teste de cancelamento</xJust> </evCancDCe> </detEvento> </infEvento> <Signature xmlns="http://www.w3.org/2000/09/xmldsig#"> <SignedInfo> <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /> <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" /> <Reference URI="#ID11011135250510142785000190990000000000011308085037001"> <Transforms> <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /> <Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /> </Transforms> <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" /> <DigestValue>Zzvl/Fg2zdmy7U2ijuaaPnEGmjQ=</DigestValue> </Reference> </SignedInfo> <SignatureValue>UCmr7CHsSBpRGkPBqBuOsOxIJ8T1L(...)p9czgaY+c50z1GM5ZU4RiAtMMdY1Xg/4qTX8M8bw==</SignatureValue> <KeyInfo> <X509Data> <X509Certificate>MIIH3jCCBcagAwIBAgIIcl2Ceg(...)/5CW0wDQYJKoZ5vUhJ+OucWnapIPwNDzo=</X509Certificate> </X509Data> </KeyInfo> </Signature> </eventoDCe>
Exemplo de XML de Retorno com rejeição do Pedido de Cancelamento
494 - Chave de Acesso Inexistente. (chDCe:35250510142785000190990000000000011308085037]
<retEventoDCe xmlns="http://www.portalfiscal.inf.br/dce" versao="1.00"> <infEvento> <tpAmb>2</tpAmb> <verAplic>PR-v0.5.7</verAplic> <cOrgao>41</cOrgao> <cStat>494</cStat> <xMotivo>Chave de Acesso Inexistente. (chDCe:35250510142785000190990000000000011308085037]</xMotivo> </infEvento> </retEventoDCe>
Exemplos de uso:
Visual Basic 6.0
' declara e instancia DLL Dim objDCeUtil As Object Set objDCeUtil = CreateObject("DCe_Util.Util") ' declarar parâmetros Dim siglaWS As String Dim tipoAmbiente As Integer Dim nomeCertificado As String Dim versao As String Dim msgDados As String Dim msgRetWS As String Dim cStat As Integer Dim msgResultado As String Dim CNPJEmit As String Dim CPFEmit As String Dim idOutroEmit As String Dim chaveDCe As String Dim nProtocolo As String Dim justificativa As String Dim dhEvento As String Dim nProtocoloCanc As String Dim dProtocoloCanc As String Dim licenca As String Dim proxy As String Dim usuario As String Dim senha As String Dim eventoDCe As String ' inicialização dos parâmetros siglaWS = "" tipoAmbiente = 0 nomeCertificado = "" versao = "" msgDados = "" msgRetWS = "" cStat = 0 msgResultado = "" CNPJEmit = "" CPFEmit = "" idOutroEmit = "" chaveDCe = "" nProtocolo = "" justificativa = "" dhEvento = "" nProtocoloCanc = "" dProtocoloCanc = "" licenca = "" proxy = "" usuario = "" senha = "" licenca = "" eventoDCe = "" ' informar os parâmetros básicos do chamada siglaWS = "PR" tipoAmbiente = 2 nomeCertificado = "CN=FLEXDOCS INFORMATICA LTDA:10142785000190, OU=presencial, OU=20085105000106, OU=RFB e-CNPJ A1, OU=Secretaria da Receita Federal do Brasil - RFB, L=OURINHOS, S=SP, O=ICP-Brasil, C=BR" versao = "1.00" ' informar os dados da DC-e objeto do cancelamento CNPJEmit = "00000000037940" chaveDCe = "35250510142785000190990000000000011308085037" nProtocolo = "1351200000000200" justificativa = "Teste de cancelamento" dhEvento = "" ' consome Web Service eventoDCe = objDCeUtil.CancelaDCe(siglaWS, _ tipoAmbiente, _ nomeCertificado, _ versao, _ msgDados, _ msgRetWS, _ cStat, _ msgResultado, _ CNPJEmit, _ CPFEmit, _ idOutroEmit, _ chaveDCe, _ nProtocolo, _ justificativa, _ dhEvento, _ nProtocoloCanc, _ dProtocoloCanc, _ proxy, _ usuario, _ senha, _ licenca) ' ' mostra mensagem XML enviada e a mensagem de retorno do WS ' MsgBox msgResultado + Chr(13) + Chr(13) + msgDados + Chr(13) + Chr(13) + msgRetWS, vbInformation, "Resultado do Cancelamento do DCe" ' ' analisar o retorno da chamada, se cStat= 135 o cancelamento foi realizado, gravar ou guardar o eventoDCe ' ' se cStat diferente de 135, houve algum problema na chamada, necessário analisar o cStat e tomar a medida adequada. '
- 5.2. Cancela DC-e
5. Web Service da DC-e - « Anterior
5.1. EnviaDCe - Próximo »
5.3. Consulta DC-e