2. Averbando CTe AT&M

Projeto/Sistema:
Serviço AT&M Averbação

Versão do Template:
1.1

Processo:
Averbação CTe AT&M

Versão do Documento:
1.2

Responsável(eis):
Gustavo Fernandes

Data:

02/10/2024

1. Introdução

Este processo visa exemplificar a averbação CTe pelo serviço AT&M no GA

2. Processo averbação CTe - validações

I - Fluxograma Exemplo

Processo	Envolvidos	Dados de entrada	Dados de Saída
Consumo webservice	Sistema e WebService	URL: webserver.averba.com.br/rest/CTE Cabeçalho: Authorization: informar o Token. Accept: Informar application/json ou application/xml Content-Type: Deve ser application/xml Body (Corpo): XML do documento CT-e protocolado no SEFAZ.	Retorna JSON para verificação pelo WebService
Token inválido/expirado	Sistema e WebService	Validando arquivo enviado	Retorna mensagem de erro
Token válido	Sistema e WebService	Validando arquivo enviado	Envia XML para webservice
JSON/XML com erros	Sistema e WebService	Verifica retorno JSON/XXML do WebService	Retorno dos erros em JSON/XML com códigos de erro
JSON/XML aprovado	Sistema e WebService	Verifica retorno JSON/XML do WebService	Averba Cte, retorna mensagem autorizado

Processos Relacionados

Comunicação GA (Login) AT&m

Especificação Funcional

PROC002 VALIDANDO AVERBAÇÃO AT&M:

Protótipo de Tela:

II - Exemplo de como deve aparecer averbadora da seguradora

Regras de Interface:

1. Deve mostrar averbadora abaixo da seguradora, antes de averbar, conforme o que esta cadastrado.

2. Retornar mensagem padrão igual da Porto Seguro, quando averbar com sucesso!

Regras de Negócio:

1. O serviço trata as informações, enviadas do GA(Usuário, Senha, CodATM, XML do CTe a ser Averbado);

1.2 As informações tratadas devem ser do primeiro processo, especificação neste link: Comunicação GA (Login) AT&m

1.2.1 Além de enviar as informações anteriores, deve acionar o consumo através da URL abaixo:

URL: webserver.averba.com.br/rest/CTE
Cabeçalho:
Authorization: informar o Token.
Accept: Informar application/json ou application/xml
Content-Type: Deve ser application/xml

Body (Corpo): XML do documento CT-e protocolado no SEFAZ.

OBS: O envio do documento deve ser XML.

Exemplo de envio em cURL:

curl -X POST \

https://webserver.averba.com.br/rest/CTe\

-H 'Accept: application/json' \

-H 'Accept-Encoding: gzip, deflate' \

-H 'Authorization: Bearer TOKEN' \

-H 'Cache-Control: no-cache' \

-H 'Connection: keep-alive' \

-H 'Content-Type: application/xml' \

-H 'cache-control: no-cache' \

-d ' '<cteProc versao="3.00" xmlns="http://www.portalfiscal.infr.br/cte">

ESTRUTURA DO XML

</cteProc>'

2. Exemplo de output ou retorno em JSON:

{
 "Numero": “”,
 "Serie": “”,
 "Filial": “”,
 "CNPJCli": “”,
 "TpDoc": “”,
 "InfAdic": “”,
 "Averbado": {
 "dhAverbacao": “”,
 "Protocolo": “”,
 "DadosSeguro": [{
 "NumeroAverbacao": “”,
 "CNPJSeguradora": “”,
   "NomeSeguradora": “”,
 "NumApolice": “”,
 "TpMov": “”,
 "TpDDR": “”,
 "ValorAverbado": “”,
 "RamoAverbado": “”
 }]
 },
 "Infos": {
 "Info": [{
 "Codigo": “”,
 "Descricao": “”
 }]
 }
}

2.1 Retorno dos erros em JSON:

{
 "Numero": “”,
 "Serie": “”,
 "Filial": “”,
 "CNPJCli": “”,
 "TpDoc": “”,
 "InfAdic": “”,
 "Erros": {
 "Erro":[ {
 "Codigo": “”,
 "Descricao": “”,
 "ValorEsperado": “”,
 "ValorInformado": “”
 }]
 }
}

2.2 Exemplo de retorno output ou retorno em XML:

<Response>
     <Numero></Numero>
     <Serie></Serie>
     <Filial></Filial>
     <CNPJCli></CNPJCli>
     <TpDoc></TpDoc>
     <InfAdic></InfAdic>
     <Averbado>
             <dhAverbacao></dhAverbacao>
             <Protocolo></Protocolo>
             <DadosSeguro>
                   <NumeroAverbacao></NumeroAverbacao>
                   <CNPJSeguradora></CNPJSeguradora>
                   <NomeSeguradora></NomeSeguradora>
                   <NumApolice></NumApolice>
                   <TpMov></TpMov>
                   <TpDDR></TpDDR>
                   <ValorAverbado></ValorAverbado>
                   <RamoAverbado></RamoAverbado>
 			 </DadosSeguro>
 </Averbado>
  
 <Infos>
 	<Info>
       <Codigo></Codigo>
       <Descricao></Descricao>
    </Info>
 </Infos>
</Response>

2.3 Se enviado XML CTe protocolado no ambiente de homologação, no qual é indicado pela tag <tpAmb>2<tpAmb>, o protocolo de AT&M será TESTE.

OBS: Esta averbação pode não ser considerada pela seguradora, por se tratar de
TESTE, causando danos ao segurado em casos de sinistros.

2.4 Exemplo output XML ou retorno da AT&M homologação:

<Response>
    <Numero></Numero>
    <Serie></Serie>
    <Filial></Filial>
    <CNPJCli></CNPJCli>
    <TpDoc>6</TpDoc>
    <InfAdic></InfAdic>
 <Averbado>
   <dhAverbacao></dhAverbacao>
   <Protocolo>TESTE</Protocolo>
	<DadosSeguro>
         <NumeroAverbacao></NumeroAverbacao>
         <CNPJSeguradora></CNPJSeguradora>
         <NomeSeguradora></NomeSeguradora>
         <NumApolice></NumApolice>
       	 <TpMov></TpMov>
         <TpDDR></TpDDR>
         <ValorAverbado></ValorAverbado>
         <RamoAverbado></RamoAverbado>
 	</DadosSeguro>
 </Averbado>
  
 <Infos>
 	<Info>
      <Codigo></Codigo>
 <Descricao></Descricao>
 	</Info>
 </Infos>
  
</Response>

2.5 Exemplo output ou retorno documento recusado, estrutura XML:

<Response>
     <Numero></Numero>
     <Serie></Serie>
     <Filial></Filial>
     <CNPJCli></CNPJCli>
     <TpDoc></TpDoc>
     <InfAdic></InfAdic>
 	 <Erros>
 		<Erro>
             <Codigo></Codigo>
             <Descricao></Descricao>
             <ValorEsperado></ValorEsperado>
             <ValorInformado></ValorInformado>
 		</Erro>
 </Erros>
</Response>

OBS: Em casos de ocorrer mais de uma recusa por XML, a tag se repetirá e informará as demais descrições de recusa.

2.6 O output ou retorno de documento recusado por “Documento já cadastrado” se diferencia do exemplo acima.

Nele constará o protocolo e número da averbação, como também o dia e hora da averbação. A mensagem de “Documento já cadastrado” será mostrada na tag “Info”.

<Response>
     <Numero></Numero>
     <Serie></Serie>
     <Filial></Filial>
     <CNPJCli></CNPJCli>
     <TpDoc></TpDoc>
     <InfAdic></InfAdic>
     <Averbado>
           <dhAverbacao></dhAverbacao>
           <Protocolo></Protocolo>
           <DadosSeguro>
                 <NumeroAverbacao></NumeroAverbacao>
                 <CNPJSeguradora></CNPJSeguradora>
                 <NomeSeguradora></NomeSeguradora>
                 <NumApolice></NumApolice>
                 <TpMov></TpMov>
                 <TpDDR></TpDDR>
                 <ValorAverbado></ValorAverbado>
                 <RamoAverbado></RamoAverbado>
 		   </DadosSeguro>
 	   </Averbado>
 	   <Infos>
 			<Info>
                 <Codigo>001</Codigo>
                 <Descricao>Documento já Cadastrado</Descricao>
			</Info>
 	   </Infos>
</Response>