Sistema Pamcard - Especificação Integração - Contrato de Frete

Sistema Pamcard - Contrato de Frete Especificao de Integrao

Contrato de Frete

Proprietrio: GEPAP Pg. 2

Classificao da Informao: Pblico

Toda forma impressa deste documento no tem validade em processos de auditoria

"O presente documento de propriedade da Roadcard Solues Integradas em Meios de Pagamentos S.A e est protegido pelas leis brasileiras, sendo vedada sua reproduo, disponibilizao ou qualquer forma de cesso, total ou parcialmente a qualquer pessoa, entidade, associao, organizao, empresa, etc, sob pena de serem adotadas as medidas judiciais protetivas, bem como visando o ressarcimento da parte prejudicada."

Histrico das Revises

Controle de Verses Verso Autor Atualizao Realizada Data

1.0 Miriam Alborghetti Verso Inicial 09/09/2011 1.1 Miriam Alborghetti Ajustes Tabelas e descries 09/09/2011 1.2 Millene Gama Ajustes nas descries 19/09/2011 1.3 Millene Gama Incluso da funcionalidade de cancelamento 26/09/2011 1.4 Jennifer Cavalheiro Ajustes descries e exemplos 28/09/2011 1.5 Jennifer Cavalheiro Ajustes descries e exemplos 04/10/2011 1.6 Jennifer Cavalheiro Incluso de novas operaes 24/11/2011 1.7 Miriam Alborghetti Incluso novos campos Contrato de Frete 25/11/2011 1.8 Jennifer Cavalheiro Ajustes descries, exemplos e tabelas 25/11/2011 1.9 Jennifer Cavalheiro Alteraao do context da funcionalidade Atualizar Valores Contrato de Frete para UpdateFreightContractValues

02/12/2011

2.0 Millene Gama Ajuste de observaes e parmetros 06/12/2011 2.1 Miriam Alborghetti Reviso Contratado x Motorista

Nova Operao Inserir Remetente/Destinatrio 09/12/2011

2.2 Millene Gama Ajuste na retificao do contrato de frete 12/12/2011 2.3 Jennifer Cavalheiro Novo Layout da especificao 13/02/2012 2.4 Jennifer Cavalheiro Atualizao do tamanho do campo id.viagem do retorno do

contrato de frete 24/02/2012

2.5 Jennifer Cavalheiro Atualizao do apndice: Adaptador 27/02/2012 2.6 Jennifer Cavalheiro Atualizao referente aos projetos de integrao do BB e

PJ Bradesco 12/03/2012

2.7 Jennifer Cavalheiro Atualizao da tabela 14 e observaes do contrato de frete 02/04/2012 2.8 Jennifer Cavalheiro Atualizao da tabela 14 e observaes da incluso do

favorecido 04/04/2012

2.8.1 Jennifer Cavalheiro Incluso da tabela 30 e alterao do campo do peso do documento

11/04/2012

2.9 Miriam Alborghetti Adequao de regras de acordo com o Manual de Integrao ANTT verso 2.0

23/04/2012

2.9.1 Miriam Alborghetti Correo Observaes solicitadas pela Roadcard 26/04/2012 2.9.2 Jennifer Cavalheiro Correo Observaes solicitadas pela Roadcard 02/05/2012 2.9.3 Miriam Alborghetti Incluso campos Carto PJ 03/05/2012 2.9.4 Jennifer Cavalheiro Atualizao do Layout do relatrio 20/08/2012 2.9.5 Miriam Alborghetti Incluso RNTRC Carto PJ 22/05/2012 2.9.6 Jennifer Cavalheiro Correo de Observaes e Tabelas solicitadas pela

Roadcard 31/05/2012

2.9.7 Jennifer Cavalheiro Atualizao de acordo com o projeto DE_Pamcard_2012_177_Melhorias_Conta_Deposito_Fase1

03/09/2012

2.9.8 Miriam Alborghetti Incluso Obs 4 e 5 na funo Consultar Favorecido 05/10/2012 3.0 Miriam Alborghetti Ajustes DE_PAMCARD_2012_084_Integrao_

APPI_Quitao_Prpria 24/09/2012

3.1 Carla A N Cirilo Incluso das alteraes do projeto DE_Pamcard_2012_177_Melhorias_Conta_Deposito_Fase1

28/11/2012




3.2 Jennifer Cavalheiro Alteraes do projeto DE_Pamcard_2012_178_Melhorias_Conta_Deposito_Fase2

08/01/2013

3.3 Jennifer Cavalheiro Alteraes do projeto DE_Pamcard_2013_014 28/03/2013 3.4 Jennifer Cavalheiro Alteraes do projeto DE_Pamcard_2013_116 10/06/2013 3.5 Jennifer Cavalheiro Incluso de dados na tabela 37 e Reordenao dos campos

do contrato de frete 26/06/2013

4.0 Jennifer cavalheiro Alteraes do projeto DE_PAMCARD_2013_022 Informaes de pedgio eletrnico.

11/09/2013

4.1 Jennifer Cavalheiro Alteraes do Projeto DE_PAMCARD_2014_071 Incluso das operaes:

InsertRoute

UpdateDeliveryAddress

SearchDeliveryAddress

08/04/2014




ndice

Histrico das Revises 2

ndice 4

Introduo 6

Definies e Abreviaes 6

Segurana da Informao 7

Requisitos 8

Requisitos Tcnicos para utilizao do Adaptador 8 Requisitos de Comunicao 8 Suporte Operacional 8

Arquitetura 9

Opes de Integrao 10

WebService 10 Adaptador 10 Arquivo de Retorno para Download 11

Funcionalidades 12

Consultar Carto 14 Consultar Favorecido 15 Consultar RNTRC 16 Consultar Frota 18 Roteirizar 20 Consultar Conta 23 Incluir Carto Portador Frete 24 Incluir Favorecido 27 Incluir Conta 29 Inserir Rota 31 Inserir Remetente / Destinatrio 32 Alterar Remetente / Destinatrio 33 Consultar Remetente / Destinatrio 34 Incluir Contrato Frete 35 Consultar Status da Parcela 46 Consultar Contrato de Frete 48 Alterar Status da Parcela 52 Consultar Status do Pedgio 56 Alterar Status do Pedgio 57 Cancelar Viagem / Contrato de Frete 58 Alterar Contrato de Frete 60 Atualizar Valores Contrato de Frete 64 Encerrar Contrato de Frete 66

Apndices 69

Certificados Digitais 69 Exemplos 69




Apndices 79

WSDL Erro! Indicador no definido. Exemplos Erro! Indicador no definido.

Apndices 81

Adaptador Erro! Indicador no definido. Instalao Erro! Indicador no definido. Estrutura de Diretrios (verso windows) Erro! Indicador no definido. Gerao do Arquivo Erro! Indicador no definido. Configurao Erro! Indicador no definido.

Apndices - Tabelas 87

1. Tipo de Documento da Viagem 87 2. Tipo de Documento 87 3. Soluo de Pedgio 87 4. Tipo do Carto 87 5. Tipo da Parcela 87 6. -- 87 7. Tipos Documento Complementar 88 8. Tipo de Efetivao 88 9. Status da Parcela 88 10. Status do Pedgio 88 11. Status da Viagem 88 12. Tipo de Transacao 88 13. Status do Carto Pamcard 89 14. Status da Transao 89 15. Tipo Favorecido 89 16. Status do Documento 89 17. Status da Conta do Favorecido 89 18. Tipo Item de Frete 89 19. Tipo da Conta do Favorecido 89 20. Tipo do Meio de Pagamento 89 21. Tipo de Pessoa Fiscal 89 22. -- 89 23. Categorias do Veculo 90 24. Cdigos e Mensagens de Retorno 90 25. Emissor do RG 90 26. Nacionalidade 90 27. Sexo 91 28. Tipo de Propriedade 91 29. Operadora do Celular 91 30. Status do Pedido da Transao 91 31. Origem do Pagamento da Quitao 91 32. Situao da Quitao 91 33. Motivo da Situao da Quitao 91 34. Pefil da Carga 91 35. Erro da Transao 92 36. Etapas da Quitao 92 37. Tipo de Desconto 92 38. Caminho 92

Apndices 93

Referncias 93

Apndices 94

Lay-Out Arquivo de Conciliao (Download) Erro! Indicador no definido.




Introduo

Este documento destinado a profissionais da rea de TI e tem como objetivo detalhar as formas para realizar a integrao com o Sistema Pamcard Contrato de Frete. O Sistema Pamcard tem como objetivo agilizar o processo de pagamentos de pedgios, fretes, dirias e combustveis aos caminhoneiros fornecendo de forma eficaz um meio eletrnico e seguro para as empresas que realizam transportes rodovirio de cargas.

Definies e Abreviaes

HTTPS: Hipertext Transfer Protocol Secure IDE: Integrated Development Environment RPC: Remote Procedure Call SOAP: Simple Object Access Protocol SSL: Secure Socket Layer WSDL: Web Service Definition Language XML: Extend Markup Language BIN: Bank Identification Number (So os 6 primeiros nmeros do Carto VISA) BBBB BB99 9999 9999




Segurana da Informao Para garantir a confidencialidade, integridade e disponibilidade da informao, todas as integraes de clientes/parceiros com o sistema Pamcard, devero possuir comunicao segura implementando autenticao/autorizao. As integraes so por meio de Web Services e esperado que o leitor esteja familiarizado com alguns conceitos como por exemplo Certificado Digital, HTTP, Servidores Web/Aplicao e linguagens de programao como Java e .NET. O Sistema Pamcard utiliza como chave de identificao, o CNPJ do contratante que extrado do certificado apresentado na integrao. Portanto, fundamental que contratante seja o proprietrio do certificado em questo. Para o processo de integrao com o sistema Pamcard necessrio que o cliente informe o seu certificado para os nossos servidores Web, que por sua vez, faro algumas verificaes em determinados atributos do certificado, validando sua autenticidade, orgo emissor e etc.. Aps a validao do certificado digital, a requisio ao Web Service encaminhada para o servidor de aplicao onde ocorrer a autorizao ou no do cliente. A figura abaixo ilustra o processo de transporte da requisio ao sair do cliente at chegar ao servidor de aplicao




Requisitos

Requisitos Tcnicos para utilizao do Adaptador

Para a utilizao do mdulo de integrao do sistema Pamcard o computador a ser utilizado dever possuir:

o Windows acima de 2000 o Acesso liberado para a internet o Java Virtual Machine instalado (qualquer verso acima de jre-1_6)

Caso necessrio o Java Virtual Machine poder ser baixado atravs do site www.java.com, sem custo de licenciamento.

Requisitos de Comunicao

A comunicao entre cliente e servidor ser feita atravs do SOAP (Simple Object Access Protocol). Esse protocolo definido em XML. Para transporte das mensagens ser usado o HTTPS. O acesso ao servidor que hospeda Web Service Pamcard se dar por acesso internet. O cliente dever possuir um certificado ICP-BRASIL e um usurio correspondente no Sistema Pamcard com perfil especfico para realizar as transaes. Este usurio somente poder ser utilizado nestas transaes, no sendo permitido a este usurio acessar o sistema na Web.

Suporte Operacional Caber a equipe de Operaes Pamcard:

cadastrar a empresa no ambiente de homologao, encaminhar login e senha de acesso de homologao, fornecer dados vlidos de homologao (cartes, CPF, RNTRC, placas, etc), prestar suporte via telefone /e-mail a possveis dvidas aps leitura da documentao de

Integrao pelo desenvolvedor (em dias teis, dentro do horrio comercial).

Quando necessrio o cadastramento de unidades (filiais) para realizao de testes, comunique a equipe de Operaes para suporte no cadastramento. O desenvolvimento da integrao de responsabilidade do cliente, atravs de sua rea de Tecnologia ou contrato com um desenvolvedor externo. Ao trmino do desenvolvimento, recomendamos a realizao de diversos testes das funcionalidades utilizadas (ex. Roteirizao, incluso de viagem, contrato de frete, etc.). Nestes testes importante o mximo de simulaes possveis, que reflitam o dia a dia da operao da empresa. IMPORTANTE: todos os dados informados e trafegados nesse ambiente, sero fictcios, no haver transao bancria.




Arquitetura




Opes de Integrao

WebService

Este modelo de integrao foi desenvolvido especialmente para se integrar aos sistemas dos nossos clientes, visando a disponibilizao da informao em tempo real, eliminando retrabalho e permitindo um processo de uso fcil pelos operadores.

Todo web services documentado atravs de um WSDL (Web Service Definition Language) que descreve todos os servios, seus parmetros de entrada e sada, e at mesmo a estrutura de dados destes parmetros, caso esta seja complexa. O documento WSDL deve ser utilizado pelos desenvolvedores das aplicaes que consomem os web services para a gerao do cliente de comunicao atravs de uma IDE apropriada. Uma IDE ir produzir cdigo que implemente a comunicao de rede para invocao dos servios. A estrutura do WSPamcard.wsdl est disponvel no apndice deste documento

Adaptador A comunicao entre o Sistema do Cliente e o Web Service Pamcard poder tambm ser realizada atravs de um componente Adaptador, por meio de arquivos, ou seja, para cada funcionalidade disponvel no Web Service Pamcard haver um arquivo texto parametrizado correspondente com os dados de entrada e, aps o processamento, ser retornado um arquivo texto parametrizado de mesmo nome do arquivo de entrada com o contedo de resposta solicitao.

Para mais detalhes da instalao, configurao e utilizao deste mdulo, veja as instrues do Adaptador no apndice deste documento.




Arquivo de Retorno para Download

O Arquivo de Transaes, disponibilizado diariamente para download, somente atravs do Site do Sistema Pamcard. Cada arquivo, contm as transaes efetivadas do dia anterior, compactadas e em formato de texto. Com esse arquivo possvel realizar conciliao bancria das transaes realizadas no Sistema Pamcard e debitadas no banco. Cada arquivo possui uma nomenclatura padro. Exemplo: MT111031.zip = MTAAMMDD.zip O layout deste arquivo est detalhado no apndice deste documento.




Funcionalidades

O Sistema Pamcard permite realizar as seguintes transaes via integrao:

Operao Funo Cdigo

Cancelamento de Viagem/Contrato CancelTrip 4

Pagamento de Parcela PayParcel 6

Consultar Status de Parcela FindParcelStatus 7

Atualizar Status de Parcela UpdateParcelStatus 8

Consultar Status do Pedgio FindTollStatus 9

Atualizar Status do Pedgio UpdateTollStatus 10

Roteirizao Router 11

Consulta de Carto FindCard 12

Incluir Carto Portador Frete InsertCardFreight 21

Consultar Favorecido FindFavored 22

Inserir Favorecido InsertFavored 23

Consultar Conta Favorecido FindFavoredAccount 24

Inserir Conta Favorecido InsertFavoredAccount 25

Inserir Contrato Frete InsertFreightContract 26

Consultar Contrato de Frete FindFreightContract 27

Consultar RNTRC FindRNTRC 28

Consultar Frota FindFleet 29

Alterar Contrato de Frete UpdateFreightContract 30

Atualizar Valores Contrato de Frete UpdateValuesFreightContract 31

Inserir Remetente/Destinatrio InsertDeliveryAddress 32

Encerrar Contrato de Frete CloseFreightContract 33

Inserir Rota InsertRoute 34

Alterar Remetente / Destinatrio UpdateDeliveryAddress 39

Consultar Remetente / Destinatrio SearchDeliveryAddress 40

A tabela acima especifica as operaes, as funes disponibilizadas no Web Service e respectivos cdigos de operaes do Adaptador.




Fluxo (sugerido) de Integrao Incluso de Contrato de Frete: Abaixo indicamos uma sugesto com os servios disponveis no Sistema Pamcard para que a empresa possa desenvolve-los de acordo com sua operao. Cabe ressaltar que cada empresa deve identificar os momentos de integrao com seu sistema de gesto para cada funcionalidade.

Aes Funcionalidades Observaes Cdigo

Consultas pr contrato

Consulta de Carto 12 Consultar Favorecido 22 Consultar RNTRC 28 Consultar Frota 29 Roteirizao 11 Consultar Conta Favorecido 24

Cadastro

Incluir Carto Portador Frete 21 Inserir Favorecido 23 Inserir Conta Favorecido 25 Inserir Rota 34 Inserir Remetente/Destinatrio 32 Alterar Remetente / Destinatrio 39

Consultar Remetente / Destinatrio 40

Contrato (gerao CIOT) Inserir Contrato Frete

Nessa funcionalidade, possvel:Incluir favorecidos (conta ou carto), incluir remetente/destinatrio e inserir parcelas para pagamento automtico.

26

Consultas ps contrato

Consultar Status de Parcela 7 Consultar Status do Pedgio 9 Consultar Contrato de Frete 27

Formas de Pagamento

Atualizar Status de Parcela 8 Pagamento de Parcela 6 Atualizar Status do Pedgio 10

Alteraes

Cancelamento de Viagem/Contrato 4

Alterar Contrato de Frete 30 Atualizar Valores Contrato de Frete 31

Encerrar Contrato de Frete 33




Consultar Carto

Operao que permite a consulta do status de um carto no Sistema Pamcard. Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno:

Parmetros de Entrada

Parmetro Tipo Valor

context alfanumrico Fixo=FindCard

fields array

Campos de Entrada

VIAGEM

Descrio Tipo Tam Observao

1 viagem.contratante.documento.numero alfanumrico 20 Obrigatrio

2 viagem.unidade.documento.tipo numrico 2 Ver Tabela 2 Obs 2

3 viagem.unidade.documento.numero alfanumrico 20 Obs 2

4 viagem.cartao.numero Numrico 16 Obrigatrio. Obs3

Observaes: 1. O cliente dever sempre informar o CNPJ da Contratante; 2. As chaves viagem.unidade.documento.tipo e viagem.unidade.documento.numero, sero

obrigatrias apenas quando a autenticao for realizada por uma filial. Se a empresa que estiver realizando a autenticao for uma contratante, ser obrigatrio apenas a chave viagem.contratante.documento.numero .

3. Se for informado um carto do tipo VALE-PEDGIO, no existente no banco de dados do Pamcard, este ser includo nesse banco e nas prximas consultas apresentar o ultimo portador vinculado ao carto.

ATENO: Para garantir que no haja envio de informaes incompletas para processamento, seguir as instrues de gerao de arquivo nas instrues do Adaptador no apndice deste documento.

Campos de Retorno

RETORNO


1 mensagem.codigo numrico 2 Ver Tabela 24

2 mensagem.descricao alfanumrico 500

3 viagem.cartao.portador.documento.numero alfanumrico 11

4 viagem.cartao.portador.documento.tipo numrico 2 Ver Tabela 2

5 viagem.cartao.portador.nome Alfanumrico 20

6 viagem.cartao.status.descricao Alfanumrico 20

7 viagem.cartao.status.id Numrico 2 Ver Tabela 13

8 viagem.cartao.tipo Numrico 2 Ver Tabela 4

Exemplo

Exemplo Arquivo Envio (IN):




transacional.operacao=12 viagem.contratante.documento.numero=27064195000190 #viagem.unidade.documento.tipo=1 #viagem.unidade.documento.numero=27064195000270 viagem.cartao.numero=4417810025749012

Exemplo Arquivo Retorno (OUT):

mensagem.codigo=0 mensagem.descricao= Operao realizada com sucesso viagem.cartao.portador.documento.numero=29693909810 viagem.cartao.portador.documento.tipo=2 viagem.cartao.portador.nome=jennifer teste viagem.cartao.status.descricao=LIBERADO viagem.cartao.status.id=1

Consultar Favorecido Operao que permite Consultar Favorecido no Sistema Pamcard. Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno: Parmetros de Entrada

Parmetro Tipo Valor

context alfanumrico Fixo=FindFavored

fields array

Campos de Entrada

VIAGEM





4 viagem.favorecido.documento.tipo Numrico 2 Obrigatrio Ver Tabela 2 Obs 3

5 viagem.favorecido.documento.numero Alfanumrico 20 Obrigatrio

Observaes:

1. O cliente dever sempre informar o CNPJ da Contratante; 2. As chaves viagem.unidade.documento.tipo e viagem.unidade.documento.numero, sero obrigatrias

apenas quando a autenticao for realizada por uma filial. Se a empresa que estiver realizando a autenticao for uma contratante, ser obrigatrio apenas a chave viagem.contratante.documento.numero.

3. Ser permitida a consulta somente com os seguintes documentos: os tipos 1 (CNPJ) e 6 (RNTRC) para Pessoa Jurdica; ou 2 (CPF) e 5 (RNTRC) para Pessoa Fsica.

4. O sistema retornar a situao do RNTRC no cadastro do favorecido consultado (viagem.favorecido.status.rntrc = ativo ou inativo).

5. Caso o favorecido no possua RNTRC em seu cadastro, retornar viagem.favorecido.rntrc.cadastro=nao cadastrado.





Campos de Retorno

RETORNO




3 viagem.favorecido.cartao. qtde Numrico 2

4 viagem.favorecido.cartaoN.numero Numrico 16

5 viagem.favorecido.cartaoN.tipo Alfanumrico 2 Ver Tabela 4

6 viagem.favorecido.cartaoN.status Alfanumrico 20 Ver Tabela 13

7 viagem.favorecido.conta.qtde Numrico 2

8 viagem.favorecido.contaN.banco Numrico 4

9 viagem.favorecido.contaN.agencia Alfanumrico 10

10 viagem.favorecido.contaN.agencia.digito Alfanumrico 1

11 viagem.favorecido.contaN.numero Alfanumrico 10

12 viagem.favorecido.contaN.tipo Alfanumrico 10

13 viagem.favorecido.contaN.status Alfanumrico 20 Ver Tabela 17

14 viagem.favorecido.nome Alfanumrico 60

15 viagem.favorecido.status.rntrc Alfanumrico 20

16 viagem.favorecido.rntrc.cadastro Alfanumrico 20 Obs 5

Exemplo


transacional.operacao=22 viagem.contratante.documento.numero=00001001000312 viagem.favorecido.documento.tipo=2 viagem.favorecido.documento.numero=11475596006


mensagem.codigo=0 mensagem.descricao= Operao realizada com sucesso viagem.favorecido.cartao.qtde=1 viagem.favorecido.cartao1.numero=0094162014 viagem.favorecido.cartao1.tipo=Portador Frete viagem.favorecido.cartao1status=CARTAO ATIVO viagem.favorecido.conta.qtde=0 viagem.favorecido.nome=Andre com rntrc viagem.favorecido.status.rntrc=Ativo

Consultar RNTRC

Operao que permite a consulta de um RNTRC na ANTT atravs do Sistema Pamcard. Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno:





Parmetro Tipo Valor

context alfanumrico Fixo= FindRNTRC Fields array

Campos de Entrada

VIAGEM





4 viagem.favorecido.documento.qtde Numrico 1 Fixo=2

5 viagem.favorecido.documentoN.tipo Numrico 2 Obrigatrio Obs. 3

6 viagem.favorecido.documentoN.numero Alfanumrico 20 obrigatrio

Observaes:

1. O cliente dever sempre informar o CNPJ da Contratante; 2. As chaves viagem.unidade.documento.tipo e viagem.unidade.documento.numero, sero

obrigatrias apenas quando a autenticao for realizada por uma filial. Se a empresa que estiver realizando a autenticao for uma contratante, ser obrigatrio apenas a chave viagem.contratante.documento.numero.

3. Devero ser informados obrigatoriamente os tipos 1(CNPJ) e 6 (RNTRC) para Pessoa Jurdica ou 2(CPF) e 5(RNTRC) para Pessoa Fsica.


Campos de Retorno

RETORNO




3 viagem.antt.nome Alfanumrico 200

4 viagem.antt.rntrc.situacao Alfanumrico 20

5 viagem.antt.rntrc.validade Data 10 dd/mm/aaaa

6 viagem.antt.rntrc.tipo Alfanumrico 3 Obs.: 3

7 viagem.antt.rntrc.equiparado.tac Alfanumrico 1 (S ou N)

Exemplo


transacional.operacao=28




viagem.contratante.documento.numero=00001001000312 #viagem.unidade.documento.tipo=1 #viagem.unidade.documento.numero=00001001000312 viagem.favorecido.documento.qtde=2 # Dados de PF [2-CPF 5-rntrcPF ] viagem.favorecido.documento1.tipo=2 viagem.favorecido.documento1.numero=27269448841 viagem.favorecido.documento2.tipo=5 viagem.favorecido.documento2.numero=00169192


mensagem.codigo=0 mensagem.descricao= Operao realizada com sucesso viagem.antt.nome=ANDR FERNANDO CARDOSO viagem.antt.rntrc.equiparado.tac=SIM viagem.antt.rntrc.situacao=Ativo viagem.antt.rntrc.tipo=TAC viagem.antt.rntrc.validade=27/04/2015

Consultar Frota

Operao que permite a consulta de um RNTRC na ANTT atravs do Sistema Pamcard. Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno:


Parmetro Tipo Valor

context alfanumrico Fixo= FindFleet Fields array

Campos de Entrada

VIAGEM





4 viagem.favorecido.documento.qtde Numrico 1 obrigatrio



7 viagem.veiculo.qtde Numrico 1 Max. 5 ocorrncias

8 viagem.veiculoN.placa Alfanumrico 7 Obrigatrio Obs 4

Observaes: 1. O cliente dever sempre informar o CNPJ da Contratante; 2. As chaves viagem.unidade.documento.tipo e viagem.unidade.documento.numero, sero

obrigatrias apenas quando a autenticao for realizada por uma filial. Se a empresa que estiver realizando a autenticao for uma contratante, ser obrigatrio apenas a chave viagem.contratante.documento.numero;




3. Devero ser informados obrigatoriamente os tipos 1(CNPJ) e 6 (RNTRC) para Pessoa Jurdica ou 2(CPF) e 5(RNTRC) para Pessoa Fsica;

4. As placas devem ser preenchidas no formato AAA9999; 5. O campo viagem.veiculoN.situacao retorna se o veculo pertence ao Transportador. S=Pertence

e N=No Pertence.


Campos de Retorno

RETORNO




3 viagem.antt.nome Alfanumrico 200

4 viagem.antt.rntrc.situacao Alfanumrico 20

5 viagem.veiculo.placa.qtde Numrico 1

6 viagem.veiculoN.placa Alfanumrico 7

7 viagem.veiculoN.situacao Alfa 1 (S ou N) Obs 5

Exemplo


transacional.operacao=29 #header viagem.contratante.documento.numero=00001001000312 #viagem.unidade.documento.tipo=1 #viagem.unidade.documento.numero=00001001000312 #body viagem.favorecido.documento.qtde=2 # Dados de PF [2-CPF 5-rntrcPF ] viagem.favorecido.documento1.tipo=2 viagem.favorecido.documento1.numero=27269448841 viagem.favorecido.documento2.tipo=5 viagem.favorecido.documento2.numero=00169192 # Dados de PJ [1- cnpj 6-rntrcPJ ] #viagem.favorecido.documento1.tipo=1 #viagem.favorecido.documento1.numero=00027269448841 #viagem.favorecido.documento2.tipo=6 #viagem.favorecido.documento2.numero=00169192 viagem.veiculo.qtde=2 viagem.veiculo1.placa=CZC8816 viagem.veiculo2.placa=CDL7094





mensagem.codigo=0 mensagem.descricao= Operao realizada com sucesso viagem.antt.nome=ANDR FERNANDO CARDOSO viagem.antt.rntrc.situacao=Inativo viagem.veiculo.qtde=2 viagem.veiculo1.placa=CZC8816 viagem.veiculo1.situacao=S viagem.veiculo2.placa=CDL7094 viagem.veiculo2.situacao=N

Roteirizar

Operao que permite a roteirizao de uma determinada viagem no Sistema Pamcard. Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno:


Parmetro Tipo Valor

context alfanumrico Fixo=Router

0fields array

Campos de Entrada

VIAGEM





4 viagem.veiculo.categoria alfanumrico 3 Ver Tabela 23

5 viagem.rota.id numrico 10

6 viagem.rota.nome alfanumrico 50 Obs 4

7 viagem.origem.pais.nome alfanumrico 50 Obs 6, Obs 7

8 viagem.origem.estado.nome alfanumrico 50 Obs 6, Obs 7

9 viagem.origem.cidade.nome alfanumrico 50 Obs 6, Obs 7

10 viagem.origem.cidade.ibge numrico 7 Obs 5

11 viagem.destino.cidade.ibge numrico 7 Obs 5

12 viagem.destino.pais.nome alfanumrico 50 Obs 6, Obs 7

13 viagem.destino.estado.nome alfanumrico 50 Obs 6, Obs 7

14 viagem.destino.cidade.nome alfanumrico 50 Obs 6, Obs 7

15 viagem.ponto.qtde numrico 10 Obs 7, Obs.8

16 viagem.pontoN.pais.nome alfanumrico 50

17 viagem.pontoN.estado.nome alfanumrico 50

18 viagem.pontoN.cidade.nome alfanumrico 50

19 viagem.pontoN.cidade.ibge Numrico 50 Obs 5

20 viagem.pedagio.obter.praca Alfa 1 (S ou N) Obs 9

21 viagem.pedagio.obter.rota Alfa 1 (S ou N) Obs 10

22 viagem.pedagio.idavolta alfanumrico 1 (S ou N) Obs 12

23 viagem.pedagio.caminho numrico 2 Ver tabela 38 Obs 12 e 13

24 viagem.pedagio.solucao.id Numrico 1 Ver Tabela 3 Obs. 14

25 viagem.obter.uf Alfa 1 (S ou N) Obs 15

Observaes:





obrigatrias apenas quando a autenticao for realizada por uma filial. Se a empresa que estar realizando a autenticao for uma contratante, ser obrigatrio apenas a chave viagem.contratante.documento.numero .

3. Opo 1 - Se for informado o ID da Rota, cdigo gerado no cadastramento de rotas do Sistema Pamcard, os parmetros de referente a Nome de rota e Origem e Destino sero desconsiderados;

4. Opo 2 - Se for informado o nome da Rota, nome informado no cadastramento de rotas do Sistema Pamcard, os parmetros de Id de rota e Origem e Destino sero desconsiderados;

5. Opo 3 Se for informada a rota atravs dos cdigos IBGE das cidades, os parmetros de Origem e Destino informados pelo nome das cidades sero desconsiderados;

6. Opo 4 Se no houver Rota previamente cadastrada no Sistema Pamcard, os parmetros 5 e 6, 10, 11 e 15.4 sero de preenchimento obrigatrio e os paramtros Nome de Rota e Id de rota sero desconsiderados;

7. Os Nomes de Cidade, Estados e Pases devero ser preenchidos em Maisculo, Sem Acentuao, Sem caracteres especiais (Padro Correios)

8. Preencher com a quantidade de pontos intermedirios a serem informados (passando por). Se no houver pontos intermedirios informar quantidade = 0 (Zero).

9. Se for solicitado a apresentao das praas de pedgio (viagem.pedgio.obter.praca = S), o parmetro viagem.pedgio.roteirizar deve ser = S . Ser apresentado nmero de praas, o nome e valor por praa de pedgio, alm do total.

10. Parmetro viagem.pedagio.obter.rota = S retorna Origem/Destino de rota cadastrada. 11. Parmetro viagem.pedagio.tempo.percurso retorna se viagem roteirizada com rota

previamente cadastrada

12. Campos vlidos somente quando informado Origem e Destino

13. Se no informado o campo assume o valor default 2 - MAIS RPIDO-VIAS PRIORITRIAS

14. Se informado o parmetro viagem.pedagio.solucao.id=6 (TAG) ir realizar a validao das Praas de Pedgio junto ao parceiro.

15. Parmetro viagem.obter.uf = S retorna lista de ufs da rota.


Campos de Retorno

RETORNO




3 viagem.destino.cidade.nome alfanumrico 50 Obs 10

4 viagem.destino.estado.nome alfanumrico 50 Obs 10

5 viagem.destino.pais.nome alfanumrico 50 Obs 10

6 viagem.origem.cidade.nome alfanumrico 50 Obs 10

7 viagem.origem.estado.nome alfanumrico 50 Obs 10

8 viagem.origem.pais.nome alfanumrico 50 Obs 10

9 viagem.pedagio.km Decimal 19,4

10 viagem.pedagio.pracaN.seq numerico 2 Obs 9

11 viagem.pedagio.pracaN.valor decimal 9,2 Obs 9

12 viagem.pedagio.pracaNnome alfanumrico 30 Obs 9

13 viagem.pedagio.pracas.quantidade numrico 2

14 viagem.pedagio.tempo.percurso alfanumrico 15 Obs 11

15 viagem.pedagio.valor decimal 9,2

16 viagem.pedagioN.praca.km Decimal 19,4 Obs 9




17 viagem.ponto.qtde Numrico 2

18 viagem.pontoN.cidade.nome alfanumrico 50 Obs 10

19 viagem.pontoN.estado.nome alfanumrico 50 Obs 10

20 viagem.pontoN.km Decimal 19,4 Obs 10

21 viagem.pontoN.pais.nome alfanumrico 50 Obs 10

22 viagem.uf.qtde numrico 2

23 viagem.ufN.sigla alfanumrico 2

Exemplo


transacional.operacao=11 viagem.contratante.documento.numero=27064195000190 #viagem.unidade.documento.tipo=1 #viagem.unidade.documento.numero=27064195000270 viagem.veiculo.categoria=7 #viagem.rota.id=1234543 #viagem.rota.nome=ROTA-SPO-CMP viagem.origem.pais.nome=BRASIL viagem.origem.estado.nome=SP viagem.origem.cidade.nome=SAO PAULO viagem.ponto.qtde=2 viagem.ponto1.pais.nome=BRASIL viagem.ponto1.estado.nome=SP viagem.ponto1.cidade.nome=MAIRIPORA viagem.ponto2.pais.nome=BRASIL viagem.ponto2.estado.nome=SP viagem.ponto2.cidade.nome=JUNDIAI viagem.destino.pais.nome=BRASIL viagem.destino.estado.nome=SP viagem.destino.cidade.nome=CAMPINAS viagem.pedagio.obter.rota=S #viagem.origem.cidade.ibge=4205456 #viagem.destino.cidade.ibge=4208203 #viagem.ponto.qtde=2 #viagem.ponto1.cidade.ibge=4218707 #viagem.ponto2.cidade.ibge=4211900 #viagem.rota.id=10395 #viagem.rota.nome=sao paulo - campinas


mensagem.codigo=0 mensagem.descricao= Operao realizada com sucesso




viagem.destino.cidade.nome=CAMPINAS viagem.destino.estado.nome=SP viagem.destino.pais.nome=BRASIL viagem.origem.cidade.nome=SAO PAULO viagem.origem.estado.nome=SP viagem.origem.pais.nome=BRASIL viagem.pedagio.km=128.52 viagem.pedagio.pracas.quantidade=1 viagem.pedagio.tempo.percurso=1h 42min viagem.pedagio.valor=34.50 viagem.ponto.qtde=2 viagem.ponto1.cidade.nome=MAIRIPORA viagem.ponto1.estado.nome=SP viagem.ponto1.pais.nome=BRASIL viagem.ponto1.km=70.43 viagem.ponto2.cidade.nome=JUNDIAI viagem.ponto2.estado.nome=SP viagem.ponto2.pais.nome=BRASIL viagem.ponto2.km=196.72

Consultar Conta Operao que permite Consultar Conta no Sistema Pamcard. Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno: Parmetros de Entrada

Parmetro Tipo Valor

context alfanumrico Fixo=FindFavoredAccount

fields array

Campos de Entrada

VIAGEM





4 viagem.favorecido.documento.tipo Numrico 2 Obrigatrio. Obs.3


6 viagem.favorecido.conta.banco

Numrico 4 obrigatorio

7 viagem.favorecido.conta.agencia Alfanumrico 10 obrigatorio

8 viagem.favorecido.conta.agencia.digito Alfanumrico 1

9 viagem.favorecido.conta.numero Alfanumrico 10 obrigatorio

10 viagem.favorecido.conta.tipo Numrico 2 Obrigatrio Ver Tabela 19

Observaes:


apenas quando a autenticao for realizada por uma filial. Se a empresa que estiver realizando a autenticao for uma contratante, ser obrigatrio apenas a chave




viagem.contratante.documento.numero. 3. Ser permitida a consulta com os seguintes documentos: os tipos 1 (CNPJ) e 6 (RNTRC) para Pessoa

Jurdica ou 2 (CPF) e 5(RNTRC) para Pessoa Fsica.


Campos de Retorno

RETORNO




3 viagem.favorecido.documento.tipo Numrico 2 Obrigatrio



6 viagem.favorecido.conta.banco Numrico 4 obrigatorio


8 viagem.favorecido.conta.status Alfanumrico 20 Ver Tabela 17

9 viagem.favorecido.conta.tipo Alfanumrico 10 Obrigatrio Ver Tabela 19

10 viagem.favorecido.rntrc.cadastro Alfanumrico 1 S ou N

Exemplo


transacional.operacao=24 viagem.contratante.documento.numero=00001001000312 viagem.favorecido.documento.tipo=2 viagem.favorecido.documento.numero=38666615338 viagem.favorecido.conta.banco=345 viagem.favorecido.conta.agencia=1234 viagem.favorecido.conta.numero=987654323 viagem.favorecido.conta.tipo=1


mensagem.codigo=0 mensagem.descricao= Operao realizada com sucesso. viagem.favorecido.conta.agencia=0341 viagem.favorecido.conta.banco=341 viagem.favorecido.conta.numero=341341 viagem.favorecido.conta.status=PENDENTE viagem.favorecido.conta.tipo=CORRENTE

Incluir Carto Portador Frete




Operao que permite cadastrar Carto Portador Frete no Sistema Pamcard. Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno: Parmetros de Entrada

Parmetro Tipo Valor

context alfanumrico Fixo=InsertCardFreight

fields array

Campos de Entrada

VIAGEM





4 viagem.cartao.numero Numrico 16 obrigatrio

5 viagem.cartao.portador.documento.tipo Numrico 2 Obrigatrio CPF =2

6 viagem.cartao.portador.documento.numero alfanumrico 20 obrigatrio

7 viagem.cartao.portador.rg Alfanumrico 17 Obrigatrio

8 viagem.cartao.portador.uf.rg Alfanumrico 2 Obrigatrio

9 viagem.cartao.portador.rg.emissor.id Numrico 2 Obs 3 Ver Tabela 25

10 viagem.cartao.portador.rg.emissao.data DD/MM/AAAA 10 Obs 3

11 viagem.cartao.portador.rntrc Numrico 14

12 viagem.cartao.portador.nome Alfanumrico 40 Obrigatrio (nome + sobrenome)

13 viagem.cartao.portador.data.nascimento DD/MM/AAAA 10 Idade entre 18 e 100 anos

14 viagem.cartao.portador.nacionalidade.id Numrico 1 Obs 3 Ver Tabela 26

15 viagem.cartao.portador.naturalidade.ibge Numrico 9 Obs 3

16 viagem.cartao.portador.sexo Alfanumrico 1 Obs 3 Ver Tabela 27

17 viagem.cartao.portador.endereco.logradouro Alfanumrico 40 Obrigatrio

18 viagem.cartao.portador.endereco.numero Numrico 5 Obrigatrio

19 viagem.cartao.portador.endereco.complemento Alfanumrico 15

20 viagem.cartao.portador.endereco.bairro Alfanumrico 30 Obrigatrio

21 viagem.cartao.portador.endereco.cidade Alfanumrico 30 Obrigatrio padro correio

22 viagem.cartao.portador.endereco.uf Alfanumrico 2 Obrigatrio

23 viagem.cartao.portador.endereco.pais Alfanumrico 30 obrigatorio

24 viagem.cartao.portador.endereco.cep Numrico 8 obrigatorio

25 viagem.cartao.portador.endereco.propriedade.tipo.id

Numrico 2 Obs 3 Ver Tabela 28

26 viagem.cartao.portador.endereco.reside.desde MM/AAAA 7 Obs 3

27 viagem.cartao.portador.telefone.ddd alfanumerico 3 Obrigatrio Formato 099

28 viagem.cartao.portador.telefone.numero Numrico 8 obrigatorio

29 viagem.cartao.portador.celular.operadora.id Numrico 2 Obs 3 Ver Tabela 29

30 viagem.cartao.portador.celular.ddd alfanumerico 3 Formato 099

31 viagem.cartao.portador.celular.numero Numrico 8

32 viagem.cartao.portador.email Alfanumrico 40




33 viagem.cartao.empresa.nome Alfanumrico 50 Obs 4

34 viagem.cartao.empresa.cnpj Numrico 14 Obs 4

35 viagem.cartao.empresa.rntrc Numrico 8 Obs 4

Observaes:


obrigatrias apenas quando a autenticao for realizada por uma filial. Se a empresa que estiver realizando a autenticao for uma contratante, ser obrigatrio apenas a chave viagem.contratante.documento.numero .

3. Campos obrigatrios se carto Expresso do Banco do Brasil 4. Campos obrigatrios para cadastro de carto Expresso Pessoa Jurdica 5. Os caracteres especiais como acentuao, apstrofre espaos em branco aps ltimo

caracter sero desconsisderados na incluso, nos campos Nome, Logradouro, Bairro. 6. Se o documento do Portador possuir +de 1 carto ativo, o sistema no permite o

cadastramento e envia mensagem de erro Cancelar Vias anteriores. 7. Toda vez que includo um novo carto, a base de cadastro de favorecido alimentada

automaticamente.


Campos de Retorno

RETORNO




Exemplo


transacional.operacao=21 viagem.contratante.documento.numero=27064195000190 viagem.cartao.numero=4417810094174019 viagem.cartao.portador.documento.numero=60913811211 viagem.cartao.portador.documento.tipo=1 viagem.cartao.portador.rg=321654 viagem.cartao.portador.uf.rg=SP viagem.cartao.portador.nome=jennifer teste viagem.cartao.portador.rntrc=123456879 viagem.cartao.portador.data.nascimento=28/12/1981 viagem.cartao.portador.endereco.logradouro=R. LOURENCO CABRAL viagem.cartao.portador.endereco.numero=843 viagem.cartao.portador.endereco.complemento=COMPLEMENTO viagem.cartao.portador.endereco.bairro= VILA GAGA viagem.cartao.portador.endereco.cidade=SAO PAULO




viagem.cartao.portador.endereco.uf=SP viagem.cartao.portador.endereco.pais=BRASIL viagem.cartao.portador.endereco.cep=04152130 viagem.cartao.portador.telefone.ddd=011 viagem.cartao.portador.telefone.numero=38891105 #viagem.cartao.portador.celular.ddd=013 #viagem.cartao.portador.celular.numero=99995555 #viagem.cartao.portador.email=jennifer.cavalheiro@gps-pamcary.com.br



Incluir Favorecido Operao que permite cadastrar Favorecido no Sistema Pamcard. Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno: Parmetros de Entrada

Parmetro Tipo Valor

context alfanumrico Fixo=InsertFavored

fields array

Campos de Entrada

VIAGEM





4 viagem.favorecido.documento.qtde Numrico 1 obrigatrio



7 viagem.favorecido.documentoN.uf Alfanumrico 2 Obs. 4

8 viagem.favorecido.documentoN.emissor.id Numrico 2 No obrigatrio Ver Tabela 25

9 viagem.favorecido.documentoN.emissao.data Data 10 No obrigatrio dd/mm/yyyy

10 viagem.favorecido.nome Alfanumrico 60 Obrigatrio Obs. 5

11 viagem.favorecido.data.nascimento Data dd/mm/yyyy Obs. 6

12 viagem.favorecido.nacionalidade.id Numrico 1 No obrigatrio Ver Tabela 26

13 viagem.favorecido.naturalidade.ibge Numrico 9 No obrigatrio

14 viagem.favorecido.sexo Alfanumrico 1 No obrigatrio Ver Tabela 27

15 viagem.favorecido.endereco.logradouro Alfanumrico 40 obrigatrio

16 viagem.favorecido.endereco.numero numrico 5 Obrigatrio

17 viagem.favorecido.endereco.complemento Alfanumrico 15 No obrigatrio




18 viagem.favorecido.endereco.bairro Alfanumrico 30 Obrigatrio

19 viagem.favorecido.endereco.cidade.ibge Numrico 8 Obs. 7

20 viagem.favorecido.endereco.cidade Alfanumrico 30 Obs. 8

21 viagem.favorecido.endereco.uf Alfanumrico 2 Obs. 8

22 viagem.favorecido.endereco.pais Alfanumrico 30 Obs. 8

23 viagem.favorecido.endereco.cep Numrico 8 Obs. 8

24 viagem.favorecido.endereco.propriedade.tipo.id Numrico 2 No obrigatrio Ver Tabela 28

25 viagem.favorecido.endereco.reside.desde Data 7 No obrigatrio mm/yyyy

26 viagem.favorecido.telefone.ddd alfanumerico 3 Obrigatrio Formato 099

27 viagem.favorecido.telefone.numero Numrico 8 Obrigatrio

28 viagem.favorecido.celular.operadora.id Numrico 2 Obs 9 Ver Tabela 29

29 viagem.favorecido.celular.ddd alfanumerico 3 Obs. 9 Formato 099 No obrigatorio

30 viagem.favorecido.celular.numero Numrico 8 Obs. 9 No obrigatorio

31 viagem.favorecido.email Alfanumrico 40 No obrigatorio

Observaes:


apenas quando a autenticao for realizada por uma filial. Se a empresa que estiver realizando a autenticao for uma contratante, ser obrigatrio apenas a chave viagem.contratante.documento.numero .

3. Devero ser informados obrigatoriamente os tipos 1(CNPJ) e 6 (RNTRC) para Pessoa Jurdica ou 2(CPF), 3(RG) e 5(RNTRC) para Pessoa Fsica.

4. Este campo obrigatrio caso seja Tipo de documento 3-RG (somente pessoa fsica). 5. No deve conter nmeros; deve ser composto mnimo de 2 palavras separadas por um branco. 6. Campo obrigatrio se informado cadastro de pessoa fsica e o portador deve ter a idade mnima de 18

e mxima de 100. 7. Se este campo for informado, os campos viagem.favorecido.endereco.cidade,

viagem.favorecido.endereco.uf e viagem.favorecido.endereco.pais no devero ser informados. 8. Campo obrigatrio se viagem.favorecido.endereco.cidade.ibge no informado. 9. DDD do celular se torna obrigatrio se informar o nmero do celular ou operadora e vice-versa. 10. Caracteres especiais, acentuaes sero suprimidos na gravao dos campos nome, logradouro,

complemento, bairro


Campos de Retorno

RETORNO







Exemplo


transacional.operacao=23 viagem.contratante.documento.numero=00001001000312 viagem.favorecido.nome=Chicoh teste viagem.favorecido.data.nascimento=24/12/1981 viagem.favorecido.documento.qtde=3 viagem.favorecido.documento1.tipo=2 viagem.favorecido.documento1.numero=74677314268 viagem.favorecido.documento2.tipo=3 viagem.favorecido.documento2.numero=32234123x viagem.favorecido.documento2.uf=SP viagem.favorecido.documento3.tipo=5 viagem.favorecido.documento3.numero=12345678901234 viagem.favorecido.endereco.logradouro=Rua do Brejo viagem.favorecido.endereco.numero=24 viagem.favorecido.endereco.complemento=apto6 viagem.favorecido.endereco.bairro=CENTRO viagem.favorecido.endereco.cep=12345546 viagem.favorecido.endereco.cidade.ibge=3550308 viagem.favorecido.telefone.ddd=011 viagem.favorecido.telefone.numero=12341234 viagem.favorecido.celular.ddd=011 viagem.favorecido.celular.numero=43214321 [email protected]



Incluir Conta Operao que permite Incluir Conta no Sistema Pamcard. Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno: Parmetros de Entrada

Parmetro Tipo Valor

context alfanumrico Fixo=InsertFavoredAccount

fields array

Campos de Entrada




VIAGEM





4 viagem.favorecido.documento.tipo Numrico 2 Obrigatrio


6 viagem.favorecido.conta.banco Numrico 4 obrigatorio


8 viagem.favorecido.conta.agencia.digito Alfanumrico 1 Obs 4


10 viagem.favorecido.conta.tipo Numrico 2 Obrigatrio Ver Tabela 19

Observaes:


apenas quando a autenticao for realizada por uma filial. Se a empresa que estiver realizando a autenticao for uma contratante, ser obrigatrio apenas a chave viagem.contratante.documento.numero.

3. Ser permitida a consulta com os seguintes documentos: os tipos 1 (CNPJ) e 6 (RNTRC) para Pessoa Jurdica ou 2 (CPF) e 5(RNTRC) para Pessoa Fsica.

4. Campo obrigatrio para clientes que operam transferncia pelo Banco do Brasil quando o favorecido utilizar conta do Banco do Brasil.


Campos de Retorno

RETORNO




Exemplo


transacional.operacao=25 viagem.contratante.documento.numero=00001001000312 viagem.favorecido.documento.tipo=2 viagem.favorecido.documento.numero=38666615338 viagem.favorecido.conta.banco=345




viagem.favorecido.conta.agencia=1234 viagem.favorecido.conta.numero=987654323 viagem.favorecido.conta.tipo=2



Inserir Rota

Operao que permite efetuar o Cadastramento de Rota no Sistema Pamcard pelo Contratante. Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno:


Parmetro Tipo Valor

Context alfanumrico Fixo=InsertRoute

Fields array

Campos de Entrada

VIAGEM



2 viagem.unidade.documento tipo numrico 2 Ver Tabela 2 Obs 2


4 viagem.rota.id.cliente numrico 10

5 viagem.rota.nome alfanumrico 50

6 viagem.origem.cidade.ibge numrico 7

7 viagem.origem.cidade.nome alfanumrico 50 Obs 3

8 viagem.origem.estado.nome alfanumrico 50 Obs 3

9 viagem.origem.pais.nome alfanumrico 50 Obs 3

10 viagem.destino.cidade.ibge numrico 7

11 viagem.destino.cidade.nome alfanumrico 50 Obs 3

12 viagem.destino.estado.nome alfanumrico 50 Obs 3

13 viagem.destino.pais.nome alfanumrico 50 Obs 3

14 viagem.ponto.qtde numrico 10 Obs 4

15 viagem.ponto.pais.nome alfanumrico 50 Obs 3

16 viagem.ponto.estado.nome alfanumrico 50 Obs 3

17 viagem.ponto.cidade.nome alfanumrico 50 Obs 3

18 viagem.ponto.cidade.ibge numrico 7

19 viagem.rota.idavolta alfanumrico 1 S ou N

20 viagem.rota.caminho numrico 2 Ver tabela 38 Obs 5

Campos de Retorno

RETORNO




3 viagem.rota.id numrico 10




Observaes:


obrigatrias apenas quando a autenticao for realizada por uma filial. Se a empresa que estar realizando a autenticao for uma contratante, ser obrigatrio apenas a chave viagem.contratante.documento.numero .

18. Os Nomes de Cidade, Estados e Pases devero ser preenchidos em Maisculo, Sem Acentuao, Sem caracteres especiais (Padro Correios)

19. Preencher com a quantidade de pontos intermedirios a serem informados (passando por). Se no houver pontos intermedirios informar quantidade = 0 (Zero).

20. Se no informado o campo assume o valor default 1 - MAIS RPIDO-VIAS PRIORITRIAS

Inserir Remetente / Destinatrio

Operao que permite a incluso de endereos referentes s Pessoas relacionadas ao documento Fiscal (Remetente/Destinatrio/Consignatrio). Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno:


Parmetro Tipo Valor

context Alfanumrico Fixo=InsertDeliveryAddress

fields Array

Campos de Entrada

VIAGEM



2 viagem.unidade.documento.tipo Numrico 2 Ver Tabela 2

Obs 3


4 viagem.documento.pessoafiscal.codigo Numrico 10 Obrigatrio

nico por Contratante

Obs.4

5 viagem.documento.pessoafiscal.documento.tipo Numrico 2 Ver tabela 2 Obrigatrio

6 viagem.documento.pessoafiscal.documento.numero Numrico 20 Obrigatrio

7 viagem.documento.pessoafiscal.nome Alfanumrico 40 Obrigatrio

8 viagem.documento.pessoafiscal.endereco.logradouro Alfanumrico 40 Obrigatrio

9 viagem.documento.pessoafiscal.endereco.numero Alfanumrico 5 Obrigatrio

10 viagem.documento.pessoafiscal.endereco.complemento Alfanumrico 15 No obrigatorio

11 viagem.documento.pessoafiscal.endereco.bairro Alfanumrico 30 Obrigatrio

12 viagem.documento.pessoafiscal.endereco.cidade.ibge Numrico 7 Obrigatrio

13 viagem.documento.pessoafiscal.endereco.cep Numrico 8 Obrigatrio

Observaes: 1. O cliente dever sempre informar o CNPJ da Contratante; 2. O cdigo informado deve ser nico por contratante. 3. As chaves viagem.unidade.documento.tipo e viagem.unidade.documento.numero sero obrigatrias

apenas quando a autenticao for relizada por uma filial. Se a empresa que estar realizando a autenticao for uma contratante, ser obrigatrio apenas a chave viagem.contratante.documento.numero.




4. Somente devem ser informados CNPJ (1) ou CPF (2). 5. No possvel a importao de dados no Sistema Pamcard para cadastramento de

Remetente/Destinatrio.


Campos de Retorno

RETORNO




Alterar Remetente / Destinatrio

Operao que permite a alterao de endereos referentes s Pessoas relacionadas ao documento Fiscal (Remetente/Destinatrio/Consignatrio). Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno:


Parmetro Tipo Valor

context Alfanumrico Fixo=UpdateDeliveryAddress

fields Array

Campos de Entrada

VIAGEM




Obs 3




Obs.4

5 viagem.documento.pessoafiscal.documento.tipo Numrico 2 Ver tabela 2 Obrigatrio


7 viagem.documento.pessoafiscal.nome Alfanumrico 40 Obrigatrio

8 viagem.documento.pessoafiscal.endereco.logradouro Alfanumrico 40 Obrigatrio

9 viagem.documento.pessoafiscal.endereco.numero Alfanumrico 5 Obrigatrio

10 viagem.documento.pessoafiscal.endereco.complemento Alfanumrico 15 No obrigatorio

11 viagem.documento.pessoafiscal.endereco.bairro Alfanumrico 30 Obrigatrio

12 viagem.documento.pessoafiscal.endereco.cidade.ibge Numrico 7 Obrigatrio

13 viagem.documento.pessoafiscal.endereco.cep Numrico 8 Obrigatrio




Observaes: 6. O cliente dever sempre informar o CNPJ da Contratante; 7. Dever ser informado uma das opes para localizao do Remetente/Destinatrio a ser alterado:

a. viagem.documento.pessoafiscal.documento.tipo e viagem.documento.pessoafiscal.documento.numero

b. viagem.documento.pessoafiscal.codigo 8. As chaves viagem.unidade.documento.tipo e viagem.unidade.documento.numero sero obrigatrias


9. Somente devem ser informados CNPJ (1) ou CPF (2). 10. Os Contratos de Frete j cadastrados no sofrero alterao, pois as informaes anteriores sero

mantidas como histrico.


Campos de Retorno

RETORNO




Consultar Remetente / Destinatrio

Operao que permite a consulta de endereos referentes s Pessoas relacionadas ao documento Fiscal (Remetente/Destinatrio/Consignatrio). Abaixo segue a definio dos parmetros de entrada e os campos de entrada e retorno:


Parmetro Tipo Valor

context Alfanumrico Fixo=SearchDeliveryAddress

fields Array

Campos de Entrada

VIAGEM




Obs 3




Obs.4

5 viagem.documento.pessoafiscal.documento.tipo Numrico 2 Ver tabela 2




Obrigatrio


Observaes:

11. O cliente dever sempre informar o CNPJ da Contratante; 12. Dever ser informado uma das opes para localizao do Remetente/Destinatrio a ser consultado:

a. viagem.documento.pessoafiscal.documento.tipo e viagem.documento.pessoafiscal.documento.numero

b. viagem.documento.pessoafiscal.codigo 13. As chaves viagem.unidade.documento.tipo e viagem.unidade.documento.numero sero obrigatrias


14. Somente devem ser informados CNPJ (1) ou CPF (2).


Campos de Retorno

RETORNO




3 viagem.documento.pessoafiscal.codigo Numrico 10

4 viagem.documento.pessoafiscal.documento.tipo Numrico 2

5 viagem.documento.pessoafiscal.documento.numero

Numrico 20

6 viagem.documento.pessoafiscal.nome Alfanumrico 40

7 viagem.documento.pessoafiscal.endereco.logradouro

Alfanumrico 40

8 viagem.documento.pessoafiscal.endereco.numero Alfanumrico 5

9 viagem.documento.pessoafiscal.endereco.complemento

Alfanumrico 15

10 viagem.documento.pessoafiscal.endereco.bairro Alfanumrico 30

11 viagem.documento.pessoafiscal.endereco.cidade.ibge

Numrico 7

12 viagem.documento.pessoafiscal.endereco.cep Numrico 8

Incluir Contrato Frete

Operao que permite a incluso de um contrato de frete no Sistema Pamcard. Abaixo segue a definio dos parmetros de entrada e os campos de entrada e sada: Parmetros de Entrada

Parmetro Tipo Valor

context alfanumrico Fixo= InsertFreightContract fields array




Campos de Entrada

VIAGEM





4 viagem.id.cliente numrico 18 Obs.3

5 viagem.contrato.numero alfanumrico 30 Obrigatrio

6 viagem.favorecido.qtde numrico 1 Obrigatrio (mximo 3)

7 viagem.favorecidoN.tipo Numrico 1 Ver Tabela 15

8 viagem.favorecidoN.documento.qtde Numrico 1 Obrigatrio

9 viagem.favorecidoN.documentoN.tipo numrico 2 Obrigatorio Ver Tabela 2

10 viagem.favorecidoN.documentoN.numero alfanumrico 30 Obrigatrio Obs.5

11 viagem.favorecidoN.documentoN.uf Alfanumrico 2 Obs. 30

12 viagem.favorecidoN.documentoN.emissor.id Numrico 2 Obs. 30 Ver Tabela 25

13 viagem.favorecidoN.documentoN.emissao.data Data 10 Obs. 30 dd/mm/yyyy

14 viagem.favorecidoN.nome Alfanumrico 40 Obs. 30

15 viagem.favorecidoN.data.nascimento Data Obs. 30 dd/mm/yyyy

16 viagem.favorecidoN.nacionalidade.id Numrico 1 Obs. 30 Ver Tabela 26

17 viagem.favorecidoN.naturalidade.ibge Numrico 9 Obs. 30

18 viagem.favorecidoN.sexo Alfanumrico 1 Obs. 30 Ver Tabela 27

19 viagem.favorecidoN.endereco.logradouro Alfanumrico 40 Obs. 30

20 viagem.favorecidoN.endereco.numero numrico 5 Obs. 30

21 viagem.favorecidoN.endereco.complemento Alfanumrico 15 Obs. 30 No obrigatrio

22 viagem.favorecidoN.endereco.bairro Alfanumrico 30 Obs. 30

23 viagem.favorecidoN.endereco.cidade.ibge Numrico Obs. 30

24 viagem.favorecidoN.endereco.cep Numrico 8 Obs. 30

25 viagem.favorecidoN.endereco.propriedade.tipo.id Numrico 2 Obs. 30 Ver Tabela 28

26 viagem.favorecidoN.endereco.reside.desde Data 7 Obs. 30 mm/yyyy

27 viagem.favorecidoN.telefone.ddd alfanumerico 3 Obs. 30 Formato 099

28 viagem.favorecidoN.telefone.numero Numrico 8 Obs. 30

29 viagem.favorecidoN.celular.operadora.id Numrico 2 Obs. 30 Ver Tabela 29 No Obrigatrio

30 viagem.favorecidoN.celular.ddd alfanumerico 3 Obs. 30 Formato 099. No obrigatrio

31 viagem.favorecidoN.celular.numero Numrico 8 Obs. 30 No obrigatrio

32 viagem.favorecidoN.email Alfanumrico 40 Obs. 30 No obrigatrio




33 viagem.favorecidoN.meio.pagamento numrico 1 Ver Tabela 20

34 viagem.favorecidoN.conta.banco Numrico 4 Obs. 4

35 viagem.favorecidoN.conta.agencia alfanumrico 10 Obs. 4

36 viagem.favorecidoN.conta.agencia.digito alfanumrico 1 Obs. 51

37 viagem.favorecidoN.conta.numero Alfanumrico 10 Obs. 4

38 viagem.favorecidoN.conta.tipo Numrico 1 Obs. 4 Ver Tabela 19

39 viagem.favorecidoN.cartao.numero numrico 16 Obs.6

40 viagem.favorecidoN.empresa.nome Alfanumrico 50 Obs 41

41 viagem.favorecidoN.empresa.cnpj Numrico 14 Obs 41

42 viagem.favorecidoN.empresa.rntrc Numrico 8 Obs 41

43 viagem.veiculo.qtde Numrico 1 Max. 5 ocorrncias Obrigatrio

44 viagem.veiculoN.placa Alfanumrico 7 Obrigatrio Obs 7

45 viagem.veiculoN.rntrc alfanumrico 8 No obrigatrio Obs. 36

46 viagem.veiculo.categoria Alfanumrico 3 Obrigatrio. Ver Tabela 23

47 viagem.data.partida Data 10 dd/mm/yyyy Obrigatrio Obs. 37

48 viagem.data.termino Data 10 dd/mm/yyyy Obs 8 Obrigatrio

49 viagem.rota.id numrico 10 Obs 9

50 viagem.rota.nome alfanumrico 50 Obs 10

51 viagem.origem.cidade.ibge numrico 7 Obs 11

52 viagem.destino.cidade.ibge numerico 7 Obs 11

53 viagem.ponto.qtde numrico 10 Obs 12 No obrigatrio

54 viagem.pontoN.cidade.ibge numrico 7 No obrigatrio

55 viagem.pedagio.solucao.id Numrico 1 Ver Tabela 3 Obs. 38 Obs 56

56 viagem.pedagio.valor decimal 9,2 Obs 13

57 viagem.pedagio.status.id numrico 2 Ver Tabela 10

58 viagem.pedagio.roteirizar alfa 1 (S ou N) Obs 14 Obs 56

58 viagem.pedagio.obter.praca Alfa 1 (S ou N) Obs 15

59 viagem.pedagio.utiliza.saldo Alfa 1 (S ou N) obs 16 Obs. 32

60 viagem.pedagio.cartao.numero numrico 16 Obs.6

61 viagem.carga.tipo (campo desativado, de acordo com novas regras ANTT )

Numrico 1 1-Lotao 2-Fracionada Obrigatrio. Obs.34

62 viagem.carga.natureza numrico 4 Obs. 32 Obrigatrio

63 viagem.carga.peso decimal 5,2 Obs 13 Obrigatrio

64 viagem.carga.perfil.id numrico 1 Obs 42

Obs 43

Obs. 44

Ver Tabela 34




65 viagem.documento.qtde numrico 10 Obrigatrio Obs. 17

66 viagem.documentoN.tipo numrico 2 Obrigatrio Ver Tabela 1 Ver Obs. 31

67 viagem.documentoN.numero alfanumrico 30 Obrigatrio Obs. 31

68 viagem.documentoN.serie Alfa 5 No Obrigatrio

69 viagem.documentoN.quantidade decimal 7,2 Obs 13 Obs. 44

70 viagem.documentoN.especie Alfa 15 No obrigatrio

71 viagem.documentoN.cubagem decimal 8,3 Obs 13 No obrigatrio

72 viagem.documentoN.natureza numrico 4 Obs. 32 No obrigatrio

73 viagem.documentoN.peso decimal 5,2 Obs 13 No Obrigatrio

74 viagem.documentoN.mercadoria.valor decimal 17,2 Obs 13 Obs. 44

75 viagem.documentoN.pessoafiscal.qtde numrico 2 Obrigatorio

76 viagem.documentoN.pessoafiscalN.tipo Numrico 1 Obrigatrio Ver Tabela 21

77 viagem.documentoN.pessoafiscalN.codigo Numrico 10 Obs. 20

78 viagem.documentoN.pessoafiscalN.documento.tipo numrico 2 Obrigatorio Ver Tabela 2

79 viagem.documentoN.pessoafiscalN.documento.numero

Alfanumrico 20 Obs. 19

80 viagem.documentoN.pessoafiscalN.nome Alfanumrico 40 Obs. 19

81 viagem.documentoN.pessoafiscalN.endereco.logradouro


82 viagem.documentoN.pessoafiscalN.endereco.numero


83 viagem.documentoN.pessoafiscalN.endereco.complemento


84 viagem.documentoN.pessoafiscalN.endereco.bairro Alfanumrico 30 Obs.19

85 viagem.documentoN.pessoafiscalN.endereco.cidade.ibge

numrico 7 Obs. 19 Obs. 20

86 viagem.documentoN.pessoafiscalN.endereco.cep Numrico 8 Obs. 19

87 viagem.documento.complementar.qtde Numrico 2 Obs. 21 No obrigatrio

88 viagem.documento.complementarN.tipo Numrico 2 Ver Tabela 7 No obrigatrio

89 viagem.parcela.qtde numrico 10 Obrigatrio

90 viagem.parcelaN.efetivacao.tipo numrico 2 Ver Tabela 8 Obrigatrio

91 viagem.parcelaN.valor decimal 9,2 Obs 13 Obrigatrio

92 viagem.parcelaN.subtipo numrico 2 Ver Tabela 5 Obrigatrio

93 viagem.parcelaN.base alfa 1 (S ou N) Obs. 26 No obrigatrio

94 viagem.parcelaN.status.id numrico 2 Ver Tabela 9 Obrigatrio

95 viagem.parcelaN.data data (dd/mm/aaaa) Obrigatrio

96 viagem.parcelaN.favorecido.tipo.id numrico 1 Obrigatrio




Ver Tabela 15

97 viagem.parcelaN.numero.cliente Numrico 18 Obrigatrio

98 viagem.frete.valor.bruto decimal 9,2 Obs 13 obrigatrio

99 viagem.frete.item.qtde Numrico 2 Obrigatrio

100 viagem.frete.itemN.tipo Numrico 3 Ver Tabela 18

101 viagem.frete.itemN.valor decimal 17,2 Obs 13 Obs. 27

102 viagem.quitacao.prazo Numrico 2 Obs 22 No obrigatrio

103 viagem.quitacao.indicador Alfa 1 (S ou N) Obs 23 No obrigatrio

104 viagem.quitacao.entrega.ressalva Alfa 1 (S ou N) obs 24 Obs 42

105 viagem.quitacao.origem.pagamento Numrico 2 Ver Tabela 31 Obs 42 Obs 45

106 viagem.comprovacao.observacao alfa 4000 No obrigatrio

107 viagem.quitacao.desconto.tipo Numrico 1 Obs 46 Ver Tabela 37

108 viagem.quitacao.desconto.faixa.qtde Numrico 9 Obs 47

109 viagem.quitacao.desconto.faixaN.ate Numrico 3,3 Obs 47

110 viagem.quitacao.desconto.faixaN.percentual Numrico 3 Obs 47 Obs 48

111 viagem.quitacao.desconto.tolerancia Numrico 3 Obs 49 Obs 50

112 viagem.carga.valorunitario Numrico 9,2 Obs 52

113 viagem.diferencafrete.credito Numrico 9,2 Obs 53

114 viagem.diferencafrete.debito Numrico 9,2 Obs 53

115 viagem.diferencafrete.tarifamotorista Numrico 1 Obs 53

116 viagem.pedagio.idavolta alfanumrico 1 (S ou N) Obs 54

117 viagem.pedagio.caminho numrico 2 Ver tabela 38 Obs 54 e 55

118 viagem.obter.uf Alfa 1 (S ou N) Obs 57

Observaes:


apenas quando a autenticao for realizada por uma filial. Se a empresa que estar realizando a autenticao for uma contratante, ser obrigatrio apenas a chave viagem.contratante.documento.numero.

3. O parmentro viagem.id.cliente deve ser utilizado para garantir que no haja registro de viagem duplicado para a empresa. A empresa dever enviar um cdigo de controle que garanta que a viagem nica seu sistema.

4. Contedo do parmetro contratado no pode ser nulo desde que o campo viagem.contratado.qtde foi informado.

a. Todos os campos referente ao contratado devem ser preenchidos conforme o meio de pagamento.

b. Meio de pagamento Carto deve ser informado o campo viagem.favorecidoN.cartao.numero. c. Meio de pagamento Conta Depsito deve ser informado viagem.favorecidoN.conta.banco,

viagem.favorecidoN.conta.agencia, viagem.favorecidoN.conta.numero, viagem.favorecidoN.conta.tipo.

5. O preenchimento do campo viagem.favorecidoN.documento.numero deve ser de acordo com o campo viagem.favorecidoN.documento.tipo.

6. O carto tipo Portador Frete novo, que ainda no tem viagem cadastrada anteriormente requer o cadastramento do portador e devero ser informados os campos do 10 ao 32 se o portador no estiver cadastrado no sistema Pamcard.




7. As placas devem ser preenchidas no formato AAA9999 e no podem ser duplicadas entre elas.

8. Data de Trmino deve ser maior ou igual data da partida. O perodo entre as datas no deve exceder a 90 dias.

9. Opo 1 - Se for informado o ID da Rota (parmetro 45), cdigo gerado no cadastramento de rotas do Sistema Pamcard, os parmetros de 46 a 50 sero desconsiderados;

10. Opo 2 - Se for informado o nome da Rota (parmetro 46), nome informado no cadastramento de rotas do Sistema Pamcard, os parmetros de 45, 47 a 50 sero desconsiderados;

11. Opo 3 Se no houver Rota previamente cadastrada no Sistema Pamcard, os parmetros 47 e 50 sero de preenchimento obrigatrio;

12. Preencher com a quantidade de pontos intermedirios a serem informados (passando por). Se no houver pontos intermedirios informar quantidade = 0 (Zero);

13. Os campos de valor devem ter a representao decimal indicada por ponto. Exemplo: 999999999.99 ; O parmetro viagem.documentoN.quantidade pode ser informado com valor 0.00.

14. Se for informado viagem.pedagio.roteirizar = S ser calculado o valor do pedgio, quantidade de praas de pedgio e quilometragem. Seno ser considerado o valor informado como o valor do pedgio. Obrigatrio para soluo 6-TAG

15. Se for solicitado a apresentao das praas de pedgio (viagem.pedagio.obter.praca = S), o parmetro viagem.pedgio.roteirizar deve ser = S . Ser apresentado nmero de praas, o nome e valor por praa de pedgio, alm do total.

16. Se a empresa est configurada para utilizar Saldo do Carto ter opo para utilizar ou no o saldo. Caso contrrio no deve ser informado este parmetro.

17. O campo viagem.documento.qtde deve corresponder qtde de documentos a serem informados na lista.

18. Campo obrigatrio se demais campos do remetente no forem informados. Se informado este campo demais campos de pessoa fiscal sero desconsiderados.

19. Campo obrigatrio se no informado atravs do cdigo. O parmetro viagem.documentoN.pessoafiscalN.endereco.numero pode ser informado com valor igual a 0 (zero).

20. Obrigatrio se no informado viagem.documentoN.pessoafiscalN.pais.nome, viagem.documentoN.pessoafiscalN.estado.nome, viagem.documentoN.pessoafiscalN.cidade.nome

21. Obrigatrio conforme quantidade de documentos complementares informado. 22. Nmero de dias para disparar o pagamento do Saldo Final. 23. Flag para indicar se a empresa permite quitao das parcelas. 24. Flag para indicar se a empresa permite ressalva na entrega. 25. O resultado do Valor Lquido (valor bruto (+) Crditos (-) Dbitos (-) Compensaes) deve ser igual

Somatria das Parcelas de Frete 26. O Campo viagem.parcelaN.base deve ser utilizado quando for Tipo de parcela Abastecimento e, neste

caso o valor default ser S. 27. Se o Tipo do Item de Frete for informado, o valor passa a ser obrigatrio. 28. Quando for solicitada viagem.pedagio.roteirizar = S, o sistema apresenta as informaes da

roteirizao. 29. Se for informado viagem.pedagio.obter.rota = S, o sistema busca os cdigos IBGE das cidades da

Rota Cadastrada caso a opo informada seja Id da Rota, Id da Rota Cliente ou Nome da Rota, caso contrario estes cdigos sero obtidos do Cod.IBGE. Os pontos sero apresentados na sequencia de cadastramento.

30. Campos do 11 ao 32 devem ser informados se no existir favorecido cadastrado no sistema Pamcard. O parmetro viagem.favorecidoN.endereco.numero pode ser informado com valor igual a 0 (zero). Segue exemplo do trecho de cadastramento do favorecido no contrato de frete:

31. Caso a empresa decida no informar os documento deve registrar com tipo de Documento 5-Conhecimento e nmero No Declarado.

viagem.favorecido1.documento.qtde=3

viagem.favorecido1.documento1.tipo=2

viagem.favorecido1.documento1.numero=00011122285





viagem.favorecido1.documento3.uf=SP (parmetro




usado somente para UF de RG)

viagem.favorecido.documentoN.emissor.id (Obrigatrio se favorecido com meio de pagamento carto para cartes novos do BB) (parmetro usado somente para RG)

viagem.favorecido.documentoN.emissao.data (Obrigatrio se favorecido com meio de pagamento carto para cartes novos do BB) (parmetro usado somente para RG)

viagem.favorecidoN.nome

viagem.favorecidoN.data.nascimento

viagem.favorecido.nacionalidade.id (Obrigatrio se favorecido com meio de pagamento carto para cartes novos do BB)

viagem.favorecido.naturalidade.ibge (Obrigatrio se favorecido com meio de pagamento carto para cartes novos do BB)

viagem.favorecido.sexo (Obrigatrio se favorecido com meio de pagamento carto para cartes novos do BB)

viagem.favorecidoN.endereco.logradouro

viagem.favorecidoN.endereco.numero

viagem.favorecidoN.endereco.complemento

viagem.favorecidoN.endereco.bairro

viagem.favorecidoN.endereco.cidade.ibge

viagem.favorecidoN.endereco.cep

viagem.favorecido.endereco.propriedade.tipo.id (Obrigatrio se favorecido com meio de pagamento carto para cartes novos do BB)

viagem.favorecido.endereco.reside.desde (Obrigatrio se favorecido com meio de pagamento carto para cartes novos do BB)

viagem.favorecidoN.telefone.ddd

viagem.favorecidoN.telefone.numero

viagem.favorecido.celular.operadora.id (Obrigatrio se favorecido com meio de pagamento carto para cartes novos do BB)

viagem.favorecidoN.celular.ddd

viagem.favorecidoN.celular.numero

Caso o CPF informado j possua dados cadastrados, obrigatrio somente os parmetros 9 e 10, caso informe os demais campos (11 a 32) as informaes sero desconsideradas. Segue exemplo de informe de favorecido j cadastrado, para incluso de contrato de frete:

viagem.favorecido1.documento.qtde=1



32. A natureza da mercadoria informada deve estar de acordo com o cdigo harmonizado de mercadorias da Receita Federal.

33. Caso a soluo de pedgio informada no seja 5-PAMCARD, todos os parmetros de roteirizao e praas de pedgio sero desconsiderados.

34. O contratado (favorecido tipo 1) obrigatrio (campos 9 ao 32). Caso motorista seja diferente do contratado, deve-se informar o conjunto de parmetros dos campos 9 ao 32 para o motorista (favorecido tipo 3);

35. Se informado viagem.carga.tipo=2, o campo 59 peder ser preenchido com o cdigo 0001 (natureza da carga genrica). Nesse casos, os campos 72 a 82, tornam-se facultativos ao destinatrio.

36. Se no informado RNTRC do veculo, o sistema assumir o RNTRC do contratado. Se o veculo no pertencer ao contratado este campo dever ser informado.

37. Data de Embarque deve estar dentro do prazo de 30 dias a partir da Data Atual.




38. Se no informado o parmetro viagem.pedagio.solucao.id e informado o valor de pedgio ou for roteirizado, considera a soluo 5 (Pamcard) como padro.

39. Quando o meio de pagamento utilizado for 2=Conta, necessrio o cadastramento prvio dessa funcionalidade na configurao da empresa contratante do Sistema Pamcard.

40. Se o numero do carto do pedgio for o mesmo do contratado (ou motorista quando informado), no ser necessrio informar este campo.

41. Campos obrigatrios para cadastro de carto Expresso Pessoa Jurdica 42. Campos obrigatrios se informado viagem.quitacao.indicador como S 43. Caso no seja informado ir assumir 1-Carga Seca 44. Obrigatoriedade condicional do campo. Caso seja selecionada a regra de desconto Tolerncia, o campo

dever ser obrigatrio 45. Caso no seja informado ir assumir o default 1-Contratante 46. Se o perfil da carga for SECA, somente dever aceitar viagem.desconto.tipo=1 47. Obrigatrio somente se viagem.desconto.tipo = 3 48. Se no informado para uma determinada faixa No Paga o Saldo Final. 49. Deve ser informado somente se viagem.quitacao.desconto.tipo = 1. 50. Se carga seca a tolerncia por unidade se granel percentual 51. Campo obrigatrio para clientes que operam transferncia pelo Banco do Brasil quando o favorecido

utilizar conta do Banco do Brasil. 52. Deve ser informado somente se viagem.quitacao.desconto.tipo=2 ou viagem.quitacao.desconto.tipo=3. 53. Valores de diferena de frete somente para cargas GRANEL

54. Campos vlidos somente quando informado Origem e Destino

55. Se no informado o campo assume o valor default 2 - MAIS RPIDO-VIAS PRIORITRIAS 56. Se o parmetro viagem.pedagio.solucao.id informado for 6-TAG, a opo viagem.pedagio.roteirizar =S

obrigatria. 57. Parmetro viagem.obter.uf = S retorna lista de ufs de rota cadastrada.


Campos de Retorno

RETORNO




3 viagem.antt.ciot.numero Numrico 12

4 viagem.antt.ciot.protocolo Numrico 4

5 viagem.destino.cidade.nome Alfa 50

6 viagem.destino.estado.nome Alfa 50

7 viagem.destino.pais.nome Alfa 50

8 viagem.digito numrico 1

9 viagem.id alfanumrico 10

10 viagem.origem.cidade.nome Alfa 50

12 viagem.origem.estado.nome Alfa 50

13 viagem.origem.pais.nome Alfa 50

14 viagem.pedagio.km Decimal 19,4

15 viagem.pedagio.pracaN.km Decimal 19,4

16 viagem.pedagio.pracaN.nome Alfanumrico 110

17 viagem.pedagio.praaN.seq Numrico 2

18 viagem.pedagio.pracaN.valor decimal 9,2

19 viagem.pedagio.qtde numrico 2

20 viagem.pedagio.tempo.percurso alfanumrico 15




21 viagem.pedagio.valor decimal 19,4

22 viagem.ponto.qtde Alfa 50

23 viagem.pontoN.cidade.nome Alfa 50

24 viagem.pontoN.estado.nome Alfa 50

25 viagem.pontoN.km Decimal 19,4

26 viagem.pontoN.pais.nome Alfa 50

27 viagem.rota.nome alfa 50

28 viagem.uf.qtde numrico 2

29 viagem.ufN.sigla alfanumrico 2

Exemplo


transacional.operacao=26 viagem.contratante.documento.numero=27064195000190 #viagem.unidade.documento.tipo=1 #viagem.unidade.documento.numero=27064195000190 #viagem.id.cliente=3009111400 viagem.contrato.numero=061011 #SEM FAVORECIDO viagem.favorecido.qtde=1 viagem.favorecido1.tipo=1 viagem.favorecido1.documento.qtde=1 viagem.favorecido1.documento1.tipo=2 viagem.favorecido1.documento1.numero=56164548934 #viagem.favorecido1.documento2.tipo=5 #viagem.favorecido1.documento2.numero=00169488 #viagem.favorecido1.documento3.tipo=3 #viagem.favorecido1.documento3.numero=1234987465 #viagem.favorecido1.documento3.uf=SSP #viagem.favorecido1.nome=ANILDO LUIZ RISSARDI #viagem.favorecido1.data.nascimento=28/12/1981 #viagem.favorecido1.endereco.logradouro=RUA AUGUSTO GOULART XPTO #viagem.favorecido1.endereco.numero=3144 #viagem.favorecido1.endereco.complemento=CASA 2 #viagem.favorecido1.endereco.bairro=VILA COSTA MELLO #viagem.favorecido1.endereco.cidade.ibge=3550308 #viagem.favorecido1.endereco.cep=03625071 #viagem.favorecido1.telefone.ddd=011 #viagem.favorecido1.telefone.numero=38891276 #viagem.favorecido1.celular.ddd=011 #viagem.favorecido1.celular.numero=81035602 #[email protected] viagem.favorecido1.meio.pagamento=2 #viagem.favorecido1.conta.banco

Documents

Sistema Pamcard - Especificação Integração - Contrato de Frete