Skip to main content
Skip table of contents

MDF-e

A API permitirá realizar as seguintes operações com documentos do tipo MDF-e:

  1. Registro

  2. Cancelamento

  3. Encerramento

  4. Inclusão de novo condutor

Registro

Embora a API do NDD Averba permita realizar o registro deste tipo de documento, é preciso salientar que o MDF-e não é um documento usado para averbação, ele é um complemento de informações da carga. Para que sua transmissão seja realizada com sucesso o documento deverá, obrigatoriamente, estar protocolado pela SEFAZ.

Não será permitido ter duplicidade de documentos. Por isso, ao transmitir o mesmo MDF-e mais de uma vez, o sistema acusará erro no retorno.

Resposta bem sucedida

Se todos os critérios obrigatórios forem atendidos, após a validação do sistema será apresentada a seguinte mensagem de sucesso:

CODE 
{
  "status": "sucesso",
  "mensagem": "MDF-e importado com sucesso!"
  "documento": {
    "status": "AUTORIZADO"
    "chave": "00000000000000000000000000000000000000000000",
    "série": "1",
    "numero": 22
  },
  "averbacao": {
    "protocolo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tipo": "cte",
    "cte_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "serie": "string",
    "numero": 0,
    "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
  },
  "averbacao_secundaria": null
}

Os valores apresentados nas mensagens 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

Caso os requisitos obrigatórios não sejam atendidos, após a validação do sistema será apresentada a mensagem de erro específica para a situação.

CODE 
{
  "status": "erro",
  "mensagem": "MDF-e já importado anteriormente!",
  "erros": null
}

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

Cancelamento

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 MDF-e!",
  "documento": {
    "serie": "1",
    "numero": "3",
    "chave": "00000000000000000000000000000000000000000000",
    "status": "CANCELADO"
    },
  "averbacao": {
    "protocolo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tipo": "cte",
    "cte_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "serie": "string",
    "numero": 0,
    "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-17",
    "data_embarque": "2023-10-17",
    "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-17",
    "data_criacao": "2023-10-17",
    "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-17",
    "data_pedido_cancelamento": "2023-10-17",
    "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
  },
  "averbacao_secundaria": {
    "protocolo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tipo": "cte",
    "cte_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "serie": "string",
    "numero": 0,
    "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-17",
    "data_embarque": "2023-10-17",
    "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-17",
    "data_criacao": "2023-10-17",
    "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-17",
    "data_pedido_cancelamento": "2023-10-17",
    "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.

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 MDF-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.

Encerramento

Muitas vezes a seguradora pode exigir que além da transmissão do MDF-e, seja também feito o encerramento do documento. Para realizar o encerramento do manifesto é obrigatório ter registrado o documento original previamente, caso contrário será apresentado erro na operação.

Não será permitido ter duplicidade de documentos. Caso o segurado envie mais de uma vez o XML de encerramento, o sistema retornará erro.

Resposta bem sucedida

Com todos os critérios atendidos, será apresentada a resposta de sucesso:

CODE 
{
  "status": "sucesso",
  "mensagem": "O encerramento foi registrado para o MDF-e!",
  "documento": {
  "status": "ENCERRADO",
  "chave": "00000000000000000000000000000000000000000000",
    "serie": "1",
    "numero": 5
},
  "averbacao": {
    "protocolo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tipo": "cte",
    "cte_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "serie": "string",
    "numero": 0,
    "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
  },
  "averbacao_secundaria": {
    "protocolo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tipo": "cte",
    "cte_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "serie": "string",
    "numero": 0,
    "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.

Resposta com erro

Caso os critérios obrigatórios não sejam atendidos, será apresentada a resposta de erro específica conforme exemplos abaixo:

CODE 
{
  "status": "erro",
  "mensagem": "Não foi possível registrar o encerramento para o MDF-e!",
  "erros": [
    "O evento já foi registrado anteriormente!"
  ]
}
CODE 
{
  "status": "erro",
  "mensagem": "Não foi encontrado o MDF-e para encerramento!",
}

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.

Incluir novo condutor

Caso seja necessário realizar a troca de um condutor durante o período de transporte, será preciso realizar um manifesto para a inclusão desse novo motorista. Esse MDF-e precisa, obrigatoriamente, ser registrado na base do NDD Averba, para isso basta acionar a chamada correspondente na API.

Não será permitido ter duplicidade de documentos. Caso o segurado envie mais de uma vez o manifesto, o sistema retornará erro.

Resposta bem sucedida

Com todos os critérios atendidos, será apresentada a resposta de sucesso:

CODE 
{
  "status": "sucesso",
  "mensagem": "A inclusão do motorista foi registrada para o MDF-e!",
  "documento": {
  "status": "AUTORIZADO",
  "chave": "00000000000000000000000000000000000000000000",
    "serie": "1",
    "numero": 3
},
  "averbacao": {
    "protocolo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tipo": "cte",
    "cte_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "serie": "string",
    "numero": 0,
    "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
  },
  "averbacao_secundaria": {
    "protocolo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tipo": "cte",
    "cte_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "serie": "string",
    "numero": 0,
    "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.

Resposta com erro

Caso os critérios obrigatórios não sejam atendidos, será apresentada a resposta de erro específica conforme exemplos abaixo:

CODE 
{
  "status": "erro",
  "mensagem": "Não foi possível registrar a inclusão de motorista para o MDF-e!",
  "erros": [
    "O evento já foi registrado anteriormente!"
  ]
}
CODE 
{
  "status": "erro",
  "mensagem": "Não foi encontrado o MDF-e para inclusão de motorista!",
}

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.

{{component-feedback-article}}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close