Cancelamento de documentos

A API do NDD Averba também permite que seja realizado o cancelamento de algum documento previamente averbado. Confira as particularidades de cada modalidade abaixo.

CT-e / NF-e

Para que o usuário realize o cancelamento de um documento no sistema, será obrigatório que a chave do documento esteja registrada na base de dados da NDD. Ao enviar o XML de Cancelamento o sistema irá validar se a chave existe na base de dados e em caso positivo. o cancelamento será efetivado. Caso não tenha a chave da averbação, o sistema irá recusar a operação de cancelamento e tratará o documento como inexistente.

Resposta bem sucedida

Sempre que o usuário enviar o documento, o sistema irá fazer a validação do mesmo. Caso todos os critérios sejam atendidos, será retornada a resposta dessa chamada com a seguinte mensagem:

CODE

{
  "status": "sucesso",
  "mensagem": "O cancelamento foi registrado para o CT-e!",
  "documento": {
    "serie": "1",
    "numero": "3",
    "chave": "00000000000000000000000000000000000000000000",
    "status": "canceled"
    },
  "averbacao": {
    "protocolo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tipo": "cte",
    "cte_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "numero_averbacao": "string",
    "status": "endorsed",
    "origem": "portal",
    "apolice_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "seguradora_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "corretora_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "data_emissao": "2023-10-10",
    "data_embarque": "2023-10-10",
    "valor_carga": 0,
    "total_segurado": 0,
    "ramo": "21",
    "uf_origem": "string",
    "cidade_origem": 0,
    "uf_destino": "string",
    "cidade_destino": 0,
    "modalidade": "RODOVIARIO",
    "servico": "string",
    "movimentacao": "string",
    "produto_predominante": "string",
    "adicionais": [
      "container"
    ],
    "urbano": true,
    "data_atualizacao": "2023-10-10",
    "data_criacao": "2023-10-10",
    "assessoria_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "averbacao_internacional_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cocorretora_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "data_cancelamento": "2023-10-10",
    "data_pedido_cancelamento": "2023-10-10",
    "fatura_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "frete": "string",
    "mdfe_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "motivo_cancelamento": "string",
    "nfe_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "procoloco_cancelamento": "string",
    "segurado_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status_premio": "calculated",
    "sucursal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tarifa_aplicada": 0,
    "taxa_aplicada": 0,
    "valor_acessorios": 0,
    "valor_avarias": 0,
    "valor_container": 0,
    "valor_despesas": 0,
    "valor_frete": 0,
    "valor_impostos": 0,
    "valor_lucros_esperados": 0,
    "valor_premio": 0,
    "valor_segundo_risco": 0
  }
}

Os valores apresentados na mensagem acima são uma representação para exemplificar uma mensagem de sucesso. Eles podem variar de acordo com os valores do documento importado.

Também serão exibidas as informações da averbação, como data de emissão, criação, total segurado, etc.

Resposta com erro

Após o sistema validar os documentos enviados, caso não seja atendido algum dos critérios obrigatórios, será apresentada uma mensagem de erro especificando a situação. Confira um exemplo abaixo:

CODE

{
  "status": "erro",
  "mensagem": "Não foi encontrado o CT-e para cancelamento!"
}

Os valores apresentados na mensagem acima são uma representação para exemplificar uma mensagem de erro. Eles podem variar de acordo com os valores do documento importado.

Caso o transportador envie um documento de cancelamento, mas a chave do documento mencionada no XML não esteja averbada/registrada, o sistema retornará a recusa destacada acima. Para os casos em que houver a tentativa de cancelar um documento que já foi cancelado anteriormente, será apresentada a mensagem de erro informando que o processo já foi feito.

XML - Outros Documentos

Para cancelar uma averbação realizada pelo XML outros documentos, o segurado deverá também desenvolver uma estrutura de cancelamento. Isso porque o layout não é protocolado pela SEFAZ. Para realizar o cancelamento, será necessário acionar a chamada correspondente na API.

Diferente do CT-e e NF-e que o sistema utiliza a chave do documento para realizar o cancelamento, na estrutura de cancelamento do XML Outros Documentos o segurado deve informar o número de averbação do documento averbado anteriormente.

Exemplo:

CT-e

Série: 1

Número: 1

Número de Averbação: 0000010230000000000000057001000000001108

Além de acionar a chamada correspondente, o segurado deverá informar o número acima na estrutura de cancelamento. Caso o número informado seja válido, o sistema realizará o cancelamento, mas se o mesmo não for válido, não o sistema recusará.

Resposta bem sucedida

Confira exemplos de respostas bem sucedidas no cancelamento de Outros Documentos:

CODE

<retCancCTe xmlns="http://www.portalfiscal.inf.br/cte" versao="1.04">
  <infCanc>
    <tpAmb/>
    <cUF/>
    <verAplic>99</verAplic>
    <cStat>101</cStat>
    <xMotivo>Cancelamento de CT-e homologado</xMotivo>
    <chCTe>0000010230000000000000098000000000001133</chCTe>
    <dhRecbto>2023-10-10T10:06:00</drRecbto>
    <nProt>0000010230000000000000098000000000001133</nProt>
  </infCanc>
</retCancCTe>

CODE

{
  "status": "sucesso",
  "mensagem": "O cancelamento foi registrado para o NFS-e!",
  "documento": {
    "serie": "0",
    "numero": 14,
    "chave": "00231000000000000009800000000000140000000002",
    "modelo_documento": 98,
    "status": "canceled"
  },
  "averbacao": {
    "protocolo": "9a664cb4-a47d-475e-94c6-111a79767fe8",
    "data_emissao": "2023-10-10 07:09:05",
    "data_embarque": "2023-10-18 12:06:41",
    "data_criacao": "2023-10-18 12:06:41",
    "total_segurado": "5000"
  }
}

Os valores apresentados na mensagem acima são uma representação para exemplificar uma mensagem de sucesso. Eles podem variar de acordo com os valores do documento importado.

Resposta com erro

Confira um exemplo de erro no cancelamento de Outros documentos:

CODE

{
  "status": "erro",
  "mensagem": "Erro: Nenhuma averbação encontrada para o protocolo informado"
}

Os valores apresentados na mensagem acima são uma representação para exemplificar uma mensagem de erro. Eles podem variar de acordo com os valores do documento importado.