Averbação de documentos

Será possível realizar a averbação de documentos do tipo CT-e, NF-e e também outros documentos como NFS-e. Confira as particularidades de cada modalidade abaixo.

CT-e / NF-e

Após a autenticação do token, caso o transportador ou embarcador queira averbar um CT-e ou NF-e o basta acionar a chamada correspondente na API.

Resposta bem sucedida

Caso o documento seja averbado com sucesso, o segurado receberá a seguinte mensagem de retorno:

CODE

{
  "status": "sucesso",
  "mensagem": "A averbação foi aprovada!"
  "documento": {
    "série": 1,
    "chave": "string"
    "status": "endorsed"
  },
  "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-06",
    "data_embarque": "2023-10-06",
    "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-06",
    "data_criacao": "2023-10-06",
  }
}

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 o documento seja enviado mais de uma vez para a averbação, o sistema não duplicará os documentos. No retorno do webservice aparecerá a mensagem:

CODE

{
  "status": "sucesso",
  "mensagem": "Documento já averbado anteriormente!"
  "documento": {
    "série": 1,
    "chave": "string"
    "status": "endorsed"
  },
  "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-06",
    "data_embarque": "2023-10-06",
    "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-06",
    "data_criacao": "2023-10-06",
  }
}

Caso o documento seja recusado no momento da aplicação das regras de negócio, o sistema informará o motivo da recusa no retorno do webservice. A mensagem poderá ser apresentada da seguinte forma:

CODE

{
  "status": "erro",
  "mensagem": "A averbação foi recusada!",
  "erros": [
    "Não foi informada a data de embarque no documento!"
    ]
}

CODE

{
  "status": "erro",
  "mensagem": "A averbação foi recusada!",
  "erros": [
    "O valor do documento ultrapassou o limite da apólice! Valor informado: R$250.000,00 | Valor da apólice: R$100.000,00"
    ]
}

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.

XML - Outros Documentos

A estrutura de outros documentos, como a NFS-e, é diferente das demais por não ser protocolada pela SEFAZ. Com ela o segurado tem a oportunidade de utilizar essa estrutura e nela identificar o tipo de documento que ele quer averbar. Aqui, tratamos de documentos diferentes de CT-e e NF-e que são utilizados para o processo de averbação.

É preciso manter os seguintes pontos em observação:

O segurado que utiliza a NDD como sistema emissor terá o layout fornecido de forma nativa.
Já os segurados que não utilizam a NDD deverão desenvolver o layout junto ao seu sistema emissor.
Para averbar o XML Outros Documentos é necessário acionar a chamada correspondente na API.
O sistema não duplicará a averbação caso o usuário realize o envio do mesmo documento mais de uma vez.
A consistência do “tipo” de documento, ou seja, a forma como o sistema irá determinar o tipo do documento, é realizada pela tag “mod”, detalhada abaixo:
- 99 - CTRC
- 98 - NFS-e
- 97 - Ordem de Coleta
- 96 - MIC
- 95 - Controle de Embarque
- 94 - Minuta
- 93 - CRT
- 92 - RPS
- 91 - Romaneio

Resposta bem sucedida

Confira um exemplo de resposta bem sucedida na averbação de Outros Documentos:

CODE

<?xml version="1.0" encoding="UTF-8"?>
<otherXmlSchema>
	<cteProc>
		<CTe>
			<infCte>
				<ide>
					<mod>98</mod>
					<serie>0</serie>
					<nCT>1</nCT>
					<dhEmi>2023-08-08T09:42:12-03:00</dhEmi>
					<tpAmb>1</tpAmb>
					<tpCTe>0</tpCTe>
					<modal>1</modal>
					<tpServ>0</tpServ>
					<cMunIni>3503901</cMunIni>
					<UFIni>SP</UFIni>
					<cMunFim>3505708</cMunFim>
					<UFFim>SP</UFFim>
					<toma03>
						<toma>0</toma>
					</toma03>
				</ide>
				<compl>
					</ObsCont xCampo="PLACA">
						<xTexto>ZZZ-1111</xTexto>
					</ObsCont>
				</compl>
				<emit>
					<CNPJ>00000000000000</CNPJ>
					<enderEmit>
						<cMun>3520509</cMun>
						<UF>SP</UF>
					</enderEmit>
				</emit>
				<rem>
					<CNPJ>00000000000000</CNPJ>
					<enderReme>
						<cMun>9999999</cMun>
						<UF>EX</UF>
						<cPais>8451</cPais>
					</enderReme>
				</rem>
				<dest>
					<CNPJ>00000000000000</CNPJ>
					<enderDest>
						<cMun>3520509</cMun>
						<UF>RJ</UF>
						<cPais>1058</cPais>
					</enderDest>
				</dest>
				<infCTeNorm>
					<infCarga>
						<vCarga>5000.00</vCarga>
					</infCarga>
					<seg>
						<respSeg>5</respSeg>
						<vCarga>
					</seg>
				</infCTeNorm>
			</infCte>
		</CTe>
	</cteProc>
</otherXmlSchema>

Em caso de duplicidade na averbação será apresentada a seguinte mensagem:

CODE

{
  "status": "sucesso",
  "mensagem": "Documento já averbado anteriormente!",
  "documento": {
    "serie": "0",
    "numero": 31,
    "chave": "00231000000000000000980000000000310000000001",
    "modelo_documento": 98,
    "status": "endorsed"
  },
  "averbacao": {
    "protocolo": "9a664d6f-89bd-4b3c-ba6d-face8c299f38",
    "data_criacao": "2023-10-18 12:09:24",
    "data_atualizacao": "2023-10-18 12:09:24",
    "numero_averbacao: 0000010230000000000000098000000000031150",
    "status": "endorsed",
    "origem": "webservice",
    "seguradora_id": "9a5679d2-dfa7-4c60-ab11-c943312bdc33",
    "corretora_id": "9a567a03-6474-49a6-8b61-f8594f057edd",
    "apolice_id": "9a567b40-3fde-4306-bba2-6bf4cea8fb67",
    "data_embarque": "2023-10-18 12:09:24",
    "valor_carga": "5000",    
    "total_segurado": "5000",
    "ramo": "54",
    "uf_origem": "SP",
    "cidade_origem": "3503901",
    "uf_destino": "SP",
    "cidade_destino": "3505708",
    "data_emissao": "2023-10-10 07:09:05",
    "modalidade": "RODOVIARIO",
    "servico": "NORMAL",
    "movimentacao": "string",
    "adicionais": "[\"container\", \"accessories\", \"taxes\", \"breakdowns\", \"loading_unloading\", \"load_lifting\",
  \"load_removal\", \"tracked\", \"complementary_route\", \"own_means\", \"license_plate\", \"escort\"]",
    "urbano": true,
    "serie": "0",
    "numero": 31,
    "movimentacao": "NORMAL"
  }
}

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 exemplos de erro na averbação de Outros documentos:

CODE

{
  "status": "erro",
  "mensagem": "A averbação foi recusada!",
  "erros": [
    "O valor do documento ultrapassou o limite da apólice! Valor informado: R$5.000.000,00 | Valor da apólice: R$100.000,00"
  ]
}

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.

A Averbação Internacional é feita através de um formulário presente no portal NDD Averba.