Manual Técnico de Integração - WebServicewebsaf.intersite.com.br/wiki/images/2/29/Layout_eFrete_V2.1.pdf · A IPC Administração Ltda. manterá este Manual atualizado, nos termos

I2011 - PC Administração Ltda.

______________________________________

Manual Técnico de Integração - WebService

Sistema e-FRETE - Gestão de pagamentos eletrônicos.

Revisada por: Rodrigo R. F. de Lima

Autores: Arthur Marcel de Souza

João Luiz Ferreira Júnior

______________________________________

ID: PRD-MWS:2013-01

VERSAO 2.1 24/04/2013

I2011 - PC Administração Ltda.

Garantias e obrigações contratuais

A IPC Administração Ltda. manterá este Manual atualizado, nos termos do Contrato de manutenção do produto Sistema e-FRETE – Gestão de pagamentos eletrônicos.

Termo de Confidencialidade

O leitor está ciente que este documento é confidencial, não podendo seu conteúdo, total ou parcial, ser copiado, transcrito ou replicado sem a formal permissão por escrito da IPC Administração LTDA.

IPC Administração Ltda.

Manual Técnico de Integração - WebService

Sumário

1. Introdução.............................................................................................................................................. 4

1.1. Descrição e pré-requisitos do público-alvo ...................................................................................... 4

1.2. Descrição do uso do documento...................................................................................................... 4

1.3. Envolvidos ....................................................................................................................................... 5

1.4. Abreviações, Conceitos e Termos Técnicos ...................................................................................... 5

1.5. Modelo Tecnológico ........................................................................................................................ 6

1.6. Lista de documentos relacionados................................................................................................... 6

1.7. Instruções para registro de problemas............................................................................................. 6

1.8. Versões do Manual .............................................................................................................................. 7

2. WebService ............................................................................................................................................ 7

2.1. Procedimento de Logon................................................................................................................... 7

2.1.1. Objetivo ................................................................................................................................ 7

2.1.2. Login ..................................................................................................................................... 7

2.1.3. Logout ................................................................................................................................... 8

2.1.4. Mensagens de erro................................................................................................................ 9

2.2. Procedimento de requisição a Motoristas........................................................................................ 9

2.2.1. Objetivo ................................................................................................................................ 9

2.2.2. Gravar motorista ..................................................................................................................10

2.2.3. Obter Motorista ...................................................................................................................12

2.2.4. Enviar Foto ...........................................................................................................................13

2.2.5. Buscar Foto ..........................................................................................................................14

2.3. Procedimento de requisição a Proprietário.....................................................................................15

2.3.1. Objetivo ...............................................................................................................................15

2.3.2. Gravar Proprietário...............................................................................................................15

2.3.3. Obter Proprietário ................................................................................................................17

IPC Administração Ltda.

2.4. Procedimento de requisição a Veículo ............................................................................................19

2.4.1. Objetivo ...............................................................................................................................19

2.4.2. Adicionar Veículo..................................................................................................................19

2.4.3. Obter Veículo ......................................................................................................................21

2.5. Procedimento de requisição a Frete ...............................................................................................23

2.5.1. Objetivo ...............................................................................................................................23

2.5.2. Adicionar Operação de Transporte .......................................................................................23

2.5.3. Obter Operação de Transporte .............................................................................................33

2.5.4. Obter Operação de Transporte para Impressão ....................................................................41

2.5.5. Adicionar Pagamento ...........................................................................................................42

2.5.6. Cancelar Pagamento.............................................................................................................44

2.5.7. Adicionar Viagem .................................................................................................................45

2.5.8. Abonar Quebra.....................................................................................................................49

2.5.9. Cancelar Operação de Transporte.........................................................................................51

2.5.10. Encerrar uma Operação de Transporte. ................................................................................52

2.5.11. Retificar uma Operação de Transporte. ................................................................................58

2.5.12. Obter Transações. ................................................................................................................60

3. Apêndices..............................................................................................................................................62

3.1. Legenda do Leiaute das Mensagens de Entrada e Retorno dos Serviços..........................................63

3.2. Abreviações Utilizadas no Cabeçalho dos Leiautes..........................................................................63

3.3. Tratamento de Caracteres Especiais no Texto de XML ....................................................................64

Manual Técnico de Integração WebService – Sistema e-FRETE

Empresa gestora IPC Administração LTDA.

Especificador: IPC - Desenvolvimento Versão 1.1

Cópia de uso exclusivo da: INTERSITE INFORMATICA LTDA - EPP – CNPJ: 02.104.333/0001-96

IPC Administração Ltda. - www.efrete.com

4

1. Introdução

O conjunto de manuais para o Sistema e-FRETE é composto do Manual da Transportadora, Manual do Credenciado e Manual do Proprietário. Este manual, diferente dos demais que são voltados para o usuário, tem como alvo os desenvolvedores que farão a integração dos sistemas das transportadoras via WebService com o Sistema e-FRETE.

Esclarece-se aos usuários deste manual que os conceitos e especificações aqui contidos poderão sofrer ajustes em virtude de mudança na legislação vigente aplicável às atividades desenvolvidas no âmbito do Sistema e-FRETE.

1.1. Descrição e pré-requisitos do público-alvo

O contratante que ainda não possua cadastro no Sistema e-FRETE deverá entrar em contato com o nosso departamento comercial para fazê-lo; procedimento idêntico se aplica para demais itens da integração (obtenção de setup, hash, etc.).

A integração é realizada em um ambiente de desenvolvimento/homologação, o qual possui todas as funcionalidades do ambiente de produção, porém os dados gerados não terão nenhuma validade e não poderão ser utilizados na geração de contratos de transporte de carga.

O público alvo deve ter conhecimento sobre WebService e seu funcionamento, entender o funcionamento de arquivos WSDL e demais componentes inerentes ao funcionamento de WebService.

O Sistema e-FRETE é um meio de pagamento eletrônico que, para ser acessado é necessária autorização prévia, cadastrada no sistema, e ter privilégio compatível, outorgado pelo responsável legal da empresa à qual está vinculado.

O Sistema e-FRETE permite que um usuário seja vinculado em mais de uma empresa, desde que tenha direitos concedidos em cada uma delas.

As operações de geração do CIOT sem ônus obedecerão às mesmas regras acima.

1.2. Descrição do uso do documento

Este manual deve ser consultado durante a integração do contratante ao utilizar o WebService do Sistema e-FRETE e/ou quando ocorrer qualquer dúvida.

São necessários para a utilização do WebService:

• Para ver o detalhamento WSDL dos serviços, adicionar ‘?WSDL’ ao final da url.

• Dispor de usuário e senha cadastrados e com perfil necessário para realizar a operação devidamente liberados no sistema.

• Conferir o formato das informações que devem ser enviadas através do WebService.






5

1.3. Envolvidos

Contratante: pessoa física ou jurídica responsável pelo pagamento do frete ao Transportador Autônomo de Cargas – TAC e aos seus equiparados, para prestação do serviço de transporte rodoviário de cargas.

Contratado: o TAC ou seu equiparado (ETC que possuir em sua frota até três veículos registrados no RNTRC e as CTC), que efetuar o transporte rodoviário de cargas por conta de terceiros e mediante remuneração;

Subcontratante: o TAC ou seu equiparado, que contratar outro TAC ou outro equiparado para realização do transporte de cargas para o qual fora anteriormente contratado;

Proprietário da carga: o remetente ou o destinatário da carga transportada que constar do CTRC ou documento que o substitua;

Administradora de meios de pagamento eletrônico de frete: a pessoa jurídica, com atuação em todo território nacional, responsável, por sua conta e risco, por meio de pagamento eletrônico de frete aprovado, habilitada pela ANTT.

1.4. Abreviações, Conceitos e Termos Técnicos

Para fins deste documento entende-se:

PEF – Pagamento Eletrônico de Frete instituído na Resolução ANTT Nº 3.658/2011;

CTRC – Conhecimento de Transporte Rodoviário de Cargas;

RNTRC – Registro Nacional de Transportadores Rodoviários de Cargas;

TAC – Transportador Autônomo de Cargas;

ETC – Empresa de Transporte Rodoviário de Cargas;

CTC – Cooperativa de Transporte Rodoviário de Cargas;

CIOT – Código Identificador da Operação de Transporte – código numérico obtido através do cadastramento no Sistema e-FRETE, de viagem decorrente de contrato de transporte;

Contrato de Transporte – acordo de transporte entre as partes, estabelecido por viagem, que finda na entrega da carga e pagamento do serviço;

Setup – Conjunto de comandos de configuração do Sistema e-FRETE;

Login – Processo de identificação do utilizador perante um computador, que permite que este o reconheça; entrada no Sistema e-FRETE;

LogOut – Desconexão do Sistema e-FRETE;

Hash – Sequência de letras/números geradas por um algoritmo de hashing que busca identificar um arquivo ou informação unicamente. Hashs podem ser usados para saber se os arquivos baixados através da Internet são idênticos aos distribuídos pelo desenvolvedor.

Token – Conjunto de caracteres utilizados como chave eletrônica.






6

WebService – solução utilizada na integração de sistemas e na comunicação entre diferentes aplicações, utilizando a linguagem universal XML para o tráfego de dados, proporcionando que sistemas desenvolvidos em plataformas distintas sejam compatíveis;

XML (eXtensible Markup Language) – é uma linguagem de marcação utilizada na criação de documentos com dados organizados hierarquicamente, tais como textos, banco de dados ou desenhos vetoriais. A linguagem XML é classificada como extensível porque permite definir os elementos de marcação;

XSD (XML Schema Definition) – em sua essência, é um arquivo XML, porém é estruturado de maneira que permite validar automaticamente outros objetos XML. Um documento XML, para ser considerado válido, deve respeitar as restrições impostas por um Schema XSD. O XSD contém as regras de preenchimento de conteúdo e de obrigatoriedade de cada elemento ou grupo de informação do XML;

WSDL (WebServices Description Language) – é uma linguagem baseada em XML utilizada para descrever WebServices. Trata-se de um documento escrito em XML que além de descrever o serviço, especifica como acessá-lo e quais as operações ou métodos disponíveis;

SOAP - Protocolo de acesso a objetos. O SOAP serve para a troca de informações e/ou dados através de objetos criados em diversas linguagens de programação. Com o SOAP é possível criar aplicações para troca de dados entre empresas. Este protocolo é baseado em XML, o que significa que as aplicações criadas podem ser aceitas em qualquer plataforma e por qualquer linguagem.

1.5. Modelo Tecnológico

Por meio de WebServices, as empresas Contratantes de fretes deverão integrar seus sistemas de informação com o do Sistema e-FRETE, que por sua vez está interligado com o sistema de PEF - Pagamento Eletrônico de Frete da ANTT. Desta forma, pretende-se automatizar o processo de verificação das informações dos transportadores junto ao sistema do Registro Nacional de Transportadores Rodoviários de Cargas – RNTRC – e o envio das informações das operações de transporte, recebendo no mesmo momento, o protocolo de autorização, que deve ser utilizado em todo contrato de transporte, conforme previsto na Resolução ANTT Nº 3.658/11.

Todas as informações recebidas e repassadas pelos serviços são as que estão descritas nas interfaces dos WebServices. Cada serviço estará preparado para, mediante o fornecimento dos dados obrigatórios, retornarem as informações descritas nas interfaces.

A versão do SOAP utilizada foi a 1.1.

1.6. Lista de documentos relacionados

• Lei no 11.442, de 5 de janeiro de 2007; • Resolução ANTT Nº 3.056, de 12 de março de 2009; • Resolução ANTT Nº 3.658, de 19 de abril de 2011. • Comunicado SUCAR/ANTT 01/2012 sobre Cooperativas • Comunicado SUCAR/ANTT 02/2012 sobre Instruções para o cadastramento de Operação de

Transporte e geração do Código Identificar da Operação de Transporte - CIOT • Anexo ao Comunicado SUCAR/ANTT 02/2012

1.7. Instruções para registro de problemas

Em caso de problemas na documentação e/ou no software entrar em contato através do endereço






7

eletrônico [email protected].

1.8. Versões do Manual

Versão Descrição das mudanças Data de Liberação 1.0 Manual com versão original do WebService 02/03/2011

1.1 Ajustes no WebService de acordo com as especificações da ANTT.

Foi realizada a conexão dos serviços do Sistema e-FRETE com a

ANTT.

17/01/2012

1.2 Adição de novos campos para as operações do serviço de PEF para contemplar com plenitude as necessidades encontradas diante dos testes realizados pela ANTT.

Adição do RNTRC para a operação de Obter Veículo.

Separação de blocos de campos que se repetem dentro de cada serviço para reduzir a quantidade de páginas do presente documento.

28/02/2012

2.0 Possibilidade de parcelar o adiantamento. Inclusão da versão 2 em alguns métodos. Mudança de comportamento nos métodos do PefService: - AdicionarOperacaoTransporte; - AdicionarViagem; - AdicionarPagamento; - CancelarPagamento. Alguns dos métodos passaram a aceitar versão 2 devido a mudança no seu comportamento, mas a versão 1 continua válida. Os elementos TipoPagamento e InformacoesBancarias contidos na raiz Viagens tornam-se obsoletos, uma vez que esses dados devem ser informados dentro do Pagamento, apesar de eles ainda estarem presentes no modelo de dados devido a sua compatibilidade com a versão 1 os mesmos foram subtraídos do presente manual uma vez que para a versão 2 não devem ser informados.

15/04/2013

2.1 Adição do método Obter Transações no PefService. 24/04/2011

Cada versão do manual após sua liberação torna a anterior prescrita.

Diante de divergências do Manual com o Serviço, o Serviço possui preferência.

O endereço para acesso aos Serviços não sofre modificação em função da mudança de versão do manual.

2. WebService

2.1. Procedimento de Logon

2.1.1. Objetivo

Definir requisitos necessários para operar no Sistema.

2.1.2. Login






8

Recebe e-mail e senha do usuário, ou o padrão digital do usuário como senha (neste caso sem identificar o usuário) e retorna um token, que deverá ser guardado para todas as outras requisições.

Se o usuário não for encontrado ou estiver bloqueado, o retorno será NULO.

2.1.2.1. Entradas

Estrutura XML com os dados de entrada do Login.

# Campo Elem Pai Tipo Ocor Tam Dec Descrição/Observação

LP01 LoginRequest RAIZ - - 1-1 - - -

LP02 Senha E LP01 S 1-1 - - Senha cadastrada no sistema.

LP03 Usuario E LP01 S 1-1 - - Email/CPF cadastrado no sistema.

LP04 Integrador E LP01 S 1-1 - - Hash de referência ao integrador.

LP05 Versao E LP01 N 1-1 1 - Versão = 1

2.1.2.2. Retorno

Estrutura XML com os dados de retorno da transmissão.


LR01 LoginResponse RAIZ - - 1-1 - - -

LR02 Excecao RAIZ LR01 - 0-1 - - -

LR03 Mensagem E LR02 S 1-1 - -

Mensagem de erro.

Só terá valor no caso de Sucesso for False.

LR04 Sucesso E LR01 B 1-1 - -

Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:

· True (sucesso na solicitação)

· False (erro na solicitação).

LR05 Versao E LR01 N 1-1 1 - Versão = 1

2.1.3. Logout

Recebe um token ativo, e remove o token da lista.

2.1.3.1. Entradas

Estrutura XML com os dados de entrada do Logon.







9

TP01 LogoutRequest RAIZ - - 1-1 - - -

TP02 Integrador E TP01 S 1-1 - - Hash de referência ao integrador

TP03 Versao E TP01 N 1-1 - - Versão = 1

TP04 Token E TP01 S 0-1 - - Token de autenticação do contratante.

2.1.3.2. Retorno



TR01 LogoutResponse RAIZ - - 1-1 - - -

TR02 Excecao RAIZ TR01 - 0-1 - - -

TR03 Mensagem E TR02 S 1-1 - -

Mensagem de erro.


TR04 Sucesso E TR01 B 1-1 - -

Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:



TR05 Versao E TR01 N 1-1 1 - Versão = 1

2.1.4. Mensagens de erro

Por critério de segurança, as mensagem de erro do Login e do Logout são silenciosas.

Mesmo que o os dados solicitados sejam informados incorretos não haverá retorno com mensagem alertando esse erro.

2.2. Procedimento de requisição a Motoristas

2.2.1. Objetivo

Realizar junto ao Sistema e-FRETE cadastro, atualização ou busca de dados do Motorista que irá realizar uma viagem.

No WebService pode-se obter um objeto para consulta, se este existir, ou gravar um objeto existente. Ou seja, ao gravar, se o objeto já existir, ele será atualizado, se o objeto não existir, ele será adicionado à base.






10

2.2.2. Gravar motorista

Adiciona ou atualiza dados de um motorista na base.

2.2.2.1. Entrada

Estrutura XML com os dados para gravar Motorista.


MP01 GravarRequest RAIZ - - - - - -

MP02 Integrador E MP01 S 1-1 - - Hash de referência ao integrador.

MP03 Token E MP01 S 1-1 - - Token de autenticação do contratante.

MP04 Versao E MP01 N 1-1 1 - Versão = 1

MP05 CNH E MP01 N 1-1 - - Número da CNH do Motorista.

MP06 CPF E MP01 N 1-1 11 - CPF do motorista.

MP07 DataNascimento E MP01 DT 1-1 - - -

MP08 Endereco RAIZ MP01 - 1-1 - - -

MP09 Bairro E MP08 S 1-1 - - -

MP10 CEP E MP08 S 1-1 9 - Exemplo: 12345-678.

MP11 CodigoMunicipio E MP08 N 1-1 7 - Código do Município segundo IBGE.

MP12 Rua E MP08 S 1-1 - - -

MP13 Nome E MP01 S 1-1 - - -

MP14 NomeDeSolteiraDaMae

E MP01 S 1-1 - - Será utilizado para autenticação no caso de ligação do motorista para o serviço de 0800.

MP15 Telefones RAIZ MP01 - 1-1 - - -

MP16 Celular RAIZ MP15 - 1-1 - - -

MP17 DDD E MP16 N 1-1 2 - -

MP18 Numero E MP16 N 1-1 8-9 - -

MP19 Fax RAIZ MP15 - 0-1 - - -

MP20 DDD E MP19 N 0-1 2 - -

MP21 Numero E MP19 N 0-1 8-9 - -

MP22 Fixo RAIZ MP15 - 0-1 - - -

MP23 DDD E MP22 N 0-1 2 - -






11

MP24 Numero E MP22 N 0-1 8-9 - -

2.2.2.2. Retorno:



MR01 GravarResponse RAIZ - - 1-1 - - -

MR02 Motorista RAIZ MR01 - - - - -

MR03 CNH E MR02 N 1-1 - -

MR04 CPF E MR02 N 1-1 11 - -

MR05 DataNascimento E MR02 DT 1-1 - - -

MR06 Endereco RAIZ MR02 - 1-1 - - -

MR07 Bairro E MR06 S 1-1 - - -

MR08 CEP E MR06 S 1-1 - - -

MR09 CodigoMunicipio E MR06 N 1-1 - -

Código do Município segundo IBGE.

MR10 Rua E MR06 S 1-1 - - -

MR11 Nome E MR02 S 1-1 - - -

MR12 NomeDeSolteiraDaMae

E MR02 S 1-1 - - Será utilizado para autenticação no caso de ligação do motorista para o serviço de 0800.

MR13 Telefones RAIZ MR02 - - - - -

MR14 Celular RAIZ MR13 - 1-1 - - -

MR15 DDD E MR14 N 1-1 2 - -

MR16 Numero E MR14 N 1-1 8-9 - -

MR17 Fax RAIZ MR13 - 0-1 - - -

MR18 DDD E MR17 N 0-1 2 - -

MR19 Numero E MR17 N 0-1 8-9 - -

MR20 Fixo RAIZ MR13 - 0-1 - - -

MR21 DDD E MR20 N 0-1 2 - -

MR22 Numero E MR20 N 0-1 8-9 - -

MR23 Excecao RAIZ MR01 - 1-1 - - -

MR24 Mensagem E MR23 S 1-1 - - Mensagem de erro.







12

MR25 Sucesso E MR01 B 1-1 - - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:


· False (erro na solicitação)

MR26 Versao E MR01 N 1-1 1 - Versão = 1

2.2.3. Obter Motorista

Busca e retorna dados de um motorista, se existente, através de uma pesquisa.

2.2.3.1. Entrada

Estrutura XML com os dados de pesquisa do Motorista.


OP01 ObterRequest RAIZ - - - - - -

OP02 CNH E OP01 N 1-1 - - CNH do Motorista.

OP03 CPF E OP01 N 1-1 11 - CPF do Motorista.

OP04 Integrador E OP01 S 1-1 - - Hash de referência ao integrador.

OP05 Token E OP01 S 1-1 - - Token de autenticação do contratante.

OP06 Versão E OP01 N 1-1 1 - Versão = 1

2.2.3.2. Retorno



OR01 ObterResponse RAIZ - - 1-1 - - -

OR02 Motorista RAIZ - - 1-1 - - -

OR03 CNH E OR02 N 1-1 - - -

OR04 CPF E OR02 N 1-1 11 - -

OR05 DataNascimento E OR02 DT 1-1 - - -

OR06 Endereco RAIZ OR02 - 1-1 - - -

OR07 Bairro E OR06 S 1-1 - - -

OR08 CEP E OR06 S 1-1 - - -

OR09 CodigoMunicipio E OR06 N 1-1 - - -






13

OR10 Rua E OR06 S 1-1 - - -

OR11 Nome E OR02 S 1-1 - - -

OR12 NomeDeSolteiraDaMae

E OR02 S 1-1 - - Será utilizado para autenticação no caso de ligação do motorista para o serviço de 0800.

OR13 Telefones RAIZ OR01 - 1-1 - - -

OR14 Celular RAIZ OR13 - 1-1 - - -

OR15 DDD E OR14 N 1-1 - - -

OR16 Numero E OR14 N 1-1 - - -

OR17 Fax RAIZ OR13 - 0-1 - - -

OR18 DDD E OR17 N 0-1 - - -


OR20 Fixo RAIZ OR13 - 0-1 - - -

OR21 DDD E OR20 N 0-1 - - -


OR23 Excecao RAIZ OR01 - 1-1 - - -

OR24 Mensagem E OR23 S 1-1 - - Mensagem de erro.


OR25 Sucesso E OR01 B 1-1 - - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:


· False (erro na solicitação)

OR26 Versao E OR01 N 1-1 - - Versão = 1

2.2.4. Enviar Foto

Atualiza Foto do Motorista na base de dados.

2.2.4.1. Entrada

Estrutura XML com os dados para envio de fotos do motorista.


UP01 EnviarFotoRequest RAIZ - - 1-1 - - -

UP02 CNH E UP01 N 1-1 - - CNH do Motorista.

UP03 CPF E UP01 N 1-1 11 - CPF do Motorista.






14

UP04 Foto E UP01 A 1-1 - - Foto no formato jpg, dimensões: 200px x 250px.

UP05 Integrador E UP01 S 1-1 - - Hash de referência ao integrador

UP06 Token E UP01 S 1-1 - - Token de autenticação do contratante.

UP07 Versao E UP01 N 1-1 - - Versão = 1

2.2.4.2. Retorno



UR01 EnviarFotoResponse

RAIZ - - 1-1 - - -

UR02 CPF E UR01 N 1-1 11 - CPF do motorista.

UR03 Excecao RAIZ UR01 - 1-1 - - -

UR04 Mensagem E UR03 S 1-1 - - Mensagem de erro.


UR05 Sucesso E UR01 B 1-1 - - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:



UR06 Versao E UR01 N 1-1 - - Versão = 1

2.2.5. Buscar Foto

Busca e retorna a foto de um Motorista, se existente.

2.2.5.1. Entrada

Estrutura XML com os dados para pesquisa de foto de um Motorista.


BP01 BuscarFotoRequest

RAIZ - - 1-1 - - -

BP02 CNH E BP01 N 1-1 - - CNH do Motorista.

BP03 CPF E BP01 N 1-1 11 - CPF do Motorista.






15

BP04 Integrador E BP01 S 1-1 - - Hash de referência ao integrador.

BP05 Token E BP01 S 1-1 - - Token de autenticação do contratante.

BP07 Versao E BP01 N 1-1 - - Versão = 1

2.2.5.2. Retorno



BR01 BuscarFotoResponse

RAIZ - - 1-1 - - -

BR02 CPF E BR01 N 1-1 11 - CPF do motorista.

BR03 Excecao RAIZ BR01 - 1-1 - - -

BR04 Mensagem E BR03 S 1-1 - - Mensagem de erro.


BR05 Foto E BR01 A 1-1 - - Foto do motorista dono do CPF informado.

BR06 Sucesso E BR01 B 1-1 - - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:



BR07 Versao E BR01 N 1-1 - - Versão = 1

2.3. Procedimento de requisição a Proprietário

2.3.1. Objetivo

Realizar junto ao Sistema e-FRETE cadastro, atualização ou busca de dados do Proprietário do veículo que irá realizar uma viagem.

Nos WebServices pode-se obter um objeto para consulta, se este existir, ou gravar um objeto existente. Ou seja, ao gravar, se o objeto já existir, ele será atualizado, se o objeto não existir, ele será adicionado à base.

2.3.2. Gravar Proprietário

Adiciona ou atualiza um Proprietário.

2.3.2.1. Entrada






16

Estrutura XML com os dados para gravar um Proprietário.


PP01 GravarRequest RAIZ - - 1-1 - - -

PP02 Integrador E PP01 S 1-1 - - Hash de referência ao integrador.

PP03 CNPJ E PP01 S 1-1 14 - -

PP04 Endereco RAIZ PP01 N 1-1 - - -

PP05 Bairro E PP04 S 1-1 - - -

PP06 CEP E PP04 S 1-1 9 - Exemplo: 12345-678.

PP07 CodigoMunicipio E PP04 N 1-1 7 - Código do Município segundo IBGE.

PP08 Rua E PP04 S 1-1 - - -

PP09 RNTRC E PP01 N 1-1 - - RNTRC do Proprietário.

PP10 RazaoSocial E PP01 S 1-1 - - -

PP11 Telefones RAIZ PP01 - 1-1 - - -

PP12 Celular RAIZ PP11 - 1-1 - - -

PP13 DDD E PP12 N 1-1 2 - -

PP14 Numero E PP12 N 1-1 8-9 - -

PP15 Fax RAIZ PP11 - 0-1 - - -

PP16 DDD E PP15 N 0-1 2 - -

PP17 Numero E PP15 N 0-1 8-9 - -

PP18 Fixo RAIZ PP11 - 0-1 - - -

PP19 DDD E PP18 N 0-1 2 -

PP20 Numero E PP18 N 0-1 8-9 -

PP21 Token E PP01 S 1-1 - Token de autenticação do contratante.

PP22 Versao E PP01 N 1-1 1 Versão = 1

2.3.2.2. Retorno



PR01 GravarResponse RAIZ - - 1-1 - - -

PR02 Excecao RAIZ PR01 - 1-1 - - -

PR03 Mensagem E PR02 S 1-1 - - Mensagem de erro.







17

PR04 Proprietario RAIZ PR01 - 1-1 - - -

PR05 CNPJ E PR04 S 1-1 14 - -

PR06 Endereco RAIZ PR04 N 1-1 - - -

PR07 Bairro E PR06 S 1-1 - - -

PR08 CEP E PR06 S 1-1 9 - Exemplo: 12345-678.

PR09 CodigoMunicipio E PR06 N 1-1 7 - Código do Município segundo IBGE.

PR10 Rua E PR06 S 1-1 - - -

PR11 RNTRC E PR04 N 1-1 - - RNTRC do Proprietário.

PR12 RazaoSocial E PR04 S 1-1 - - -

PR13 Telefones RAIZ PR04 - 1-1 - - -

PR14 Celular RAIZ PR13 - 1-1 - - -

PR15 DDD E PR14 N 1-1 2 - -

PR16 Numero E PR14 N 1-1 8-9 - -

PR17 Fax RAIZ PR13 - 0-1 - - -

PR18 DDD E PR17 N 0-1 2 - -

PR19 Numero E PR17 N 0-1 8-9 - -

PR20 Fixo RAIZ PR13 - 0-1 - - -

PR21 DDD E PR20 N 0-1 2 -

PR22 Numero E PR20 N 0-1 8-9 -

PR23 Sucesso E PR01 B 1-1 - - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:



PR24 Versao E PR01 N 1-1 1 Versão = 1

2.3.3. Obter Proprietário

Realiza pesquisa dentre os Proprietários da base através do CNPJ e RNTRC.

2.3.3.1. Entrada

Estrutura XML com os dados para obter Proprietário.


RP01 ObterRequest RAIZ - - - - - -






18

RP02 CNPJ E RP01 N 1-1 14 - Número do CNPJ do Proprietário.

RP03 Integrador E RP01 S 1-1 - - Hash de referência ao integrador.

RP04 RNTRC E RP01 N 1-1 - - RNTRC do Proprietário.

RP05 Token E RP01 S 1-1 - - Token de autenticação do contratante.

RP06 Versão E RP01 N 1-1 1 - Versão = 1

2.3.3.2. Retorno



RR01 ObterResponse RAIZ - - 1-1 - - -

RR02 Excecao RAIZ RR01 - 1-1 - - -

RR03 Mensagem E RR02 S 1-1 - - Mensagem de erro.


RR04 Proprietario RAIZ RR01 - 1-1 - - -

RR05 CNPJ E RR04 N 1-1 14 - -

RR06 Endereco RAIZ RR04 S 1-1 - - -

RR07 Bairro E RR06 S 1-1 - - -

RR08 CEP E RR06 S 1-1 9 - -

RR09 CodigoMunicipio E RR06 N 1-1 7 - -

RR10 Rua E RR06 S 1-1 - - -

RR11 RNTRC E RR04 N 1-1 - - -

RR12 RazaoSocial E RR04 S 1-1 - - -

RR13 TACouEquiparado E RR04 B 1-1 - - -

RR14 Tipo E RR04 S 1-1 - - Restrito aos itens da enum:

-TAC

-ETC

-CTC

RR15 Telefones RAIZ RR04 - 1-1 - - -

RR16 Celular RAIZ RR15 - 1-1 - - -

RR17 DDD R RR16 N 1-1 2 - -

RR18 Numero R RR16 N 1-1 8-9 - -

RR19 Fax RAIZ RR15 - 0-1 - - -






19

RR20 DDD E RR20 N 0-1 2 - -

RR21 Numero E RR20 N 0-1 8-9 - -

RR22 Fixo RAIZ RR15 - 0-1 - - -

RR23 DDD E RR22 N 0-1 2 - -

RR24 Numero E RR22 N 0-1 8-9 - -

RR25 Sucesso E RR01 B 1-1 - - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:



RR26 Versao E RR01 N 1-1 1 - Versão = 1

2.4. Procedimento de requisição a Veículo

2.4.1. Objetivo

Realizar junto ao Sistema e-FRETE cadastro, atualização ou busca de dados do Veículo que irá realizar uma viagem.

2.4.2. Adicionar Veículo

Adiciona ou atualiza um Veículo.

No WebService pode-se obter um objeto para consulta, se este existir, ou gravar um objeto existente. Ou seja, ao gravar, se o objeto já existir, ele será atualizado, se o objeto não existir, ele será adicionado à base.

2.4.2.1. Entrada

Estrutura XML com os dados para gravar um Veículo.


VP01 GravarRequest RAIZ - - - - - -

VP02 Integrador E VP01 S 1-1 - - Hash de referência ao integrador.

VP03 Token E VP01 S 1-1 - - Token de autenticação do contratante.

VP04 Veiculo RAIZ VP01 - 1-1 - - -

VP05 AnoFabricacao E VP04 N 1-1 4 - De 1930 até o ano atual.

VP06 AnoModelo E VP04 N 1-1 4 - De 1930 até o ano atual.

VP07 CapacidadeKg E VP04 N 1-1 - - Capacidade do veículo em Kg.






20

VP08 CapacidadeM3 E VP04 N 1-1 - - Capacidade do veículo em M3.

VP09 Chassi E VP04 S 1-1 - - Chassi do veículo.

VP10 CodigoMunicipio E VP04 S 1-1 7 - Código do Município segundo IBGE.

VP11 Cor E VP04 S 1-1 - - Cor do veículo.

VP12 Marca E VP04 S 1-1 - - Marca do veículo.

VP13 Modelo E VP04 S 1-1 - - Modelo do veículo.

VP14 NumeroDeEixos E VP04 N 1-1 - - Número de eixos do veículo.

VP15 Placa E VP04 S 1-1 7 - Exemplo: AAA1234.

VP16 RNTRC E VP04 N 1-1 8 - RNTRC do veículo.

VP17 Renavam E VP04 N 1-1 0-11 - RENAVAM do veículo.

VP18 Tara E VP04 N 1-1 - - Peso do veículo.

VP19 TipoCarroceria E VP04 S 0-1 - - Restrito aos itens da enum:

-NaoAplicavel

-Aberta

-FechadaOuBau

-Graneleira

-PortaContainer

-Sider

VP20 TipoRodado E VP04 S 0-1 - - Restrito aos itens da enum:

-NaoAplicavel

-Truck

-Toco

-Cavalo

VP21 Versão E VP01 N 1-1 1 - Versão = 1

2.4.2.2. Retorno



VR01 GravarResponse RAIZ - - - - - -

VR02 Excecao RAIZ - - - - - -

VR03 Mensagem E VR02 S 1-1 - - Mensagem de erro.







21

VR04 Sucesso E VR01 S 1-1 - - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são: · True (sucesso na solicitação) · False (erro na solicitação).

VR05 Veiculo RAIZ VR01 - 1-1 - - -

VR06 AnoFabricacao E VR05 N 1-1 4 - De 1930 até o ano atual.

VR07 AnoModelo E VR05 N 1-1 4 - De 1930 até o ano atual.

VR08 CapacidadeKg E VR05 N 1-1 - - Capacidade do veículo em Kg.

VR09 CapacidadeM3 E VR05 N 1-1 - - Capacidade do veículo em M3.

VR10 Chassi E VR05 S 1-1 - - Chassi do veículo.

VR11 CodigoMunicipio E VR05 S 1-1 7 - Código do Município segundo IBGE.

VR12 Cor E VR05 S 1-1 - - Cor do veículo.

VR13 Marca E VR05 S 1-1 - - Marca do veículo.

VR14 Modelo E VR05 S 1-1 - - Modelo do veículo.

VR15 NumeroDeEixos E VR05 N 1-1 - - Número de eixos do veículo.

VR16 Placa E VR05 S 1-1 7 - Exemplo: AAA1234.

VR17 RNTRC E VR05 N 1-1 8 - RNTRC do veículo.

VR18 Renavam E VR05 N 1-1 0-11 - RENAVAM do veículo.

VR19 Tara E VR05 N 1-1 - - Peso do veículo.

VR20 TipoCarroceria E VR05 S 0-1 - - -

VR21 TipoRodado E VR05 S 0-1 - - -

VR22 Versão E VR01 N 1-1 1 - Versão = 1

2.4.3. Obter Veículo

Realiza pesquisa dentre os Veículos da base através da Placa e RNTRC.

2.4.3.1. Entrada

Estrutura XML com os dados para obter Veículo por placa.







22

CP01 ObterPorPlacaRequest

RAIZ - - - - - -

CP02 Integrador E CP01 S 1-1 - - Hash de referência ao integrador.

CP03 Placa E CP01 S 1-1 7 - Placa do veículo pesquisado.

No padrão conforme exemplo: AAA1234.

CP04 RNTRC E CP01 N 1-1 8 - RNTRC do veículo.

CP05 Token E CP01 S 1-1 - - Token de autenticação do contratante.

CP6 Versão E CP01 N 1-1 1 - Versão = 1

2.4.3.2. Retorno



CR01 ObterPorPlacaResponse

RAIZ - - - - - -

CR02 Excecao RAIZ CR01 - 1-1 - - -

CR03 Mensagem E CR02 S 1-1 - - Mensagem de erro.


CR04 Sucesso E CR01 S 1-1 - - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:



CR05 Veiculo RAIZ CR01 - 1-1 - - -

CR06 AnoFabricacao E CR05 N 1-1 4 - De 1930 até o ano atual.

CR07 AnoModelo E CR05 N 1-1 4 - De 1930 até o ano atual.

CR08 CapacidadeKg E CR05 N 1-1 - - Capacidade do veículo em Kg.

CR09 CapacidadeM3 E CR05 N 1-1 - - Capacidade do veículo em M3.

CR10 Chassi E CR05 S 1-1 - - Chassi do veículo.

CR11 CodigoMunicipio E CR05 S 1-1 7 - Código do Município segundo IBGE.

CR12 Cor E CR05 S 1-1 - - Cor do veículo.

CR13 Marca E CR05 S 1-1 - - Marca do veículo.

CR14 Modelo E CR05 S 1-1 - - Modelo do veículo.

CR15 NumeroDeEixos E CR05 N 1-1 - - Número de eixos do veículo.






23

CR16 Placa E CR05 S 1-1 7 - Exemplo: AAA1234.

CR17 RNTRC E CR05 N 1-1 8 - RNTRC do veículo.

CR18 Renavam E CR05 N 1-1 0-11 - RENAVAM do veículo.

CR19 Tara E CR05 N 1-1 - - Peso do veículo.

CR20 TipoCarroceria E CR05 S 0-1 - - -

CR21 TipoRodado E CR05 S 0-1 - - -

CR22 Versão E CR01 N 1-1 1 - Versão = 1

2.5. Procedimento de requisição a Frete

2.5.1. Objetivo

Definir requisitos necessários para enviar e receber requisições quanto ao frete (Operação de Transporte).

2.5.2. Adicionar Operação de Transporte

Adiciona uma Operação de Transporte.

2.5.2.1. Entrada

Estrutura XML com os dados para adicionar Operação de Transporte.


AP01 AdicionarOperacaoTransporteRequest

RAIZ - - - - - -

AP02 CodigoIdentificacaoOperacaoPrincipal

E AP01 S 1-1 - - Informar um CIOT (se existente) que esteja relacionado à operação de transporte. Por exemplo: No caso da presença de um Subcontratante na operação de transporte informar o CIOT da operação na qual o Subcontratante foi o Contratado, se o CIOT existir.






24

AP03 CodigoNCMNaturezaCarga

E AP01 N 1-1 4 - Código NCM da mercadoria. No caso de existir mais de um tipo de carga usar o código da mercadoria com maior valor comercial. Caso a carga seja composta por diversos produtos de grupos distintos e não for possível aplicar o critério anterior pode-se utilizar o código de carga diversa (0001).

AP04 Consignatario RAIZ AP01 - 0-1 - - Aquele que receberá as mercadorias transportadas em consignação, indicado no cadastramento da Operação de Transporte ou nos respectivos documentos fiscais.

AP05 CpfOuCnpj E AP04 N 0-1 - - CPF ou CNPJ do Consignatário.

AP06 EMail E AP04 S 0-1 - - Email do consignatário.

AP07 Endereco RAIZ AP04 - 0-1 - - -

AP08 Bairro E AP06 S 0-1 - - Bairro do Consignatário.

AP09 CEP E AP06 S 0-1 - - CEP do Consignatário.

AP10 CodigoMunicipio E AP06 N 0-1 7 - Código do município segundo o IBGE.

AP11 Rua E AP06 S 0-1 - - Rua e número do consignatário.

AP12 NomeOuRazaoSocial

E AP04 S 0-1 - - Nome ou Razão Social do Consignatário.

AP13 ResponsavelPeloPagamento

E AP04 B 1-1 - - Informar se é o responsável pelo pagamento da Operação de Transporte.

True = Sim.

False = Não.

AP14 Telefones RAIZ AP04 - 0-1 - - -

AP15 Celular RAIZ AP14 - 0-1 - - -

AP16 DDD R AP15 N 0-1 2 - -

AP17 Numero R AP15 N 0-1 8-9 - -

AP18 Fax RAIZ AP14 - 0-1 - - -

AP19 DDD E AP19 N 0-1 2 - -

AP20 Numero E AP19 N 0-1 8-9 - -

AP21 Fixo RAIZ AP14 - 0-1 - - -






25

AP22 DDD E AP21 N 0-1 2 - -

AP23 Numero E AP21 N 0-1 8-9 - -

AP24 Contratado RAIZ AP01 - 1-1 - - TAC ou seu equiparado, que efetuar o transporte rodoviário de cargas por conta de terceiros e mediante remuneração, indicado no cadastramento da Operação de Transporte.

AP25 CpfOuCnpj E AP24 N 1-1 11-14 - CPF ou CNPJ do Contratado.

AP26 RNTRC E AP24 N 1-1 8 - RNTRC do Contratado.

AP27 Contratante RAIZ AP01 - 1-1 - - -

AP28 CpfOuCnpj E AP27 N 1-1 11-14 - CPF ou CNPJ do Contratante.

AP29 EMail E AP27 S 0-1 - - Email do Contratante.


AP31 Bairro E AP30 S 1-1 - - Bairro do Contratante.

AP32 CEP E AP30 S 1-1 - - CEP do Contratante.


AP34 Rua E AP30 S 1-1 - - Rua e número do Contratante.


E AP27 S 1-1 - - Nome ou Razão Social do Contratante.



True = Sim.

False = Não.



AP39 DDD R AP38 N 0-1 2 - -

AP40 Numero R AP38 N 0-1 8-9 - -

AP41 Fax RAIZ AP37 - 0-1 - - -

AP42 DDD E AP41 N 0-1 2 - -

AP43 Numero E AP41 N 0-1 8-9 - -

AP44 Fixo RAIZ AP37 - 0-1 - - -

AP45 DDD E AP44 N 0-1 2 - -

AP46 Numero E AP44 N 0-1 8-9 - -






26

AP47 DataFimViagem E AP01 DT 1-1 - - Data prevista para o fim de viagem.

AP48 DataInicioViagem E AP01 DT 0-1 - - Data de início da viagem.

Operação do tipo 1 seu preenchimento é obrigatório.

AP49 Destinatario RAIZ AP01 - 1-1 - - Destinatário da carga.

AP50 CpfOuCnpj E AP49 N 1-1 11-14 - CPF ou CNPJ do Destinatário.

AP51 EMail E AP49 S 0-1 - - Email do Destinatário.


AP53 Bairro E AP52 S 1-1 - - Bairro do Destinatário.

AP54 CEP E AP52 S 1-1 - - CEP do Destinatário.


AP56 Rua E AP52 S 1-1 - - Rua e número do Destinatário.


E AP49 S 1-1 - - Nome ou Razão Social do Destinatário.



True = Sim.

False = Não.



AP61 DDD R AP60 N 0-1 2 - -

AP62 Numero R AP60 N 0-1 8-9 - -

AP63 Fax RAIZ AP59 - 0-1 - - -

AP64 DDD E AP63 N 0-1 2 - -

AP65 Numero E AP63 N 0-1 8-9 - -

AP66 Fixo RAIZ AP59 - 0-1 - - -

AP67 DDD E AP66 N 0-1 2 - -

AP68 Numero E AP66 N 0-1 8-9 - -

AP69 FilialCNPJ E AP01 N 0-1 - - CPNJ da filial do Contratante, que está realizando a operação de transporte, se necessário.

AP70 IdOperacaoCliente E AP01 S - - - Id / Chave primária da operação de transporte no sistema do Cliente.






27

AP71 Integrador E AP01 S 1-1 - - Hash de referência ao integrador.

AP72 Impostos RAIZ AP01 - 1-1 - - -

AP73 DescricaoOutrosImpostos

E AP72 S 0-1 - - Descrição dos impostos com valor no campo OutrosImpostos.

AP74 INSS E AP72 M 1-1 - - Valor destinado ao INSS.

Este valor deverá fazer parte do valor de Adiantamento ou do valor de Quitação.

AP75 IRRF E AP72 M 1-1 - - Valor destinado ao IRRF.


AP76 ISSQN E AP72 M 1-1 - - Valor destinado ao ISSQN.


AP77 OutrosImpostos E AP72 M 0-1 - - Valor destinado a outros impostos não previstos.


AP78 SestSenat E AP72 M 1-1 - - Valor destinado ao SEST / SENAT.


AP79 MatrizCNPJ E AP01 N 1-1 - - CNPJ da Matriz da Transportadora.

AP80 Motorista RAIZ AP01 - 1-1 - - É o condutor do veículo que irá realizar a operação de transporte, pode ser o proprietário do veículo ou não.

AP81 Celular RAIZ AP80 N 1-1 - - -

AP82 DDD E AP81 N 1-1 2 - DDD do celular do Motorista.

AP83 Numero E AP81 N 1-1 8-9 - Número do celular do Motorista.

AP84 CpfOuCnpj E AP80 N 1-1 11-14 - CPF ou CNPJ do Motorista.






28

AP85 Pagamentos RAIZ AP01 - 1-N - - Pagamentos registrados. - Pode existir mais de 1 pagamento com uma mesma categoria (exceto para Quitacao).

- A soma dos pagamentos c/ categoria Adiantamento, deverá ter o mesmo valor apontado na tag TotalAdiantamento da tag Viagem/Valores, e neste caso, a tag Documento do pagamento deverá conter o mesmo valor da tag DocumentoViagem da tag Viagem . - Se a viagem possuir a tag TotalQuitacao maior que zero, deverá ter um pagamento correspondente, com Categoria Quitacao e com o Documento o mesmo valor apontado na tag DocumentoViagem .

AP86 Categoria E AP85 S 1-1 - - Categoria relacionada ao pagamento realizado. Restrita aos membros da ENUM:

-Adiantamento,

-Estadia,

Quitacao,

-SemCategoria

AP87 DataDeLiberacao E AP85 DT 0-N - - Data em que o pagamento será liberado para saque.

AP88 Documento E AP85 S - - - Documento relacionado a viagem.

AP89 IdPagamentoCliente

E AP85 S 0-N - - Identificador do pagamento no sistema do Cliente.

AP90 InformacaoAdicional

E AP85 S 0-N - - Informação adicional caso o cliente precise registrar alguma observação.

AP91 InformacoesBancarias

RAIZ AP85 - - - - Dados da instituição bancária que irá ser realizado o pagamento.

AP92 Agencia E AP91 S 1-1 - - Agência na qual o contratado possui conta com dígito.

AP93 Conta E AP91 S 1-1 - - Conta do contratado com dígito.






29

AP94 InstituicaoBancaria E AP91 S 1-1 - - Nome da instituição bancária que será realizado o pagamento.

AP95 TipoPagamento E AP85 S 1-1 - - Tipo de pagamento que será usado pelo contratante.

Restrito aos itens da enum:

-TransferenciaBancaria

-eFRETE

AP96 Valor E AP85 M 0-N - - Valor do pagamento.

AP97 PesoCarga E AP01 D 1-1 - N,5 Peso total da carga.

AP98 Subcontratante RAIZ AP01 - 0-1 - - É o transportador que contratar outro transportador para realização do transporte de cargas para o qual fora anteriormente contratado, indicado no cadastramento da Operação de Transporte.

AP99 CpfOuCnpj E AP98 N 0-1 11-14 - CPF ou CNPJ do Subcontratante.

AP100 EMail E AP98 S 0-1 - - Email do Subcontratante.

AP101 Endereco RAIZ AP98 - 0-1 - - Endereço do Subcontratante.

AP102 Bairro E AP101 S 0-1 - - Bairro do Subcontratante.

AP103 CEP E AP101 S 0-1 - - CEP do Subcontratante.


AP105 Rua E AP101 S 0-1 - - Rua e número do Subcontratante.


E AP98 S 1-1 - - Nome ou Razão Social do Subcontratante.



True = Sim.

False = Não.



AP110 DDD R AP109 N 0-1 2 - -

AP112 Numero R AP109 N 0-1 8-9 - -

AP113 Fax RAIZ AP108 - 0-1 - - -

AP114 DDD E AP113 N 0-1 2 - -






30

AP115 Numero E AP113 N 0-1 8-9 - -

AP116 Fixo RAIZ AP108 - 0-1 - - -

AP117 DDD E AP116 N 0-1 2 - -

AP118 Numero E AP116 N 0-1 8-9 - -

AP119 TipoViagem E AP01 S 1-1 - - Restrito aos itens da enum:

-SemVinculoANTT

-Padrao

-TAC_Agregado

AP120 Token E AP01 S 1-1 - - Token de autenticação do contratante.

AP121 Veiculos RAIZ AP01 - 1-5 - - Registro dos veículos participantes da operação de transporte.

AP122 Placa E AP121 S 1-1 7 - Placa do veículo conforme exemplo: AAA1234.

AP123 Versao E AP01 N 1-1 1 - Versão = 2

AP124 Viagens RAIZ AP01 - - - - Viagens registradas.

AP125 CodigoMunicipioDestino

E AP124 N - 7 Código do Município de destino segundo IBGE

AP126 CodigoMunicipioOrigem

E AP124 N - 7 Código do Município de origem segundo IBGE

AP127 DocumentoViagem E AP124 S 1-1 - Exemplo: CT-e / Serie, CTRC / Serie, Ordem de Serviço.

AP128 NotasFiscais RAIZ AP124 - 1-N - - Notas fiscais da Viagem.

AP129 CodigoNCMNaturezaCarga

E AP128 N 1-1 4 - Código da mercadoria de acordo com a tabela NCM

AP130 Data E AP128 DT 0-1 - - Data da nota fiscal.

AP131 DescricaoDaMercadoria

E AP128 S 0-1 - - Descrição adicional ao código NCM.

AP132 Numero E AP128 S 1-1 - - Número da nota fiscal.

AP133 QuantidadeDaMercadoriaNoEmbarque

E AP128 D 1-1 - - Quantidade da mercadoria no embarque.

AP134 Serie E AP128 S 1-1 - - Série da nota fiscal.






31

AP135 TipoDeCalculo E AP128 S 1-1 - - Tipo de cálculo a ser efetuado para quebra de frete.


-SemQuebra

-QuebraSomenteUltrapassado

-QuebraIntegral.

AP136 ToleranciaDePerdaDeMercadoria

RAIZ AP128 - 1-1 - - Configuração da tolerância de perda de carga.

AP137 Tipo E AP136 S 1-1 - - Tipo de tolerância que será admitido para fretes com quebra.


-Nenhum

-Porcentagem

-ValorAbsoluto.

AP138 Valor E AP136 M 1-1 - - Valor da tolerância admitido.

AP139 UnidadeDeMedidaDaMercadoria

E AP128 S 1-1 - - Unidade de medida do produto.


-Tonelada;

-Kg;

-MetrosCubicos;

-Volume.

AP140 ValorDaMercadoriaPorUnidade

E AP128 M 1-1 - - Valor da mercadoria por unidade

AP141 ValorDoFretePorUnidadeDeMercadoria

E AP128 M 0-1 - - Valor do frete por unidade de mercadoria, utilizado para cálculo da quebra.

Em caso de frete com quebra seu preenchimento é obrigatório diferente de 0 (zero).

AP142 ValorTotal E AP128 M 1-1 - - Valor total da nota fiscal.

AP143 Valores RAIZ AP124 - - - - Valores monetários da viagem.

AP144 Combustivel E AP143 M 1-1 - - Valor destinado ao combustível. Este valor uma vez preenchido está contido dentro do valor informado para adiantamento.






32

AP145 JustificativaOutrosCreditos

E AP143 S - - - Justificativa para valor de outros créditos.

No caso do campo OutrosCreditos ser maior que zero seu preenchimento torna-se obrigatório.

AP146 JustificativaOutrosDebitos

E AP143 S - - - Justificativa para valor de outros débitos.

No caso do campo OutrosDebitos ser maior que zero seu preenchimento torna-se obrigatório.

AP147 OutrosCreditos E AP143 M 1-1 - - Valor livre.


AP148 OutrosDebitos E AP143 M 1-1 - - Valor livre.


AP149 Pedagio E AP143 M 1-1 - - Valor destinado ao pedágio.


AP150 Seguro E AP143 M 1-1 - - Valor destinado ao seguro.


AP151 TotalDeAdiantamento

E AP143 M 1-1 - - Valor total disponibilizado para adiantamento.

AP152 TotalDeQuitacao E AP143 M 1-1 - - Valor total disponibilizado para quitação.

AP153 TotalOperacao E AP143 M 1-1 - - Valor total da operação de transporte incluindo os créditos e débitos extras.

AP154 TotalViagem E AP143 M 1-1 - - Valor referente somente ao transporte.

AP155 EmissaoGratuita E AP01 B 1-1 - - Admite os valores True ou False.

2.5.2.2. Retorno







33


AR01 AdicionarOperacaoTransporteResponse

RAIZ - - - - - -

AR02 CodigoIdentificacaoOperacao

E AR01 S 1-1 - - Código de identificação da Operação (CIOT).

AR03 Excecao RAIZ AR01 - 1-1 - - -

AR04 Mensagem E AR02 S 1-1 - - Mensagem de erro.


AR05 Sucesso E AR01 B 1-1 - - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são: · True (sucesso na solicitação)


ER06 Versao E AR01 N 1-1 1 - Versão = 2

2.5.3. Obter Operação de Transporte

Busca e retorna a operação de transporte relacionada ao CIOT informado.

2.5.3.1. Entrada

Estrutura XML com os dados para obter informação sobre uma Operação de Transporte.


EP01 ObterOperacaoTransporteRequest

RAIZ - - - - - -

EP02 CodigoIdentificacaoOperacao

E EP01 S 1-1 - - Código de identificação da Operação (CIOT).

EP03 Integrador E EP01 S 1-1 - - Hash de referência ao integrador

EP04 Token E EP01 S 1-1 - - Token de autenticação do contratante.

EP05 Versao E EP01 N 1-1 1 - Versão = 1

2.5.3.2. Retorno








34

ER01 ObterOperacaoTransporteResponse

RAIZ - - - - - -

ER02 Excecao RAIZ ER01 - 1-1 - - -

ER03 Mensagem E ER02 S 1-1 - - Mensagem de erro.


ER04 OperacaoTransporte

RAIZ ER01 - 1-1 - - -

ER05 CodigoIdentificacaoOperacao

E ER04 S 1-1 - - Código de identificação da operação de transporte.

ER06 CodigoNCMNaturezaCarga

E ER04 N 1-1 4 - Código NCM da mercadoria predominante.

ER07 Consignatario RAIZ EP01 - 0-1 - - -

ER08 CpfOuCnpj E ER07 N 0-1 - - CPF ou CNPJ do Consignatário.

ER09 EMail E ER07 S 0-1 - - Email do Consignatário.

ER10 Endereco RAIZ ER07 - 0-1 - - -

ER11 Bairro E ER10 S 0-1 - - Bairro do Consignatário.

ER12 CEP E ER10 S 0-1 - - CEP do Consignatário.

ER13 CodigoMunicipio E ER10 N 0-1 7 - Código do município segundo o IBGE.

ER14 Rua E ER10 S 0-1 - - Rua e número do consignatário.

ER15 NomeOuRazaoSocial

E ER07 S 0-1 - - Nome ou Razão Social do Consignatário.

ER16 ResponsavelPeloPagamento

E ER07 B 1-1 - - Informar se é o responsável pelo pagamento da Operação de Transporte.

True = Sim.

False = Não.

ER17 Telefones RAIZ ER07 - 0-1 - - -

ER18 Celular RAIZ ER17 - 0-1 - - -

ER19 DDD R ER18 N 0-1 2 - -

ER20 Numero R ER18 N 0-1 8-9 - -

ER21 Fax RAIZ ER17 - 0-1 - - -

ER22 DDD E ER21 N 0-1 2 - -

ER23 Numero E ER21 N 0-1 8-9 - -

ER24 Fixo RAIZ ER17 - 0-1 - - -

ER25 DDD E ER24 N 0-1 2 - -






35

ER26 Numero E ER24 N 0-1 8-9 - -

ER27 Contratado RAIZ ER04 - 1-1 - - -

ER28 CpfOuCnpj E ER27 N 1-1 11-14 - CPF ou CNPJ do Contratado.

ER29 RNTRC E ER27 N 1-1 8 - RNTRC do Contratado.

ER30 Contratante RAIZ ER04 - 1-1 - - -

ER31 CpfOuCnpj E ER30 N 1-1 11-14 - CPF ou CNPJ do Contratante.

ER32 EMail E ER30 S 0-1 - - Email do Contratante.


ER34 Bairro E ER33 S 1-1 - - Bairro do Contratante.

ER35 CEP E ER33 S 1-1 - - CEP do Contratante.


ER37 Rua E ER33 S 1-1 - - Rua e número do Contratante.


E ER30 S 1-1 - - Nome ou Razão Social do Contratante.



True = Sim.

False = Não.



ER42 DDD R ER41 N 0-1 2 - -

ER43 Numero R ER41 N 0-1 8-9 - -

ER44 Fax RAIZ ER40 - 0-1 - - -

ER45 DDD E ER44 N 0-1 2 - -

ER46 Numero E ER44 N 0-1 8-9 - -

ER47 Fixo RAIZ ER40 - 0-1 - - -

ER48 DDD E ER47 N 0-1 2 - -

ER49 Numero E ER47 N 0-1 8-9 - -

ER50 DataFimViagem E ER04 DT 1-1 - - Data de fim da Viagem.

ER51 DataInicioViagem E ER04 DT 0-1 - - Data de Inicio da Viagem, somente para Tipo de Operação Padrão.

ER52 DataRegistro E ER04 DT 1-1 - - Data de registro da Operação de Transporte.






36

ER53 Destinatario RAIZ ER04 - 1-1 - - -

ER54 CpfOuCnpj E ER53 N 1-1 11-14 - CPF ou CNPJ do Destinatário.

ER55 EMail E ER53 S 0-1 - - Email do Destinatário.


ER57 Bairro E ER56 S 1-1 - - Bairro do Destinatário.

ER58 CEP E ER56 S 1-1 - - CEP do Destinatário.


ER60 Rua E ER56 S 1-1 - - Rua e número do Destinatário.


E ER53 S 1-1 - - Nome ou Razão Social do Destinatário.



True = Sim.

False = Não.



ER65 DDD R ER64 N 0-1 2 - -

ER66 Numero R ER64 N 0-1 8-9 - -

ER67 Fax RAIZ ER63 - 0-1 - - -

ER68 DDD E ER67 N 0-1 2 - -

ER69 Numero E ER67 N 0-1 8-9 - -

ER70 Fixo RAIZ ER63 - 0-1 - - -

ER71 DDD E ER70 N 0-1 2 - -

ER72 Numero E ER70 N 0-1 8-9 - -

ER73 FilialCNPJ E ER04 N 0-1 - - CNPJ da filial da transportadora, se necessário.

ER74 IdOperacaoCliente E ER04 S 1-1 - - Chave Primária da Operação de Transporte no sistema do cliente.

ER75 Impostos RAIZ ER04 - 1-1 - - -

ER76 DescricaoOutrosImpostos

E ER75 S 0-1 - - Descrição dos impostos com valor no campo OutrosImpostos.






37

ER77 INSS E ER75 M 1-1 - - Valor destinado ao INSS.


ER78 IRRF E ER75 M 1-1 - - Valor destinado ao IRRF.


ER79 ISSQN E ER75 M 1-1 - - Valor destinado ao ISSQN.


ER80 OutrosImpostos E ER75 M 0-1 - - Valor destinado a outros impostos não previstos.


ER81 SestSenat E ER75 M 1-1 - - Valor destinado ao SEST / SENAT.


ER82 MatrizCNPJ E ER04 S 1-1 - - CNPJ da Matriz da Transportadora.

ER83 Motorista RAIZ ER04 - 1-1 - - -

ER84 Celular RAIZ ER83 N 1-1 - - -

ER85 DDD E ER84 N 1-1 2 - DDD do celular do Motorista.

ER86 Numero E ER84 N 1-1 8-9 - Número do celular do Motorista.

ER87 CpfOuCnpj E ER83 N 1-1 11-14 - CPF ou CNPJ do Motorista.

ER88 Pagamentos E ER04 A 1-N - - Pagamentos registrados.

ER89 Cancelado RAIZ ER88 - 1-1 - - -

ER90 EstaCancelado E ER89 B 1-1 - - O campo sempre estará presente, é necessário buscar seu retorno.

True = está cancelado.

False = não está cancelado.

ER91 DataCancelamento E ER89 DT - - - Data do cancelamento.

ER92 Motivo E ER89 S - - - Motivo do cancelamento.

ER93 Solicitante E ER89 S - - - CPF do usuário que solicitou o cancelamento.

ER94 DataDeLiberacao E ER88 DT 1-1 - - Data em que o pagamento será liberado.






38

ER95 DataDeRegistro E ER88 DT 1-1 - - Data em que o pagamento foi registrado.

ER96 IdPagamentoCliente

E ER88 S 1-1 - Identificador do pagamento no sistema do cliente.

ER97 InformacaoAdicional

E ER88 S 0-1 - Informação adicional.

ER98 InformacoesBancarias

RAIZ ER88 - - - - Dados da instituição bancária que irá ser realizado o pagamento.

ER99 Agencia E ER98 S 1-1 - - Agência na qual o contratado possui conta com dígito.

ER100 Conta E ER98 S 1-1 - - Conta do contratado com dígito.

ER101 InstituicaoBancaria E ER98 S 1-1 - - Nome da instituição bancária que será realizado o pagamento.

ER102 Valor E ER88 M 1-1 - - Valor do pagamento.

ER103 PesoCarga E ER04 D 1-1 - N,5 Peso total da carga.

ER104 Subcontratante RAIZ ER04 - 0-1 - - -

ER105 CpfOuCnpj E ER104 N 0-1 11-14 - CPF ou CNPJ do Subcontratante.

ER106 EMail E ER104 S 0-1 - - Email do Subcontratante.

ER107 Endereco RAIZ ER104 - 0-1 - - Endereço do Subcontratante.

ER108 Bairro E ER107 S 0-1 - - Bairro do Subcontratante.

ER109 CEP E ER107 S 0-1 - - CEP do Subcontratante.


ER111 Rua E ER107 S 0-1 - - Rua e número do Subcontratante.


E ER104 S 1-1 - - Nome ou Razão Social do Subcontratante.



ER115 DDD R ER114 N 0-1 2 - -

ER116 Numero R ER114 N 0-1 8-9 - -

ER117 Fax RAIZ ER113 - 0-1 - - -

ER118 DDD E ER117 N 0-1 2 - -

ER119 Numero E ER117 N 0-1 8-9 - -

ER120 Fixo RAIZ ER113 - 0-1 - - -

ER121 DDD E ER120 N 0-1 2 - -






39

ER122 Numero E ER120 N 0-1 8-9 - -

ER123 TipoViagem E ER04 S 1-1 - - Restrito aos itens da enum:

-SemVinculoANTT

-Padrao

-TAC_Agregado

ER124 Transacao E ER04 N 1-1 - - Número incremental por transportadora.

ER125 Veiculos RAIZ ER04 - 1-5 - - Registro dos veículos participantes da operação de transporte.

ER126 Placa E ER125 S 1-1 7 - Placa do veículo conforme exemplo: AAA1234.

ER127 Viagens RAIZ ER04 - 1-N - - Array de viagens registradas. Na Operação Padrão será realizada apenas uma viagem.

No caso de Operação com TAC-Agregado são registradas todas as viagens realizadas.

ER128 CodigoMunicipioDestino

E ER127 N 1-1 7 - Código do Município de destino segundo IBGE.

ER129 CodigoMunicipioOrigem

E ER127 N 1-1 7 - Código do Município de origem segundo IBGE.

ER130 DocumentoViagem E ER127 S 1-1 - - Exemplo: CT-e / Serie, CTRC / Serie, Ordem de Serviço.

ER131 NotasFiscais RAIZ ER127 - 1-N - - Notas fiscais da viagem.

ER132 AbonoDeQuebra RAIZ ER131 - 0-1 - - -

ER133 Tipo E ER132 S 1-1 - - Restrito aos itens da enum:

-Nenhum

-Porcentagem

-ValorAbsoluto.

ER134 Valor E ER132 M 1-1 - - Valor do abono a ser aplicado.

ER135 CodigoNCMNaturezaCarga

E ER131 N 1-1 5 - Código da mercadoria de acordo com a tabela NCM

ER136 Data E ER131 DT 0-1 - - Data da nota fiscal

ER137 DataDesembarque E ER131 DT 0-1 - - Data do desembarque.

ER138 DescricaoDaMercadoria

E ER131 S 0-1 - - Descrição adicional ao código NCM.

ER139 Numero E ER131 S 1-1 - - Número da nota fiscal






40

ER140 QuantidadeDaMercadoriaNoDesembarque

E ER131 D 0-1 - - Quantidade da mercadoria no desembarque

ER141 QuantidadeDaMercadoriaNoEmbarque

E ER131 D 1-1 - - Quantidade da mercadoria no embarque

ER142 Serie E ER131 S 1-1 - - Série da nota fiscal

ER143 TipoDeCalculo E ER131 S 1-1 - - Restrito aos itens da enum:

-SemQuebra


-QuebraIntegral

ER144 ToleranciaDePerdaDeMercadoria

RAIZ ER131 - 1-1 - - Configuração da tolerância de perda de carga.

ER145 Tipo E ER144 S 1-1 - - Tipo de tolerância que será admitido para fretes com quebra.


-Nenhum

-Porcentagem

-ValorAbsoluto.

ER146 Valor E ER144 M 1-1 - - Valor da tolerância admitido.

ER147 UnidadeDeMedidaDaMercadoria

E ER131 S - - - Unidade de medida do produto transportado.


-Tonelada

-Kg

-MetrosCubicos

-Volume

ER148 ValorDaMercadoriaPorUnidade

E ER131 M - - - Valor da mercadoria por unidade

ER149 ValorDaQuebraDeFrete

E ER131 M - - - Valor da quebra do frete se existir

ER150 ValorDoFretePorUnidadeDeMercadoria

E ER131 M - - - Valor do frete por unidade de mercadoria, utilizado para cálculo da quebra.


ER151 ValorTotal E ER131 M - - - Valor total da nota fiscal

ER152 Valores RAIZ ER127 - 1-1 - - -






41

ER153 Combustivel E ER152 M 1-1 - - Valor destinado ao combustível. Este valor uma vez preenchido está contido dentro do valor informado para adiantamento.

ER154 JustificativaOutrosCreditos

E ER152 S 1-1 - - Justificativa para valor de outros créditos.

ER155 JustificativaOutrosDebitos

E ER152 S 1-1 - - Justificativa para valor de outros débitos.

ER156 OutrosCreditos E ER152 M 1-1 - - Valor livre.


ER157 OutrosDebitos E ER152 M 1-1 - - Valor livre.


ER158 Pedagio E ER152 M 1-1 - - Valor destinado ao pedágio.


ER159 Seguro E ER152 M 1-1 - - Valor destinado ao seguro.


ER160 TotalDeAdiantamento

E ER152 M 1-1 - - Valor total disponibilizado para adiantamento.

ER161 TotalDeQuitacao E ER152 M 1-1 - - Valor total disponibilizado para quitação.

ER162 TotalOperacao E ER152 M 1-1 - - Valor total da operação de transporte incluindo os créditos e débitos extras.

ER163 TotalViagem E ER152 M 1-1 - - Valor referente somente ao transporte.

ER164 Sucesso E ER01 S 1-1 - - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são: · True (sucesso na solicitação)

· False (erro na solicitação

ER165 Versao E ER01 N 1-1 1 - Versão = 1

2.5.4. Obter Operação de Transporte para Impressão

Busca e retorna uma Operação de Transporte para impressão.






42

2.5.4.1. Entrada

Estrutura XML com os dados para obter Operação de Transporte para impressão.


IP01 ObterOperacaoTransporteParaImpressaoRequest

RAIZ - - - - - -

IP02 CodigoIdentificacaoOperacao

E IP01 S 1-1 - - Código de identificação da Operação (CIOT).

IP03 DocumentoViagem E IP01 S 1-1 - - Exemplo: CT-e / Serie, CTRC / Serie, Ordem de Serviço.

IP04 Integrador E IP01 S 1-1 - - Hash de referência ao integrador.

IP05 Token E IP01 S 1-1 - - Token de autenticação do contratante.

IP06 Versao E IP01 N 1-1 1 - Versão = 1

2.5.4.2. Retorno



IR01 ObterOperacaoTransporteParaImpressaoResponse

RAIZ - - - - - -

IR02 Excecao RAIZ IR01 - 1-1 - - -

IR03 Mensagem E IR02 S 1-1 - - Mensagem de erro.


IR04 Html E IR01 S 1-1 - - Código HTML referente ao Documento de Transporte presente no CIOT informado.

IR05 Sucesso E IR01 B 1-1 - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são: · True (sucesso na solicitação) · False (erro na solicitação).

IR06 Versao E IR01 N 1-1 1 - Versão = 1

2.5.5. Adicionar Pagamento

Adiciona um registro para Pagamentos em uma Operação de Transporte.






43

2.5.5.1. Entrada

Estrutura XML com os dados adicionar Pagamento a uma Operação de Transporte.


FP01 AdicionarPagamentoRequest

RAIZ - - - - - -

FP02 CodigoIdentificacaoOperacao

E FP01 S 1-1 - - Código de identificação da Operação (CIOT).

FP03 Integrador E FP01 S 1-1 - - Hash de referência ao integrador.

FP04 Pagamentos RAIZ FP01 - 1-N - - -

FP05 Categoria E FP04 S 1-1 - - Categoria relacionada ao pagamento realizado. Restrita aos membros da ENUM:

-Adiantamento,

-Estadia,

Quitacao,

-SemCategoria

FP06 DataDeLiberacao E FP04 DT 1-1 - - Data em que o pagamento será liberado para saque.

FP07 Documento E FP04 S 1-1 - - Documento relacionado a viagem.

FP08 IdPagamentoCliente

E FP04 S 1-1 - - Identificador do pagamento no sistema do Cliente.

FP09 InformacaoAdicional

E FP04 S 0-1 - - Informação adicional caso o cliente precise registrar alguma observação.

FP10 InformacoesBancarias

RAIZ FP04 - - - - Dados da instituição bancária que irá ser realizado o pagamento.

FP11 Agencia E FP10 S 1-1 - - Agência na qual o contratado possui conta com dígito.

FP12 Conta E FP10 S 1-1 - - Conta do contratado com dígito.

FP13 InstituicaoBancaria E FP10 S 1-1 - - Nome da instituição bancária que será realizado o pagamento.

FP14 TipoPagamento E FP04 S 1-1 - - Tipo de pagamento que será usado pelo contratante.



-eFRETE






44

FP15 Valor E FP04 M 1-1 - - Valor do pagamento.

FP16 Token E FP01 S 1-1 - - Token de autenticação do contratante.

FP17 Versao E FP01 N 1-1 1 - Versão = 2

2.5.5.2. Retorno



FR01 AdicionarPagamentoResponse

RAIZ - - - - - -

FR02 CodigoIdentificacaoOperacao

E FR01 S 1-1 - - Código de identificação da Operação (CIOT).

FR03 Excecao RAIZ FR01 - - - - -

FR04 Mensagem E FR02 S 1-1 - - Mensagem de erro.


FR05 QuantidadeDePagamentos

E FR01 N 1-1 - - Quantidade de pagamentos adicionados.

FR06 Sucesso E FR01 B 1-1 - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são: · True (sucesso na solicitação) · False (erro na solicitação).

FR07 Versao E FR01 N 1-1 1 - Versão = 2

2.5.6. Cancelar Pagamento

Permite o cancelamento de um pagamento programado para uma operação de transporte.

O método CancelarPagamento não permite cancelamento de pagamentos com categoria Adiantamento ou Quitação. Para este caso, a Operação de Transporte deverá ser cancelada e outra deve ser gerada.

2.5.6.1. Entrada

Estrutura XML com os dados para cancelar um pagamento programado em uma operação de transporte.


NP01 CancelarPagamentoRequest

RAIZ - - - - - -






45

NP02 CodigoIdentificacaoOperacao

E NP01 S 1-1 - - Código de identificação da Operação (CIOT).

NP03 IdPagamentoCliente

E NP01 S 1-1 - - Identificador do pagamento no sistema do Cliente.

NP04 Integrador E NP01 S 1-1 - - Hash de referência ao integrador.

NP05 Motivo E NP01 S 1-1 - - Motivo do cancelamento da operação de transporte.

NP06 Token E NP01 S 1-1 - - Token de autenticação do contratante.

NP07 Versao E NP01 N 1-1 1 - Versão = 1

2.5.6.2. Retorno



NR01 CancelarPagamentoResponse

RAIZ - - - - - -

NR02 CodigoIdentificacaoOperacao

E NR01 S 1-1 - - Código de identificação da Operação (CIOT).

NR03 Excecao RAIZ NR01 S - - - -

NR04 Mensagem E NR03 S 1-1 - - Mensagem de erro.


NR05 IdPagamentoCliente

E NR01 S 1-1 - - Identificador do pagamento no sistema do Cliente.

NR06 Sucesso E NR01 B 1-1 - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:



NR7 Versao E NR01 N 1-1 1 - Versão = 1

2.5.7. Adicionar Viagem

Permite adicionar uma Viagem em uma Operação de Transporte existente, desde que a mesma não tenha ultrapassado o prazo do fim da viagem, esteja cancelada ou encerrada.

2.5.7.1. Entrada

Estrutura XML com os dados para adicionar uma viagem em uma operação de transporte existente.







46

HP01 AdicionarViagemRequest

RAIZ - - - - - -

HP02 CodigoIdentificacaoOperacao

E HP01 S 1-1 - - Código de identificação da Operação (CIOT).

HP03 Integrador E HP01 S 1-1 - - Hash de referência ao integrador.

HP04 Token E HP01 S 1-1 - - Token de autenticação do contratante.

HP05 Versao E HP01 N 1-1 1 - Versão = 2

HP06 Viagens RAIZ HP01 - - - - Viagens registradas.

HP07 CodigoMunicipioDestino

E HP06 N - 7 Código do Município de destino segundo IBGE.

HP08 CodigoMunicipioOrigem

E HP06 N - 7 Código do Município de origem segundo IBGE.

HP09 DocumentoViagem E HP06 S 1-1 - Exemplo: CT-e / Serie, CTRC / Serie, Ordem de Serviço.

HP10 NotasFiscais RAIZ HP06 - 1-N - - Notas fiscais da Viagem.

HP11 CodigoNCMNaturezaCarga

E HP10 N 1-1 4 - Código da mercadoria de acordo com a tabela NCM

HP12 Data E HP10 DT 0-1 - - Data da nota fiscal.

HP13 DescricaoDaMercadoria

E HP10 S 0-1 - - Descrição adicional ao código NCM.

HP14 Numero E HP10 S 1-1 - - Número da nota fiscal.

HP15 QuantidadeDaMercadoriaNoEmbarque

E HP10 D 1-1 - - Quantidade da mercadoria no embarque.

HP16 Serie E HP10 S 1-1 - - Série da nota fiscal.

HP17 TipoDeCalculo E HP10 S 1-1 - - Tipo de cálculo a ser efetuado para quebra de frete.


-SemQuebra


-QuebraIntegral.

HP18 ToleranciaDePerdaDeMercadoria

RAIZ HP10 - 1-1 - - Configuração da tolerância de perda de carga.

HP19 Tipo E HP18 S 1-1 - - Tipo de tolerância que será admitido para fretes com quebra.


-Nenhum

-Porcentagem

-ValorAbsoluto.

HP20 Valor E HP18 M 1-1 - - Valor da tolerância admitido.






47

HP21 UnidadeDeMedidaDaMercadoria

E HP14 S 1-1 - - Unidade de medida do produto.


-Tonelada;

-Kg;

-MetrosCubicos;

-Volume.

HP22 ValorDaMercadoriaPorUnidade

E HP14 M 1-1 - - Valor da mercadoria por unidade

HP23 ValorDoFretePorUnidadeDeMercadoria

E HP14 M 1-1 - - Valor do frete por unidade de mercadoria, utilizado para cálculo da quebra.


HP24 ValorTotal E HP14 M 1-1 - - Valor total da nota fiscal.

HP25 Valores RAIZ HP06 - 1-1 - - -

HP26 Combustivel E HP25 M 1-1 - - Valor destinado ao combustível. Este valor uma vez preenchido está contido dentro do valor informado para adiantamento.

HP27 JustificativaOutrosCreditos

E HP25 S 1-1 - - Justificativa para valor de outros créditos.

HP28 JustificativaOutrosDebitos

E HP25 S 1-1 - - Justificativa para valor de outros débitos.

HP29 OutrosCreditos E HP25 M 1-1 - - Valor livre.


HP30 OutrosDebitos E HP25 M 1-1 - - Valor livre.


HP31 Pedagio E HP25 M 1-1 - - Valor destinado ao pedágio.


HP32 Seguro E HP25 M 1-1 - - Valor destinado ao seguro.


HP33 TotalDeAdiantamento

E HP25 M 1-1 - - Valor total disponibilizado para adiantamento.






48

HP34 TotalDeQuitacao E HP25 M 1-1 - - Valor total disponibilizado para quitação.

HP35 TotalOperacao E HP25 M 1-1 - - Valor total da operação de transporte incluindo os créditos e débitos extras.

HP36 TotalViagem E HP25 M 1-1 - - Valor referente somente ao transporte.

HP37 Pagamentos RAIZ HP06 - 1-N - - Pagamentos registrados. - Pode existir mais de 1 pagamento com uma mesma categoria (exceto para Quitacao).


HP38 Categoria E HP37 S 1-1 - - Categoria relacionada ao pagamento realizado. Restrita aos membros da ENUM:

-Adiantamento,

-Estadia,

Quitacao,

-SemCategoria

HP39 DataDeLiberacao E HP37 DT 0-N - - Data em que o pagamento será liberado para saque.

HP40 Documento E HP37 S - - - Documento relacionado a viagem.

HP41 IdPagamentoCliente

E HP37 S 0-N - - Identificador do pagamento no sistema do Cliente.

HP42 InformacaoAdicional

E HP37 S 0-N - - Informação adicional caso o cliente precise registrar alguma observação.






49

HP43 InformacoesBancarias

RAIZ HP37 - - - - Dados da instituição bancária que irá ser realizado o pagamento.

HP44 Agencia E HP43 S 1-1 - - Agência na qual o contratado possui conta com dígito.

HP45 Conta E HP43 S 1-1 - - Conta do contratado com dígito.

HP46 InstituicaoBancaria E HP43 S 1-1 - - Nome da instituição bancária que será realizado o pagamento.

HP47 TipoPagamento E HP37 S 1-1 - - Tipo de pagamento que será usado pelo contratante.



-eFRETE

HP48 Valor E HP37 M 0-N - - Valor do pagamento.

2.5.7.2. Retorno



HR01 AdicionarViagemResponse

RAIZ - - - - - -

HR02 CodigoIdentificacaoOperacao

E HR01 S 1-1 - - Código de identificação da Operação (CIOT).

HR03 Excecao RAIZ HR01 S - - - -

HR04 Mensagem E HR03 S 1-1 - - Mensagem de erro.


HR05 QuantidadeDeViagens

E HR01 S 1-1 - - Quantidade de viagens da operação de transporte.

HR06 Sucesso E HR01 B 1-1 - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:



HR07 Versao E HR01 N 1-1 1 - Versão = 2

2.5.8. Abonar Quebra

Permite atualizar o abono de quebra de uma Operação de Transporte que ainda não foi realizado o Pagamento.






50

2.5.8.1. Entrada

Estrutura XML com os dados para abonar a quebra de uma operação de transporte.


JP01 AbonarQuebraDeFreteRequest

RAIZ - - - - - -

JP02 AbonoDeQuebra RAIZ JP01 - 1-1 - - -

JP03 Tipo E JP02 S 1-1 - - Restrito aos itens da enum:

-Nenhum

-Porcentagem

-ValorAbsoluto.

JP04 Valor E JP02 M 1-1 - - Valor do abono a ser aplicado.

JP05 AplicarEmTodasAsNotasFiscais

E JP01 B 1-1 - - Define se o abono aplicado deve ser tratado para todas as notas fiscais existentes.

JP06 CodigoIdentificacaoOperacao

E JP01 S 1-1 - - Código de identificação da Operação (CIOT).

JP07 DocumentoViagem E JP01 S 1-1 - - Exemplo: CT-e / Serie, CTRC / Serie, Ordem de Serviço.

JP08 Integrador E JP01 S 1-1 - - Hash de referência ao integrador.

JP09 NotasFiscais RAIZ JP01 - 1-N - - Notas fiscais da viagem.

JP10 Numero E JP09 S 1-1 - - Número da nota fiscal

JP11 Serie E JP09 S 1-1 - - Série da nota fiscal

JP12 Token E JP01 S 1-1 - - Token de autenticação do contratante.

JP13 Versao E JP01 N 1-1 1 - Versão = 1

2.5.8.2. Retorno



JR01 AbonarQuebraDeFreteResponse

RAIZ - - - - - -

JR02 CodigoIdentificacaoOperacao

E JR01 S 1-1 - - Código de identificação da Operação (CIOT).

JR03 DocumentoViagem E JR01 S 1-1 - - Exemplo: CT-e / Serie, CTRC / Serie, Ordem de Serviço.

JR04 Excecao RAIZ JR01 S - - - -

JR05 Mensagem E JR04 S 1-1 - - Mensagem de erro.







51

JR06 Sucesso E JR01 B 1-1 - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:



JR07 Versao E JR01 N 1-1 1 - Versão = 1

2.5.9. Cancelar Operação de Transporte

Permite que seja realizado o cancelamento de uma operação de transporte.

2.5.9.1. Entrada

Estrutura XML com os dados para cancelar uma operação de transporte.


KP01 CancelarOperacaoTransporteRequest

RAIZ - - - - - -






52

KP02 CodigoIdentificacaoOperacao

E KP01 S 1-1 - - Código de identificação da Operação (CIOT).

KP03 Integrador E KP01 S 1-1 - - Hash de referência ao integrador.

KP04 Motivo E KP01 S 1-1 - - Motivo do cancelamento da operação de transporte.

KP05 Token E KP01 S 1-1 - - Token de autenticação do contratante.

KP06 Versao E KP01 N 1-1 1 - Versão = 1

2.5.9.2. Retorno



KR01 CancelarOperacaoTransporteResponse

RAIZ - - - - - -

KR02 CodigoIdentificacaoOperacao

E KR01 S 1-1 - - Código de identificação da Operação (CIOT).

KR03 Data E KR01 DT 1-1 - - Data do cancelamento.

KR04 Excecao RAIZ KR01 S - - - -

KR05 Mensagem E KR04 S 1-1 - - Mensagem de erro.


KR06 Protocolo E KR01 S 1-1 - - Protocolo do cancelamento.

KR07 Sucesso E KR01 B 1-1 - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são: · True (sucesso na solicitação) · False (erro na solicitação).

KR08 Versao E KR01 N 1-1 1 - Versão = 1

2.5.10. Encerrar uma Operação de Transporte.

Permite encerrar uma operação de transporte existente que não esteja cancelada.

2.5.10.1. Entrada

Estrutura XML com os dados para encerrar uma operação de transporte.







53

QP01 EncerrarOperacaoTransporteRequest

RAIZ - - - - - -

QP02 CodigoIdentificacaoOperacao

E QP01 S 1-1 - - Código de identificação da Operação (CIOT).

QP03 Impostos RAIZ QP01 - 1-1 - - -

QP04 DescricaoOutrosImpostos

E QP03 S 0-1 - - Descrição dos impostos com valor no campo OutrosImpostos.

QP05 INSS E QP03 M 1-1 - - Valor destinado ao INSS.


QP06 IRRF E QP03 M 1-1 - - Valor destinado ao IRRF.


QP07 ISSQN E QP03 M 1-1 - - Valor destinado ao ISSQN.


QP08 OutrosImpostos E QP03 M 0-1 - - Valor destinado a outros impostos não previstos.


QP09 SestSenat E QP03 M 1-1 - - Valor destinado ao SEST / SENAT.


QP10 Integrador E QP01 S 1-1 - - Hash de referência ao integrador.

QP11 Token E QP01 S 1-1 - - Token de autenticação do contratante.

QP12 Versao E QP01 N 1-1 1 - Versão = 1.

QP13 Viagens RAIZ QP01 - - - - Viagens registradas.

QP14 CodigoMunicipioDestino

E QP13 N - 7 Código do Município de destino segundo IBGE.

QP15 CodigoMunicipioOrigem

E QP13 N - 7 Código do Município de origem segundo IBGE.






54

QP16 DocumentoViagem E QP13 S 1-1 - Exemplo: CT-e / Serie, CTRC / Serie, Ordem de Serviço.

QP21 NotasFiscais RAIZ QP13 - 1-N - - Notas fiscais da Viagem.

QP22 CodigoNCMNaturezaCarga

E QP21 N 1-1 4 - Código da mercadoria de acordo com a tabela NCM

QP23 Data E QP21 DT 0-1 - - Data da nota fiscal.

QP24 DescricaoDaMercadoria

E QP21 S 0-1 - - Descrição adicional ao código NCM.

QP25 Numero E QP21 S 1-1 - - Número da nota fiscal.

QP26 QuantidadeDaMercadoriaNoEmbarque

E QP21 D 1-1 - - Quantidade da mercadoria no embarque.

QP27 Serie E QP21 S 1-1 - - Série da nota fiscal.

QP28 TipoDeCalculo E QP21 S 1-1 - - Tipo de cálculo a ser efetuado para quebra de frete.


-SemQuebra


-QuebraIntegral.

QP29 ToleranciaDePerdaDeMercadoria

RAIZ QP21 - 1-1 - - Configuração da tolerância de perda de carga.

QP30 Tipo E QP29 S 1-1 - - Tipo de tolerância que será admitido para fretes com quebra.


-Nenhum

-Porcentagem

-ValorAbsoluto.

QP31 Valor E QP29 M 1-1 - - Valor da tolerância admitido.

QP32 UnidadeDeMedidaDaMercadoria

E QP21 S 1-1 - - Unidade de medida do produto.


-Tonelada;

-Kg;

-MetrosCubicos;

-Volume.






55

QP33 ValorDaMercadoriaPorUnidade

E QP21 M 1-1 - - Valor da mercadoria por unidade

QP34 ValorDoFretePorUnidadeDeMercadoria

E QP21 M 1-1 - - Valor do frete por unidade de mercadoria, utilizado para cálculo da quebra.


QP35 ValorTotal E QP21 M 1-1 - - Valor total da nota fiscal.

QP37 Valores RAIZ QP13 - 1-1 - - -

QP38 Combustivel E QP37 M 1-1 - - Valor destinado ao combustível. Este valor uma vez preenchido está contido dentro do valor informado para adiantamento.

QP39 JustificativaOutrosCreditos

E QP37 S 1-1 - - Justificativa para valor de outros créditos.

QP40 JustificativaOutrosDebitos

E QP37 S 1-1 - - Justificativa para valor de outros débitos.

QP41 OutrosCreditos E QP37 M 1-1 - - Valor livre.


QP42 OutrosDebitos E QP37 M 1-1 - - Valor livre.


QP43 Pedagio E QP37 M 1-1 - - Valor destinado ao pedágio.


QP44 Seguro E QP37 M 1-1 - - Valor destinado ao seguro.


QP45 TotalDeAdiantamento

E QP37 M 1-1 - - Valor total disponibilizado para adiantamento.

QP46 TotalDeQuitacao E QP37 M 1-1 - - Valor total disponibilizado para quitação.






56

QP47 TotalOperacao E QP37 M 1-1 - - Valor total da operação de transporte incluindo os créditos e débitos extras.

QP48 TotalViagem E QP37 M 1-1 - - Valor referente somente ao transporte.

QP49 Pagamentos RAIZ QP13 - 1-N - - Apenas deve ser utilizado

para fins de retificação

operação de transporte

gratuita.

Pagamentos registrados. - Pode existir mais de 1 pagamento com uma mesma categoria (exceto para Quitacao).


QP50 Categoria E QP14 S 1-1 - - Categoria relacionada ao pagamento realizado. Restrita aos membros da ENUM:

-Adiantamento,

-Estadia,

Quitacao,

-SemCategoria

QP51 DataDeLiberacao E QP14 DT 0-N - - Data em que o pagamento será liberado para saque.

QP52 Documento E QP14 S - - - Documento relacionado a viagem.

QP53 IdPagamentoCliente

E QP14 S 0-N - - Identificador do pagamento no sistema do Cliente.

QP54 InformacaoAdicional

E QP14 S 0-N - - Informação adicional caso o cliente precise registrar alguma observação.






57

QP55 InformacoesBancarias

RAIZ QP14 - - - - Dados da instituição bancária que irá ser realizado o pagamento.

QP56 Agencia E QP55 S 1-1 - - Agência na qual o contratado possui conta com dígito.

QP57 Conta E QP55 S 1-1 - - Conta do contratado com dígito.

QP58 InstituicaoBancaria E QP55 S 1-1 - - Nome da instituição bancária que será realizado o pagamento.

QP59 TipoPagamento E QP14 S 1-1 - - Tipo de pagamento que será usado pelo contratante.



-eFRETE

QP60 Valor E QP14 M 0-N - - Valor do pagamento.

2.5.10.2. Retorno



QR01 EncerrarOperacaoTransporteResponse

RAIZ - - - - - -

QR02 CodigoIdentificacaoOperacao

E QR01 S 1-1 - - Código de identificação da Operação (CIOT).

QR03 Excecao RAIZ QR01 S - - - -

QR04 Mensagem E QR04 S 1-1 - - Mensagem de erro.


QR05 Protocolo E QR01 S 1-1 - - Protocolo do cancelamento.

QR06 Sucesso E QR01 B 1-1 - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são:



QR07 Versao E QR01 N 1-1 1 - Versão = 1.






58

2.5.11. Retificar uma Operação de Transporte.

Permite retificar uma operação de transporte.






59

2.5.11.1. Entrada

Estrutura XML com os dados para retificar uma operação de transporte.


WP01 RetificarOperacaoTransporteRequest

RAIZ - - - - - -

WP02 CodigoIdentificacaoOperacao

E WP01 S 1-1 - - Código de identificação da Operação (CIOT).

WP03 CodigoMunicipioDestino

E WP01 N - 7 Código do Município de destino segundo IBGE.

WP04 CodigoMunicipioOrigem

E WP01 N - 7 Código do Município de origem segundo IBGE.

WP05 CodigoNCMNaturezaCarga

E WP01 N - 4 - Código da mercadoria de acordo com a tabela NCM

WP06 DataFimViagem E WP01 DT - - - Data de fim da Viagem.

WP07 DataInicioViagem E WP01 DT - - - Data de Inicio da Viagem, somente para Tipo de Operação Padrão.

WP08 Integrador E WP01 S 1-1 - - Hash de referência ao integrador.

WP09 PesoCarga E WP01 D - - N,5 Peso total da carga.

WP10 Token E WP01 S 1-1 - - Token de autenticação do contratante.

WP11 Veiculos RAIZ WP01 - - - - Registro dos veículos participantes da operação de transporte.

WP12 Placa E WP11 S - 7 - Placa do veículo conforme exemplo: AAA1234.

WP13 Versao E WP01 N 1-1 1 - Versão = 1

2.5.11.2. Retorno







60


WR01 RetificarOperacaoTransporteResponse

RAIZ - - - - - -

WR02 CodigoIdentificacaoOperacao

E WR01 S 1-1 - - Código de identificação da Operação (CIOT).

WR03 DataRetificacao E WR01 D 1-1 - - Data que ocorreu a retificação.

WR04 Excecao RAIZ WR01 S - - - -

WR05 Mensagem E WR04 S 1-1 - - Mensagem de erro.


WR06 Sucesso E WR01 B 1-1 - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são: · True (sucesso na solicitação) · False (erro na solicitação).

WR07 Versao E WR01 N 1-1 1 - Versão = 1

2.5.12. Obter Transações.

Permite obter as transações de frete realizadas em um período de tempo determinado.

Caso apenas a tag DataInicial seja informada o retorno compreenderá as transações realizadas no período de 1 dia, caso o contrário o período de transações abrangerá o período entre DataInicial e DataFinal, período esse com limite de 3 dias.

2.5.12.1. Entrada

Estrutura XML com os dados para obter as transações de frete.


ZP01 ObterTransacoesRequest

RAIZ - - - - - -

ZP02 DataInicial E ZP01 D 1-1 - - Data de início da lista de transações que é solicitada.

ZP03 DataFinal E ZP01 D 0-1 - - Data final da lista de transações que é solicitada, havendo um limite entre início e fim em um período de três (3) dias.






61

ZP04 MatrizCNPJ R ZP01 A 0-1 - - Caso a raiz não seja preenchida serão retornadas todas as empresas as quais a pessoa está ligada com permissão ativa.

ZP05 Long E ZP05 N 0-N - - Informar o CNPJ da empresa a qual se deseja obter as transações.

ZP06 Integrador E ZP01 S 1-1 - - Hash de referência ao integrador.

ZP07 Token E ZP01 S 1-1 - - Token de autenticação do contratante.

ZP08 Versao E ZP01 N 1-1 1 - Versão = 1

2.5.11.2. Retorno



ZR01 ObterTransacoesResponse

RAIZ - - - - - -

ZR02 Transacoes RAIZ ZR01 - 0-N - - Array de transações

ZR03 Id E ZR02 S 1-1 - - Id da transação

ZR04 TransportadoraCNPJ

E ZR02 N 1-1 - - CNPJ da transportadora referente às transações.

ZR05 CredenciadoCNPJ E ZR02 N 1-1 - - CNPJ do credenciado onde a transação foi realizada

ZR06 DataDeOperacao E ZR02 D 1-1 - - Data de realização da transação.

ZR07 CIOT E ZR02 S 1-1 - - Número do CIOT em que a transação foi realizada.

ZR08 DocumentoViagem E ZR02 S 1-1 - - Documento de viagem

ZR09 TransacaoDoCiot E ZR02 N 1-1 - - Número da transação (parcela) realizada dentro daquele CIOT.

ZR10 TipoDeCobranca E ZR02 S 1-1 - - Restrito aos membros da enum: - Adiantamento,

- Quitacao






62

ZR11 Status E ZR02 S 1-1 - - Restrito aos resultados:

- Ativo,

- Estornado

ZR12 NotasFiscais RAIZ ZR02 - 0-N - - Array de Notas Fiscais

ZR13 CodigoDaMercadoria

E ZR12 N 1-1 - - Código NCM da mercadoria

ZR14 DescricaoMercadoria

E ZR12 S 1-1 - - Descrição da mercadoria

ZR15 Data E ZR12 D 1-1 - - Data de emissão da nota fiscal

ZR16 Numero E ZR12 S 1-1 - - Número da nota fiscal

ZR17 Serie E ZR12 S 1-1 - - Série da nota fiscal

ZR18 QuantidadeDeSaida

E ZR12 N 1-1 - - Quantidade de saída da mercadoria

ZR19 QuantidadeDeChegada

E ZR12 N 1-1 - - Quantidade de chegada da mercadoria

ZR20 UnidadeDeMedidaDaQuantidade

E ZR12 S 1-1 - - Unidade de medida do produto

ZR21 ValorDaMercadoriaPorQuantidadeUnitaria

E ZR12 N 1-1 - - Valor unitário da mercadoria

ZR22 ValorDaQuebraDoFrete

E ZR12 M 1-1 - - Valor descontado referente a quebra do frete

ZR23 ValorPago E ZR02 M 1-1 - - Valor pago

ZR24 ValorEstadia E ZR02 M 1-1 - - Valor da estadia

ZR25 Excecao RAIZ ZR01 S - - - -

ZR26 Mensagem E ZR25 S 1-1 - - Mensagem de erro.


ZR27 Sucesso E ZR01 B 1-1 - Indicativo de sucesso na solicitação do serviço. Os valores para este campo são: · True (sucesso na solicitação) · False (erro na solicitação).

ZR28 Versao E ZR01 N 1-1 1 - Versão = 1

3. Apêndices






63

3.1. Legenda do Leiaute das Mensagens de Entrada e Retorno dos Serviços

Para facilitar a visualização dos subníveis dentro do XML foi utilizado o sombreamento em cinza dos campos, quanto mais escuro o tom, mais profundo será o subnível.

Para um melhor entendimento do leiaute das mensagens dos serviços do Pagamento Eletrônico de Frete, estão descritas a seguir algumas informações importantes.

3.2. Abreviações Utilizadas no Cabeçalho dos Leiautes

# Campo Elem Pai Tipo

Ocor Tam Dec Descrição/Observação

AP01 CampoRaiz RAIZ - - 1-1 - - -

AP02 Campo E AP01 S 1-1 - - -

a) coluna #: Código identificador do campo. Este código é único por serviço, e identifica o campo correto quando o mesmo é referenciado por alguma outra coluna do leiaute.

b) coluna Campo: Identificador do nome do campo. Este nome é o mesmo nome que deve ser passado como uma tag do XML.

c) coluna Elemento (Elem): Identifica o tipo do elemento que o campo corresponde no XML. Os valores possíveis são:

Raiz – quando um campo é a raiz do XML. Os campos do tipo Raiz não possuem valores, apenas outros elementos;

A – quando um campo representa um atributo do campo anterior;

E – quando um campo representa um elemento.

d) coluna Pai: Identifica o campo raiz ao qual o campo de valor pertence. Essa identificação se dá pelo Código identificador do campo.

e) coluna Tipo: Identifica o tipo do dado do valor que deve ser passado no XML. Os valores possíveis para esta coluna são:

Abreviação Descrição Limite ou Exemplo

N Numérico inteiro Até 15 Dígitos

S String Até 255 caracteres

DT DateTime Exemplo: 2011-12-31 00:00:00

B Boolean True or False

M Valor monetário Dados correspondentes a um valor monetário. Ex: N,00

A Array de bytes -






64

f) coluna Ocorrências (Ocor): Identifica, através de dois dígitos separados por um hífen, a obrigatoriedade do campo e o número de vezes que o mesmo pode aparecer no XML. O primeiro número representa o número mínimo de ocorrências do campo no leiaute, enquanto o segundo número representa o número máximo de ocorrências do campo no leiaute. Com isso, quando temos o exemplo 1-1, significa que a tag no XML correspondente ao campo do leiaute é obrigatória e deve aparecer apenas uma vez. Caso o primeiro dígito seja “0” (zero), indica que o campo é opcional.

Caso o segundo dígito seja N, significa que ele não possui um número máximo de ocorrências, podendo ser passado no XML uma lista de tags que representam o campo.

g) coluna Tamanho (Tam): Identifica, através de um dígito ou dois dígitos separados por um hífen, o tamanho máximo e mínimo do valor da tag no XML correspondente ao campo do leiaute. Quando o valor da coluna é de apenas um dígito, significa que o tamanho deste campo é fixo. Quando o segundo dígito é representado por um N, significa que não há um tamanho máximo para o valor passado na tag XML. Esta coluna está presente apenas nos campos do tipo S e N.

h) coluna Decimal (Dec): Identifica, através de dois dígitos separados por uma vírgula, o tamanho da parte inteira e da parte decimal de um campo do tipo N (quando este representar um número decimal). O número antes da vírgula representa o número máximo de dígitos da parte inteira, enquanto o número após a vírgula representa o número obrigatório de dígitos da parte decimal.

i) coluna Descrição/Observação: Fornece uma breve descrição do campo do leiaute ou alguma observação importante que deve ser informada.

3.3. Tratamento de Caracteres Especiais no Texto de XML

Todos os textos de um documento XML passam por uma análise do “parser” específico da linguagem. Alguns caracteres afetam o funcionamento deste “parser”, não podendo aparecer no texto de uma forma não controlada.

Os caracteres que afetam o “parser” são:

• > (sinal de maior),

• < (sinal de menor),

• & (e-comercial),

• “ (aspas),

• ‘ (sinal de apóstrofe).

Alguns destes caracteres podem aparecer em alguns campos. Para resolver o problema, é recomendável o uso de uma seqüência de “escape” em substituição ao respectivo caractere.

Ex. Um transportador de razão social EMPRESA DE TRANPORTE & CARGAS LTDA deve ser informado como: EMPRESA DE TRANPORTE & CARGAS LTDA no XML para não afetar o funcionamento do “parser”.

Caractere Sequência de “escape”

> <

< >






65

& &

“ "

‘ '

Documents

Manual Técnico de Integração - WebServicewebsaf.intersite.com.br/wiki/images/2/29/Layout_eFrete_V2.1.pdf · A IPC Administração Ltda. manterá este Manual atualizado, nos termos