AverbaCTe
Averbação Eletrônica Nacional
AT&M
Versão 1.2
AT&M AverbaCTe – Software de averbação por CTe
Controle de Versão
Versão Controle
Data
Razões para alteração
Responsável
1
0
22/06/2012 Criação do Documento
Lucas
1
1
14/08/2012 Ajustes no texto
Flademir
1
2
20/10/2012 Ajustes no texto
Vagner
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 2 de 27
AT&M AverbaCTe – Software de averbação por CTe
Índice
1.
Introdução ..............................................................................................................5
1.1.
2.
Objetivo do Documento e Escopo ...............................................................................5
Estrutura da solução..............................................................................................5
2.1.
WWW.AVERBA.COM.BR ...........................................................................................6
3.
Responsabilidades do Seguro ..............................................................................6
4.
Solução AT&M para averbação de CTe ................................................................7
5.
Utilizando o AverbaCTe .........................................................................................8
5.1.
5.2.
5.3.
5.4.
5.5.
5.6.
5.7.
5.8.
6.
Consultando as Averbações ...............................................................................15
6.1.
6.2.
6.3.
6.4.
7.
Instalação...................................................................................................................8
Configuração ..............................................................................................................8
Estrutura.....................................................................................................................9
Operação ...................................................................................................................9
Alertas por Email ...................................................................................................... 10
Removendo Email .................................................................................................... 12
Alterando o Intervalo de Excução.............................................................................. 13
Averbando Manualmente.......................................................................................... 13
Execuções................................................................................................................ 15
Consultando CTe averbados. ................................................................................... 16
Consultando CTe com erro. ...................................................................................... 17
Principais erros e ações............................................................................................ 20
Automatizar Processos com AverbaCte.............................................................21
7.1.
7.2.
7.3.
7.4.
Como Automatizar .................................................................................................... 21
Automação do envio de CTe para Averbar................................................................21
Automação da Resposta........................................................................................... 22
Tabela de Códigos de Erro ....................................................................................... 26
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 3 de 27
AT&M AverbaCTe – Software de averbação por CTe
Envolvidos de TI na elaboração do Documento de Visão
Nome
Vagner Toledo
Sandra Mara Paiva
Lucas Aguiar
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 4 de 27
AT&M AverbaCTe – Software de averbação por CTe
1. Introdução
1.1. Objetivo do Documento e Escopo
Apresentar o software AT&M AverbaCte para averbação eletrônica de seguros de
transportes utilizando o CTe.
Se sua área de informática desejar fazer uma integração completa entre seu sistema emissor de CTe e os
processos de averbação, a AT&M disponibiliza um conjunto de WebServices que provêem agilidade,
segurança, protocolo e controle total sobre os documentos averbados. Contate a AT&M.
2. Estrutura da solução
A solução de averbação eletrônica da AT&M se baseia na estrutura de EDI,
homologada na grande maioria das seguradoras e é líder no mercado segurador com
mais de 16 anos de experiência e comprovada eficiência e segurança.
O AverbaCTe foi desenvolvido para agilizar e simplificar o uso da estrutura de serviços
na Web, WebService, construída pela AT&M, que proporcionam a integração completa
entre o sistema da transportadora e o sistema de averbação AT&M. Fazendo com que o
processo de averbação seja automatizado, on-line, ágil, seguro, sem intervenção
humana e sob total controle do cliente.
O AverbaCte foi projetado para ser utilizado de várias formas, por exemplo:
1- Transportadora, cuja área de informática, deseje integrar seus sistemas utilizando
diretamente o webservice, mas, não tem como fazê-lo no curto prazo ou não tem
previsão. Neste caso utiliza-se o AverbaCTe enquanto o processo é desenvolvido.
2- Transportadora, cuja área de informática vai automatizar os processos, mas, se
utilizará do AverbaCte como o módulo de comunicação entre seus sistemas e a
AT&M.
Independente do caso, utilizando o AverbaCte, o segurado começa a averbar os
conhecimentos eletrônicos já. De uma forma simples, rápida e segura, e pode, caso
deseje, ir aumentando o nível de integração com seus sistemas de forma gradual,
controlada e sob demanda.
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 5 de 27
AT&M AverbaCTe – Software de averbação por CTe
2.1. WWW.AVERBA.COM.BR
A AT&M disponibiliza na web uma interface moderna e intuitiva com muitos recursos
para o cliente gerenciar os conhecimentos averbados pelo AverbaCte. Segue os
principais recursos :
•
Visual moderno e arrojado;
•
Nome e telefone do corretor na página inicial;
•
Compatibilidade com os demais browsers além do Internet Explorer, tais como:
Mozilla, FireFox, Google Chrome, Ophera e outros;
•
Averbação OnLine por meio de outros sistemas operacionais: Linux,
Tablet(Android), Ipod e todos que executarem os borwsers listados acima;
•
Possibilita a digitação do conhecimento;
•
Localização de documentos ágil e rápida por: número, série, filial, data de
embarque ou data de emissão;
•
Vários relatórios com exportação para PDF e Excel;
•
Relatórios Analíticos: Geral, Origem/Destino, Urbano, Série, Filial e Motorista;
•
Relatórios Resumos: Urbano/Origem/Destino, Data de Embarque e Filial;
•
Relatório com todos os dados em Excel;
•
Gráficos Estatísticos podendo ser exportados para PDF, PNG, JPEG e SVG;
•
Gráficos: Valor Transportado por Origem/Destino, Transportes realizados por
Origem/Destino, Valor por Veículo, Transportes por Veículo, Valor averbado por
Filial e Documentos Averbados por Filial;
•
Criação e Deleção de novos usuários pelo segurado.
Entre em contato com a AT&M para obter seu login para o site: www.averba.com.br .
3. Responsabilidades do Seguro
A averbação dos documentos antes do embarque é um importante processo para a
cobertura em caso de sinistro. Todos os CTe’s emitidos pelo segurado no período de
vigência da apólice devem ser averbados (comunicados) para a seguradora.
A partir do momento que o segurado averba os documentos de transportes, está
garantindo a cobertura pelo seguro em caso de sinistro, conforme as cláusulas
constantes em sua apólice.
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 6 de 27
AT&M AverbaCTe – Software de averbação por CTe
Deve-se atentar aos limites de cobertura por viagem, também chamada de
concentração de risco, que poderá ocasionar a não cobertura em caso de acidente,
roubo, furto ou demais ocorrências definidas na sua apólice de seguro. É de
responsabilidade do segurado, controlar estes limites por viagem ao “montar” a carga
que será transportada num mesmo veículo.
Consulte sempre o seu corretor de seguros em caso de dúvidas referentes às coberturas e limites
existentes no seu seguro contratado.
4. Solução AT&M para averbação de CTe
A solução de averbação eletrônica de documentos eletrônicos da AT&M, foi criado
baseado na experiência da AT&M em prover solução para as Seguradoras e Corretores
na averbação de transportes nacional, sendo pioneiro na aplicação de EDI para o setor
e líder de mercado. Trazendo solução, segurança, praticidade e transparência no
relacionamento entre Seguradora, corretor e segurado.
Vislumbrando todo o problema e responsabilidades expostos no capítulo 3 (vide capitulo
3), a AT&M criou um processo totalmente automatizado e seguro para que os
documentos eletrônicos sejam averbados de forma rápida e tranqüila.
Para tanto foi desenvolvido uma solução baseada em WebService onde o sistema da
transportadora, após, gerar o CTe e registrar na secretaria da fazenda do seu estado,
averba o mesmo no servidor AT&M.
Todo o processo é seguro e controlado por XML de retorno informando o protocolo de
averbação do CTe ou o motivo da recusa. Tudo online e em tempo real.
De posse do XML de retorno o sistema da transportadora dá “baixa” no CTe averbado,
gerando controles que podem ser consultados ou gerados relatórios no próprio sistema
da transportadora.
A transportadora também poderá realizar consultas, relatórios, estatísticas, gráficos,
convertendo em excell ou pdf de todos os documentos averbados diretamente no site
de averbação eletrônica da AT&M: www.averba.com.br .
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 7 de 27
AT&M AverbaCTe – Software de averbação por CTe
5. Utilizando o AverbaCTe
5.1. Instalação
Após ter em mãos o executável de instalação do sistema, baixado de nosso site ou
enviado por e-mail pelo suporte técnico da AT&M, basta seguir os passos:
1. Crie uma pasta nova onde será instalado o sistema. Exemplo: C:/AT&M/AVERBA;
2. Execute o arquivo do sistema: AverbaDOCe.exe;
3. Após executar o sistema na pasta configurada sua instalação estará concluída.
5.2. Configuração
Para utilizar o sistema deve-se configurá-lo com os dados de acesso do cliente
fornecidos pela AT&M. Execute o AverbaDOCe.exe, na primeira execução do sistema
aparecerá a seguinte tela:
Preencher as informações com os dados de login informados pela AT&M:
Usuário e senha: login fornecido pela AT&M.
Caixa Postal: código de 8 dígitos, caixa postal fornecida pela AT&M.
CNPJ: CNPJ do segurado.
Intervalo: Informar, em minutos, o intervalo em que o AverbaCTe vai se conectar ao
servidor AT&M e averbar os CTe’s.
Em seguida clicar em gravar.
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 8 de 27
AT&M AverbaCTe – Software de averbação por CTe
Também é possível acessar a tela de configuração dos dados do cliente acessando a
opção de menu: Sistema – Dados do Cliente.
ATENÇÃO:
•
Só faça alterações nestes dados caso seja orientado pelo suporte técnico
da AT&M. A alteração indevida destas informações de cadastro do cliente
na AT&M, fará com que o sistema não mais consiga fazer as averbações.
•
Estes dados de login
www.averba.com.br.
são
os
mesmos
de
acesso
ao
site:
5.3. Estrutura
O AverbaCTe baseia seu funcionamento em estrutura de pastas. Os CTe’s que vão ser
averbados, o retorno dos CTe’s aceitos e os recusados estão distribuídos em pastas
específicas do sistema. São elas:
Averbar: Copiar para esta pasta o XML protocolado no SeFaz do CTe que será
averbado.
XMLAv: O protocolo gerado pela averbação do CTe é gravado nesta pasta.
XMLErro: Caso ocorra recusa na averbação do CTe, o retorno do erro é gravado nesta
pasta.
5.4. Operação
Com o sistema instalado e configurado deve-se ativar o AverbaCTe. Para isto execute o
arquivo: AverbaDOCe.exe. Ao abrir a tela principal do sistema basta escolher a opção
“sistema” do menu e em seguida a opção “minimizar no tray”.
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 9 de 27
AT&M AverbaCTe – Software de averbação por CTe
Desta forma o AverbaCTe ficará “ativado” na barra de tarefas do Windows e a cada X
minutos (vide capítulo 5.2) averbará os CTe’s existentes na pasta Averbar.
Sistema ativado e na barra de tarefas do Windows.
Com o sistema ativado, basta ir gravando os CTe’s que vão sendo emitidos, e aceitos
no SeFaz, na pasta Averbar que automaticamente serão averbados. Veja como receber
alerta por e-mail no capítulo: Alertas por e-mail.
Veja o capítulo Automação para saber como agilizar o seu dia a dia.
5.5. Alertas por Email
Quando ocorre um erro na averbação de um conhecimento seja este erro ocasionado
pelo sistema, rede, internet ou parâmetros da apólice de seguro é muito importante que
você seja avisado o mais rápido possível, para tomar as ações necessárias para que
ocorra a averbação.
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 10 de 27
AT&M AverbaCTe – Software de averbação por CTe
Pensando nesta necessidade o AverbaCte tem um cadastro de e-mails que serão
acionados quando ocorrer algum destes erros.
Proceda da seguinte forma para realizar o cadastro:
Acesse o menu principal do sistema, se estiver minimizado na barra de tarefas do
Windows basta um “click” com o mouse para acessar.
Escolha a opção: “Sistema” e “Alerta por E-mail”, e você terá esta tela de cadastro:
Agora é só digitar um e-mail e clicar em Adicionar. O e-mail cadastrado passa para a
janela abaixo de e-mails cadastrados:
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 11 de 27
AT&M AverbaCTe – Software de averbação por CTe
5.6. Removendo Email
Para remover um e-mail cadastrado, proceda da seguinte forma:
Acesse o menu principal do sistema, se estiver minimizado na barra de tarefas do
Windows basta um “click” com o mouse para acessar.
Escolha a opção: “Sistema” e “Alerta por E-mail”, e você terá esta tela de cadastro:
Dê um “click” com o mouse sobre o e-mail que deseja remover da lista de e-mails
cadastrados. O mesmo aparecerá no campo: Endereço de e-mail .
Agora, click no botão Remover e o mesmo será removido.
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 12 de 27
AT&M AverbaCTe – Software de averbação por CTe
5.7. Alterando o Intervalo de Excução
A cada X minutos o sistema lê os CTe’s da pasta Averbar e conecta-se ao servidor
AT&M e averba o conhecimento. Este ciclo é controlado pelo intervalo de execução
cadastrado no AverbaCte. Para alterar este intervalo ou consultar o intervalo cadastrado
acesse a tela principal do sistema e entre na opção de menu: “Averba” e
”Automatizado”.
Em seguida a seguinte tela será apresentada:
Para alterar o intervalo e Execução basta digitar o novo valor em minutos.
ATENÇÃO: Não é aconselhável intervalos muito grandes, 15 ou 20 minutos, pois,
acarretará um tempo excessivo entre a gravação do CTe na pasta Averbar e a sua
efetiva averbação. Sugerimos intervalos abaixo dos 5 minutos.
5.8. Averbando Manualmente
É um recurso adicional que na prática deve ser utilizado em casos isolados. Proporciona
a possibilidade de averbar um CTe que não esteja na pasta Averbar e que o cliente não
consiga copiar para pasta de averbação do sistema AverbaCte.
Para acessar este recurso acionar a opção de menu: “Averbação” e “Averbar
Manualmente”.
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 13 de 27
AT&M AverbaCTe – Software de averbação por CTe
A tela a seguira será apresentada:
Escolha o CTe que quer averbar com um duplo “click”, imediatamente será averbado.
Ocorrendo qualquer erro uma mensagem do sistema será exibida.
ATENÇÃO: O XMLs será apagado após ser averbado com sucesso. Caso não tenha
uma cópia do XML não averbar pelo método manual, copiar para pasta AVERBAR.
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 14 de 27
AT&M AverbaCTe – Software de averbação por CTe
6. Consultando as Averbações
6.1. Execuções
Cada vez que o sistema encontra CTe na pasta Averbar registra a data e hora de
execução, assim como, quantos CTe’s haviam e quantos foram averbado e quantos
foram recusados.
É um controle rápido e objetivo, onde, se pode visualizar os conhecimentos não
averbados e o motivo.
Para consultar as execuções realizadas e os resultados, acesse a opção do menu:
“Averbação” e “Execuções” .
A seguinte tela será apresentada.
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 15 de 27
AT&M AverbaCTe – Software de averbação por CTe
Cada linha apresenta a data e hora da execução, o total de documentos na pasta
Averba no momento da execução, quantidade de documentos averbados e a
quantidade de documentos com erro.
6.2. Consultando CTe averbados.
A consulta dos documentos averbados divide-se em duas interfaces:
1. Local
2. Web
1. Consulta local
O AverbaCte disponibiliza apenas uma consulta rápida com a informação dos
conhecimentos averbados: número, série, filial, protocolo, data e hora da averbação.
Para acessar esta consulta basta dar um duplo “click” na coluna “Docs Averbados” na
linha que desejar consultar:
Apresentará a tela a seguir:
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 16 de 27
AT&M AverbaCTe – Software de averbação por CTe
2. Consulta Web
Um conjunto de recursos de consultas e relatórios dos documentos averbados estão
disponíveis na web no link www.averba.com.br . Utilize as informações existentes na
configuração do AverbaCte para acessar sua conta na web. (vide 5.2 Configuração)
Relatórios em PDF e Excel, Gráficos estatísticos dos transportes são alguns dos
recursos disponibilizados.
Qualquer dúvida na utilização do site contatar nosso suporte técnico: (19) 3885-2000.
6.3. Consultando CTe com erro.
CTe’s com erro são conhecimentos que por motivo de sistema, rede, dados de acesso
do cliente incorretos, vigência ou parâmetros de limites as apólice não foram averbados.
Erros como: link de internet inativo, rede, erro de login ou acesso fazem com que numa
próxima execução seja feita uma nova tentativa de averbar os CTe’s existentes na pasta
Averbar .
Os demais erros, removem o CTe da pasta averba obrigando que sejam novamente
gravados na pasta averba.
Para acessar a consulta de CTe com erro proceda da seguinte forma: Acesse o menu
principal a opção: “Averbação” e “Execuções”:
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 17 de 27
AT&M AverbaCTe – Software de averbação por CTe
A seguinte tela será apresentada.
Cada linha apresenta a data e hora da execução, o total de documentos na pasta
Averbar no momento da execução, quantidade de documentos averbados e a
quantidade de documentos com erro.
Para acessar esta consulta basta dar um duplo “click” na coluna “Docs com Erro” na
linha que desejar consultar:
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 18 de 27
AT&M AverbaCTe – Software de averbação por CTe
E a tela a seguir será apresentada: com os dados do documento recusado: número,
série, filial e descrição do erro.
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 19 de 27
AT&M AverbaCTe – Software de averbação por CTe
6.4. Principais erros e ações
A seguir listamos os erros mais comuns e suas possíveis soluções:
Código
Descrição
Ação sugerida
001
Documento já cadastrado
Verifique o número, série e CNPJ emissor do
CTe. Consulte na web o documento já
cadastrado. (www.averba.com.br)
004
Valor da IS maior que o limite permitido
Valor do CTe excede o limite contratado.
Contate seu corretor de seguros.
027
Apólice não localizada ou vencida para o
ramo: 99
Apólice não localizada. Contate seu corretor de
seguros, e informe o ramo apresentado no erro.
033
CNPJ Emissor do
autorizado a averbar.
CNPJ emissor do CTe difere do cadastrado
pela seguradora/corretor na AT&M. Contate seu
corretor de seguros.
900
Usuário do Webserver não informado
Verifique as informações de configuração,
cap.5.2, em caso de dúvida contate a AT&M.
901
Senha do Webserver não informado
Verifique as informações de configuração,
cap.5.2, em caso de dúvida contate a AT&M.
902
CodATM do Webserver não encontrado
Verifique as informações de configuração,
cap.5.2, em caso de dúvida contate a AT&M.
903
Acesso do Webserver não autorizado
Verifique as informações de configuração,
cap.5.2, em caso de dúvida contate a AT&M.
908
CTe não localizado na base de dados
Você tentou cancelar um CTe que não está
averbado. Proceda a averbação do mesmo e
depois informe o cancelamento.
912
XML inválido
webserver
para
documento
utilização
não
neste
Erro no formato do XML ou não é um XML
válido ou protocolado no Sefaz.
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 20 de 27
AT&M AverbaCTe – Software de averbação por CTe
7. Automatizar Processos com AverbaCte
7.1. Como Automatizar
Nos capítulos anteriores foi explicado como o sistema funciona, neste, estaremos
mostrando dicas e formas de automatizar os processos por meio do AverbaCte.
Está automação se dá por meio do desenvolvimento de rotinas no sistema do cliente
que integra a geração do CTe para averbar e a leitura do retorno de sucesso ou erro na
averbação. Desta forma criando uma interface no sistema do cliente onde o usuário
controlará todo o processo sem ser necessário manusear o AverbaCte.
Você pode utilizar o AverbaCte para realizar vários níveis de automação, desde a
gravação do CTe na pasta Averbar diretamente do seu sistema até a leitura dos
protocolos retornados pela AT&M dando baixa nos CTe’s já averbados no seu banco de
dados.
7.2. Automação do envio de CTe para Averbar
Como alternativa à gravação manual de CTe’s na pasta Averbar, podemos sugerir:
1. No sistema da transportadora criar uma rotina que localiza todos os CTe’s já
protocolados no SeFaz e que não foram averbados e grava o XML na pasta Averbar.
Esta rotina pode ser executada por um timer ou pela ação do usuário clicando num
botão.
Sugestão:
a) Crie um parâmetro no seu sistema onde estará gravado o local da pasta de
instalação do AverbaCte, exemplo: C:/AT&M/AverbaCte. Sabendo onde está
instalado o sistema é fácil localizar as pastas
b) Crie um parâmetro com a data inicio da averbação, este parâmetro é importante para
que apenas os CTe’s com data superior sejam selecionados para averbar. Caso este
parâmetro não exista corre-se o risco de selecionar CTe’s de meses passados e
gerar uma quantidade enorme de CTe na pasta Averba.
2. A mesma rotina que submete o CTe no SeFaz para obter a autorização de uso, em
caso de sucesso, grava o XML protocolado na pasta Averbar . Desta forma todo o
CTe logo após o registro no Sefaz já é averbado.
Sugestão:
a) Além das sugestões anteriores, deve-se prever um forma do usuário realizar uma
nova tentativa de averbação do CTe, caso ocorra erro e o sistema não esteja com a
automação de repostas implementados. (vide cap. Automação da Resposta)
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 21 de 27
AT&M AverbaCTe – Software de averbação por CTe
7.3. Automação da Resposta
Estando a automação do envio implementado, pode-se fazer a automação dos XML de
retorno, fazendo com que seja dada a baixa automática no banco de dados do cliente
ou registrar o erro e solicitar a ação por parte do usuário.
Integrando a Baixa do CTe Averbado
Todos os CTe averbados, ou seja, aceitos pelo processo de averbação segundo os
parâmetros contratados no seguro, estão na pasta: XMLAv .
Mesmo os XMLs de cancelamentos obedecem aos mesmos processos descritos neste
documento.
Por meio da manipulação dos arquivos existentes nesta pasta podem-se obter as
seguintes informações:
- Número do CTe
- Série
- Filial
- Protocolo
- Data/Hora do protocolo
O sistema do cliente “lendo” estas informações pode dar baixa no CTe como averbado.
Tem duas formas do sistema do cliente “ler” estes dados:
1-Pelo nome do arquivo
O nome do arquivo é formatado de maneira a ser possível localizar estas informações.
O layout do nome do arquivo é o seguinte:
Informação
Tamanho
Exemplo
Número do Cte
10
0000007458
Serie
5
00001
Filial
5
00000
Protocolo
40
91082MNJGGG1111K1GIN000000000000
Data
8
YYYYMMDD
Hora
4
HHMM
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 22 de 27
AT&M AverbaCTe – Software de averbação por CTe
IMPORTANTE: Foi utilizado zeros para completar o tamanho dos campos no nome, desta forma:
- No caso do protocolo deve ser desconsiderados os zeros a direita, no nosso exemplo o protocolo é:
91082MNJGGG1111K1GIN e não deve ser utilizado: 91082MNJGGG1111K1GIN000000000000 ;
- Na informação do Número/Serie desprezar os zeros a esquerda.
Após ler e registrar a baixa no banco de dados, o arquivo deve ser apagado para que
não seja lido sempre que o processo for executado.
2-Pelo conteúdo do arquivo
O conteúdo do arquivo é o XML de retorno do servidor AT&M que tem o seguinte layout:
XML de Retorno CTe Averbado:
<?xml version="1.0" encoding="iso-8859-1"?>
<MSGS>
<AVERBADO>
<NUMDOC></NUMDOC>
<SERIEDOC></SERIEDOC>
<FILIALDOC></FILIALDOC>
<LINHAARQ></LINHAARQ>
<PROTOCOLO>
<DATA></DATA>
<HORA></HORA>
<PROTOCOLONUMERO></PROTOCOLONUMERO>
</ PROTOCOLO >
</ AVERBADO >
</ MSGS >
Campo
Descrição
Tipo
NumDoc
Número do Documento
String (9)
SerieDoc
Serie do documento
String (5)
FilialDoc
Filial de emissão do documento
String (5)
LinhaArq
Não utilizado para CTe
String(3)
Protocolo
Nó do XML
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 23 de 27
AT&M AverbaCTe – Software de averbação por CTe
Data
Data de Averbação do documento
Date (DD-MM-YYYY)
Hora
Hora da Averbação do Documento
Hora (HH:MM:SS)
Após ler o conteúdo do arquivo e registrar a baixa no banco de dados, o arquivo deve
ser apagado para que não seja lido sempre que o processo for executado.
Integrando o Retorno de Erro
Conforme exposto no capítulo Consultando CTe com erro, o AverbaCte retorna o erro
que houve ao tentar averbar o conhecimento. Para registrar no banco de dados do
cliente os erros retornados deve-se desenvolver rotina que obtenha as informações de
erro para cada CTe.
Todos os CTe recusados, ou seja, não averbados pelo processo de averbação segundo
os parâmetros contratados no seguro, estão na pasta: XMLEr .
Por meio da manipulação dos arquivos existentes nesta pasta podem-se obter as
seguintes informações:
- Número do CTe
- Série
- Filial
- Código do Erro
- Data/Hora
O sistema do cliente “lendo” estas informações pode registrar no banco o erro informado
pelo processo de averbação e solicitar ação do usuário.
Tem duas formas do sistema do cliente “ler” estes dados:
1-Pelo nome do arquivo
O nome do arquivo é formatado de maneira a ser possível localizar estas informações.
O layout do nome do arquivo é o seguinte:
Informação
Tamanho
Exemplo
Número do Cte
10
0000007458
Serie
5
00001
Filial
5
00000
Código do erro
4
0010
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 24 de 27
AT&M AverbaCTe – Software de averbação por CTe
Data
8
YYYYMMDD
Hora
4
HHMM
IMPORTANTE: Foi utilizado zeros para completar o tamanho dos campos no nome, desta forma:
- Na informação do Número/Serie/Código desprezar os zeros a esquerda.
- Nestes arquivos ficam registrados apenas o código de erro, para obter a descrição do erro relativo ao
código recebido veja o capítulo: Tabela de códigos de Erros deste documento.
Após ler e registrar o erro no banco de dados, o arquivo deve ser apagado para que não
seja lido sempre que o processo for executado.
2-Pelo conteúdo do arquivo
O conteúdo do arquivo é o XML de retorno do servidor AT&M que tem o seguinte layout:
<?xml version="1.0" encoding="iso-8859-1"?>
<MSGS>
<ERRO>
<NUMDOC>7788</NUMDOC>
<SERIEDOC>1</SERIEDOC>
<FILIALDOC></FILIALDOC>
<LINHAARQ>NF</LINHAARQ>
<ERRODETALHE>
<CODIGO></CODIGO>
<VALORENVIADO></VALORENVIADO>
<VALORESPERADO></VALORESPERADO>
<LIMITE></LIMITE>
<DESCCOMPLETA></DESCCOMPLETA>
</ERRODETALHE>
<ERRODETALHE>
<CODIGO></CODIGO>
<VALORENVIADO></VALORENVIADO>
<VALORESPERADO></VALORESPERADO>
<LIMITE></LIMITE>
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 25 de 27
AT&M AverbaCTe – Software de averbação por CTe
<DESCCOMPLETA></DESCCOMPLETA>
</ERRODETALHE>
</ERRO>
</MSGS>
Campo
Descrição
Tipo
NumDoc
Número do Documento
String (9)
SerieDoc
Serie do documento
String (5)
FilialDoc
Filial de emissão do documento
String (5)
LinhaArq
Não utilizado para CTe
String (3)
ErroDetalhe
Nó do XML
Ocorre n vezes
Codigo
Código do erro (vide capítulo 5.3)
String(3)
ValorEnviado
Em determinados erros exibe o valor enviado
String(15)
ValorEsperado
Em determinados erros exibe o(s) valor(es) esperado(s)
String(50)
Limite
Em determinado erro apresenta o limite (R$) do seguro contratado
String(50)
DescCompleta
Descrição que complementa a descrição do código do erro
String(200)
Após ler e registrar o erro no banco de dados, o arquivo deve ser apagado para que não
seja lido sempre que o processo for executado.
7.4. Tabela de Códigos de Erro
Para receber a lista de códigos de erros a fim de criar uma referência entre o código e a
descrição tem disponibilizado duas formas:
Por url, pode-se fazer o download do arquivo XML no seguinte link :
http://webserver.averba.com.br/xmlErros.xml ou pelo uso de um WebService mostrado
na seqüência. Desta forma sempre que acionado gera um XML de retorno com a lista
de código de erro e descrição.
Como sugestão de automação, pode ser acionado sempre que um código de erro
recebido não for localizado na lista já recebida anteriormente e armazenada no sistema
do integrador.
WSDL: webserver.averba.com.br
Nome: listaErros
XML de Retorno:
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 26 de 27
AT&M AverbaCTe – Software de averbação por CTe
<?xml version="1.0" encoding="iso-8859-1"?>
<lista>
<erro>
<codigo>001</codigo>
<descricao>Documento já Cadastrado</descricao>
</erro>
<erro>
<codigo>002</codigo>
<descricao>Erro na inclusão do documento</descricao>
</erro>
</lista>
Campo
Descrição
Tipo
Erro
Nó do XML
Ocorre n vezes
Código
Código do erro
String (3)
Descrição
Descrição do erro
String (200)
AT&M – Processos automatizados de EDI – (19) 3885-2000 ou (11) 2283-2868 - Página 27 de 27