# 2. Averbando CTe AT&M

<table border="1" id="bkmrk-%C2%A0-projeto%2Fsistema%3Age" style="border-collapse: collapse; width: 100.123%; height: 68px;"><tbody><tr style="border-style: solid;"><td rowspan="3" style="width: 26.6667%; height: 68px; border-color: black; border-top-style: hidden; border-left-style: hidden; border-bottom-style: hidden;">  
 ![Softensistemas Logo](https://www.softensistemas.com.br/assets/img/logo.webp)

</td><td style="width: 49.9999%; height: 10px; border-color: black; border-style: solid;"><span style="color: #000000;">**Projeto/Sistema:**</span>  
Serviço AT&amp;M Averbação</td><td class="align-center" style="width: 23.3333%; height: 10px; border-color: black; border-style: solid;"><span style="color: #000000;">**Versão do *Template:***</span>  
<span style="color: #000000;">1.1</span></td></tr><tr style="border-style: solid;"><td style="width: 49.9999%; height: 29px; border-color: black; border-style: solid;"><span style="color: #000000;">**Processo:**</span>  
<span style="color: #000000;">Averbação CTe AT&amp;M</span></td><td class="align-center" style="width: 23.3333%; height: 29px; border-color: black; border-style: solid;"><span style="color: #000000;">**Versão do Documento:**</span>  
<span style="color: #000000;">1.2</span></td></tr><tr style="border-style: solid;"><td style="width: 49.9999%; height: 29px; border-color: black; border-style: solid;"><span style="color: #000000;">**Responsável(eis):** </span>  
<span style="color: #000000;">Gustavo Fernandes</span></td><td class="align-center" style="width: 23.3333%; height: 29px; border-color: black; border-style: solid;"><span style="color: #000000;">**Data:** </span>

<span style="color: #000000;">02/10/2024</span>

</td></tr></tbody></table>

##### <span style="color: #000000;">**1. Introdução**</span>

<span style="color: #000000;">**Este processo visa exemplificar a averbação CTe pelo serviço AT&amp;M no GA**</span>

##### <span style="color: #000000;">**2. Processo averbação CTe - validações**</span>

[![image-1727956070126.png](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/scaled-1680-/image-1727956070126.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/image-1727956070126.png)

I - Fluxograma Exemplo

<table cellpadding="9" cellspacing="0" id="bkmrk-processo-envolvidos-" style="width: 100%; height: 341px;" width="100%"><tbody><tr style="height: 35px;" valign="top"><td bgcolor="#acb9ca" style="border-style: solid; border-color: black; width: 27%; height: 35px;" width="27%"><span style="font-size: small; color: #000000;">**Processo**</span>

</td><td bgcolor="#acb9ca" style="border-style: solid; border-color: black; width: 19%; height: 35px;" width="19%"><span style="font-size: small; color: #000000;">**Envolvidos**</span>

</td><td bgcolor="#acb9ca" style="border-style: solid; border-color: black; width: 37.2469%; height: 35px;" width="27%"><span style="font-size: small; color: #000000;">**Dados de entrada**</span>

</td><td bgcolor="#acb9ca" style="border-style: solid; border-color: black; width: 28.4815%; height: 35px;" width="27%"><span style="font-size: small; color: #000000;">**Dados de Saída**</span>

</td></tr><tr style="height: 236px;" valign="top"><td style="border-style: solid; border-color: black; width: 27%; height: 236px;" width="27%"><span style="font-size: small; color: #000000;">Consumo webservice</span>

</td><td style="border-style: solid; border-color: black; width: 19%; height: 236px;" width="19%"><span style="font-size: small; color: #000000;">Sistema e WebService</span>

</td><td style="border-style: solid; border-color: black; width: 37.2469%; height: 236px;" width="27%">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.

</td><td style="border-style: solid; border-color: black; width: 28.4815%; height: 236px;" width="27%">Retorna JSON para verificação pelo WebService</td></tr><tr style="height: 35px;"><td style="border-style: solid; border-color: black; width: 27%; height: 35px;"><span style="font-size: small; color: #000000;">Token inválido/expirado</span>

</td><td style="border-style: solid; border-color: black; width: 19%; height: 35px;"><span style="font-size: small; color: #000000;">Sistema e WebService</span>

</td><td style="border-style: solid; border-color: black; width: 37.2469%; height: 35px;">Validando arquivo enviado

</td><td style="border-style: solid; border-color: black; width: 28.4815%; height: 35px;">Retorna mensagem de erro</td></tr><tr style="height: 35px;"><td style="border-style: solid; border-color: black; width: 27%; height: 35px;"><span style="font-size: small; color: #000000;">Token válido</span>

</td><td style="border-style: solid; border-color: black; width: 19%; height: 35px;"><span style="font-size: small; color: #000000;">Sistema e WebService</span>

</td><td style="border-style: solid; border-color: black; width: 37.2469%; height: 35px;">Validando arquivo enviado

</td><td style="border-style: solid; border-color: black; width: 28.4815%; height: 35px;">Envia XML para webservice</td></tr><tr><td style="border-style: solid; border-color: black; width: 27%;"><span style="font-size: small; color: #000000;">JSON/XML com erros</span>

</td><td style="border-style: solid; border-color: black; width: 19%;"><span style="font-size: small; color: #000000;">Sistema e WebService</span>

</td><td style="border-style: solid; border-color: black; width: 37.2469%;">Verifica retorno JSON/XXML do WebService

</td><td style="border-style: solid; border-color: black; width: 28.4815%;">Retorno dos erros em JSON/XML com códigos de erro</td></tr><tr><td style="border-style: solid; border-color: black; width: 27%;"><span style="font-size: small; color: #000000;">JSON/XML aprovado</span>

</td><td style="border-style: solid; border-color: black; width: 19%;"><span style="font-size: small; color: #000000;">Sistema e WebService</span>

</td><td style="border-style: solid; border-color: black; width: 37.2469%;">Verifica retorno JSON/XML do WebService

</td><td style="border-style: solid; border-color: black; width: 28.4815%;">Averba Cte, retorna mensagem autorizado</td></tr></tbody></table>

#### **Processos Relacionados** 

- - - - - -

[Comunicação GA (Login) AT&amp;m](https://docs.softensistemas.com.br/books/atm-averbador-ga/page/1-comunicacao-ga-login-atm "Comunicação GA (Login) AT&m")

#### **Especificação Funcional**

- - - - - -

#### **PROC002 VALIDANDO AVERBAÇÃO AT&amp;M:**

##### ***Protótipo de Tela:***

[![image-1728570977202.png](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/scaled-1680-/image-1728570977202.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/image-1728570977202.png)

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&amp;m](https://docs.softensistemas.com.br/books/atm-averbador-ga/page/1-comunicacao-ga-login-atm "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\\ ](https://webserver.averba.com.br/rest/CTe%5C)

-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 ' '&lt;cteProc versao="3.00" xmlns="http://www.portalfiscal.infr.br/cte"&gt;

**ESTRUTURA DO XML**

&lt;/cteProc&gt;'

**2.** Exemplo de output ou retorno em JSON:

```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:

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

**2.2** Exemplo de retorno output ou retorno em XML:

```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 &lt;tpAmb&gt;2&lt;tpAmb&gt;, o protocolo de AT&amp;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&amp;M homologação:

```XML
<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:

```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”.

```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>001</Codigo>
                 <Descricao>Documento já Cadastrado</Descricao>
			</Info>
 	   </Infos>
</Response>
```

##### ***Questões Técnicas:***

**1.** Estrutura do arquivo retorno XML:

[![image-1727968359523.png](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/scaled-1680-/image-1727968359523.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/image-1727968359523.png)

[![image-1727968399292.png](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/scaled-1680-/image-1727968399292.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/image-1727968399292.png)

[![image-1727968444874.png](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/scaled-1680-/image-1727968444874.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/image-1727968444874.png)

[![image-1727968477329.png](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/scaled-1680-/image-1727968477329.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/image-1727968477329.png)

**2.** Estrutura do arquivo retorno homologação para testes XML:

[![image-1727969218214.png](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/scaled-1680-/image-1727969218214.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/image-1727969218214.png)

[![image-1727968749517.png](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/scaled-1680-/image-1727968749517.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/image-1727968749517.png)

[![image-1727968768696.png](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/scaled-1680-/image-1727968768696.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/image-1727968768696.png)

**2.** Estrutura do arquivo recusado XML:

[![image-1727968826262.png](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/scaled-1680-/image-1727968826262.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/image-1727968826262.png)

[![image-1727968845774.png](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/scaled-1680-/image-1727968845774.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/image-1727968845774.png)

[![image-1727968867643.png](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/scaled-1680-/image-1727968867643.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2024-10/image-1727968867643.png)

©SOFTEN SISTEMAS 2024