Páginas filhas
  • DI Integração Logix x GFE

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

INTEGRAÇÃO LOGIX X GFE

Contexto de negócio (Introdução)

Gestão de Frete Embarcador (SIGAGFE) é um aplicativo desenvolvido sobre a plataforma TOTVS.

Utiliza o framework de funcionalidades do Microsiga Protheus e tem como objetivos funcionais: 

  • Auxiliar no controle dos processos operacionais de recepção e despacho de cargas; 
  • Registrar, provisionar e conferir as despesas decorrentes da contratação de serviços de transporte realizados por terceiros;
  • Suportar a troca de informações entre o contratante e os prestadores de Serviço de Transporte; 
  • Manter os dados relacionados a documentos, custos e despesas com transporte, sincronizados e integrados aos demais módulos do software ERP.

Os Cadastros e Processos que são sincronizados e integrados entre os sistemas, na direção do Logix para o SIGAGFE são:


LogixSIGAGFE
CadastrosFornecedores/Transportadores/ClientesEmitentes

EmbalagensUnitizadores

CidadesCidades



ProcessosEmissão de nota fiscal de saídaDocumentos de Carga



Os Processos realizados dentro do SIGAGFE e que tem informações enviadas aos módulos do Logix são:


SIGAGFELogix
ProcessosDocumentos FiscaisDocumentos de Frete de Vendas

Simulação de frete simplificadaSimulação de frete de venda




Sistemas Envolvidos

  • Protheus / Gestão de Frete Embarcador 
    • Cadastros
    • Expedição e Recebimento
  • Logix:
    • Cadastros Gerais; 
    • Faturamento; 
    • Recebimento de Materiais; 
    • Financeiro; 


Integração

Desenvolvida integração que tem por objetivo permitir aos clientes Logix (BackOffice) o uso do sistema especialista Gestão de Frete Embarcador (SIGAGFE).

A arquitetura utilizada para a integração é a mensageria única/EAI2 na maioria das integrações e REST especificamente na integração do cálculo da simulação do frete pelo GFE na rotina de Pedidos e Faturamento Logix.


Escopo

Envio de dados do Logix para o GFE

Para a sincronização de cadastros e movimentos originados no ERP são associados os Adapters da Mensagem Única nas interfaces do cadastro no ERP.

As principais ações (inclusão, alteração, eliminação) permitindo assim replicação para a base de dados do TOTVS SIGAGFE e ficando os cadastros iguais em ambos os lados.

Também é possível uma carga inicial de dados através por meio de rotina que permite o envio de toda a massa de dados, ou através por meio de filtros (FIN00000).


Recebimento de dados do GFE no Logix

Para a integração dos documentos registrados no TOTVS GFE para o ERP é utilizada uma rotina de execução contínua do próprio EAI2, essa rotina monitora a entrada de XMLs das mensagens únicas mapeadas para recebimento no ERP Logix.

O controle dos dados que estão aptos para integração é efetuado pelo Monitor de integração (EAI10000). 

Cada Adapter utiliza as rotinas de negócio do Logix para processar os dados; ao final de cada processamento interage novamente com o TOTVS SIGAGFE para atribuir o retorno: Sucesso ou Erro.


Pré-requisitos instalação/implantação/utilização

Logix

  • Liberação oficial: release 12.1.19 e posteriores.

  • EAI2/Mensageria única instalado e configurado.


Protheus

  • Liberação oficial: release 12.1.19 e posteriores.

  • Adapter EAI configurado no Configurador (SIGACFG).


Instalação/Atualização


Logix


Configuração das transações do EAI Logix:

 Executar o programa EAI10000 (Monitor EAI)

  •  Acesse o menu Configuração > Aplicativo Hospedeiro. Clicar no botão ‘Buscar novos adapters’ para recarregar os adapter existentes no RPO de acordo com as novas configurações.
  • Acesse o menu Configuração > Aplicativos Externos. Clicar em ‘Incluir’ e depois no botão ‘Configurar’. Selecionar a ‘Classe canal’ correspondente ao produto com o qual queira se comunicar. 
  • No quadro ‘Propriedades’ preencher as informações solicitadas e clicar em ‘Confirmar’. Após isso serão exibidas na tela principal as transações que o aplicativo externo possui e com o qual pode-se trocar informações.
  • Acesse novamente o menu Configuração > Aplicativo Hospedeiro. Clicar no botão ‘Modificar’, em seguida dê dois cliques na coluna ‘Rotas’ de cada mensagem envolvida nesta integração para indicar para qual aplicativo externo/contexto a mesma será enviada.
  • As mensagens abaixo deveram estar habilitadas para o funcionamento da integração:

Mensagem\Transação

Versão

CustomerVendor            

2.000

Invoice

3.011
City1.000
Packaging1.000


Parâmetros Gerais (LOG00087)

  • Aplicar os conversores de parâmetros: sup01869.cnv, sup01876.cnv, sup01864.cnv, sup01879.cnv, sup01877.cnv, sup01878.cnv e vdp02564.cnv.
  • Executar o programa LOG00086 (Administração de Parâmetros) e liberar permissão para os seguintes caminhos:
    • PROCESSO ENTRADAS / FRETES / INTEGRAÇÕES 
    • PROCESSO SAÍDAS / FRETE / FRETE - GFE
  • Os parâmetros abaixo fazem parte desta integração e devem ser devidamente atualizados antes da utilização:

    ParâmetroObjetivo

    CT-e sobre NF de vendas será tratado pelo GFE? (gfe_cte_venda)

    Indica se CT-e sobre NF de vendas será tratado pelo GFE(Gestão de Frete Embarcador) e depois integrado ao Logix.

    Informações
    title
    OBS
    Observação:

    Sim/Não (Alterar para S para habilitar a integração).

    Grupo de despesa padrão para inclusão do conhecimento de frete VIA GFE (grupo_desp_frete_gfe)
    Parâmetro é opcional, se não informado considera:

    1- O grupo de despesa que veio na mensagem Invoice via integração;

    2- Ou se o primeiro não tiver sido informado considera o grupo de despesa padrão para frete de venda. LOG00087: 'Grupo de despesa a ser utilizado nos fretes de venda incluídos pelo SUP0580, SUP9220 e SUP0552.(grp_desp_frete_venda).

    Informações
    title
    OBS
    Observação:

    Somente permite informar um grupo de despesa cadastrado no Logix.

    Condição de pagamento sem pagamento para recebimento de CTE (cond_pgto_cte_sem_pgto)Indica a condição de pagamento a ser sugerida para preenchimento automático da condição de pagamento, pois o conhecimento de frete não terá pagamento. OBS: Somente permite informar uma condição de pagamento cadastrada no Logix.

    Conhecimento venda integrado GFE pode sofrer modificações no Logix? (ies_conhec_gfe_altera)

    Indica se quando trabalhar com integração do Logix com o GFE permitirá incluir, alterar ou excluir um frete de vendas no Logix.

    1 - Alerta (No sup0580 ao tentar incluir um conhecimento de nota de venda irá alertar que trabalha com integração com GFE e inclusão deveria ser realizada no GFE. Ainda no sup0580, ao tentar modificar ou excluir um conhecimento de notas ficais de venda, alerta o usuário que o frete foi integrado via GFE e a alteração ou exclusão deveria ser realizada no GFE).

    2- Trava (No sup0580 ao tentar incluir um conhecimento de nota de venda irá bloquear a inclusão, avisando que existe a integração com GFE e inclusão deve ser realizada no GFE. Ainda no sup0580, ao tentar modificar ou excluir um conhecimento de notas ficais de venda, bloqueia a transação e avisa ao usuário que o frete foi integrado via GFE e a alteração ou exclusão deverá ser realizada no GFE).

    3- Permite Incluir Modificar ou Excluir Conhecimento( No sup0580 mesmo que esteja com a integração GFE ligada irá permitir incluir, modificar ou excluir qualquer conhecimento de frete, sem exibir aviso em tela).

    Assume automaticamente erros do frete recebido via integração GFE? (assu_auto_erro_integ_fret_gfe)

    Indica se assume automaticamente os erros na consistência do frete, recebido via integração GFE.

    Informações
    title
    OBS
    Observação:

    Sim/Não (Alterar para S para habilitar a integração).

    Diretório XML Frete/Venda quando empresa trabalha com integração GFE (diretorio_gfe_cte_v)

    Caso empresa trabalhar com integração do Logix com GFE (Gestão do Frete Embarcador) e os fretes de venda são tratados pelo GFE, então no JOB de Recebimento de XML de Nota/Frete no TOTVS Colaboração irão mover os XML's que forem de frete relacionado a nota fiscal de venda para este diretório. Posteriormente o Gfe irá buscar estes XMLs deste diretório e importar no módulo para cálculos e tratamentos do frete.

    Utilizar integração com o GFE - Gestão de Frete Embarcador? (utiliza_integracao_gfe)

    Indica se utiliza integração com o produto Gestão de Frete Embarcador (GFE) para simulação, cálculo e controle do frete no processo saídas.

    Servidor e porta para requisições dos serviços REST do módulo de GFE.  (servidor_de_servicos_rest_gfe)

    Informar o IP do servidor e porta para realização das requisições dos serviços REST disponíveis para integração entre o produto Logix e o módulo do GFE (Gestão de Frete Embarcador).

Relacionamento De/Para de Empresa/Filial:

Para que uma mensagem de integração possa ser recebida, é necessário informar o código da empresa e/ou filial do sistema de origem.

Quando uma mensagem é recebida pelo Logix, a partir da “Empresa Externa” e “Filial Externa” existentes na TOTVSMessage o sistema identificará qual é a “Empresa Logix” para atualização dos dados. Estas informações são registradas no LOG00083 (Cadastro de Empresas).

Informações
titleNota:

Para que estes campos possam ser informados é necessário ativar o parametro “Permite informar empresa/filial externa no cadastro de empresas?”,

no

no LOG00087.


Totvs Colaboração

Como a recepção do frete de venda é realizada diretamente no GFE o mesmo é desviado da recepção via Totvs Colaboração no Suprimentos/Logix. 

Para isso é feito um desvio, e são movidos os XMLs do frete de venda para o diretório parametrizado no LOG00087: "Diretório XML Frete/Venda quando empresa trabalha com integração GFE".
Posteriormente o GFE irá buscar estes XMLs deste diretório e importar no Protheus SIGAGFE para cálculos e tratamentos do frete e após então o Conhecimento é enviado e integrado ao Logix.


Tratamentos no ERP

    • Conforme parametrização nos Parâmetros Gerais Logix "Conhecimento venda integrado GFE pode sofrer modificações no Logix?" permitirá incluir, alterar ou excluir um frete de vendas no Logix.
      Se parâmetro igual a "1" no sup0580 ao tentar incluir um conhecimento de nota de venda irá alertar que trabalha com integração com GFE e inclusão deveria ser realizada no GFE.
      Ainda no sup0580, ao tentar modificar ou excluir um conhecimento de notas ficais de venda, alerta o usuário que o frete foi integrador via GFE e a alteração ou exclusão deveria ser realizada no GFE).
      Se parâmetro igual a "2" no sup0580 ao tentar incluir um conhecimento de nota de venda irá bloquear a inclusão, avisando que existe a integração com GFE e inclusão deve ser realizada no GFE. Ainda no sup0580, ao tentar modificar ou excluir um conhecimento de notas ficais de venda, bloqueia a transação, e avisa ao usuário que o frete foi integrado via GFE e a alteração ou exclusão deverá ser realizada no GFE).
      E se parâmetro igual a "3" permitirá Incluir Modificar ou Excluir Conhecimento normalmente no sup0580 mesmo que esteja com a integração GFE ligada.


Protheus


Configuração do Adapter EAI:

  • Para realizar o cadastro das mensagens únicas que serão utilizadas na integração, é necessário acessar Configurador (SIGACFG) > Ambiente > Schedule > Adapter EAI.
  • As mensagens deverão ser cadastradas conforme a tabela abaixo:

    MensagemRotinaDescriçãoEnviaRecebeMétodoVersão
    InvoiceGFEA044Notas Fiscais de SaídaNãoSimAssíncrono3.011
    CustomerVendorGFEA015EmitentesNãoSimSíncrono2.000
    CityGFEA020CidadesNãoSimSíncrono1.000














Relacionamento De/Para de Empresa/Filial:

  • Para realizar a configuração do De/Para de Empresa/Filial, é necessário acessar Configurador (SIGACFG) > Ambiente > Schedule > Empresa Filial Mensagem Única.
  • Os campos necessários para o cadastro são:
    • Referência: Informe uma referência para o cadastro.
    • Empresa: Informe o código da empresa do Logix.
    • Filial: Informe o código da filial do Logix.
    • Grupo de Empresa Protheus: Informe o grupo de empresa do Protheus.
    • Filial Protheus: Informe a filial do Protheus.

Configuração do Schedule do Adapter EAI:

  • Para configurar o Schedule do Adapter EAI, acesse Configurador (SIGACFG) > Ambiente > Schedule > Schedule e inicie o serviço Task Manager e o Qeue Manager.
  • Em Agent, inclua um cadastro para o ambiente Protheus.
  • Em EAI, é possível consultar as mensagens enviadas e recebidas pelo EAI.


Configuração do REST:


Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.


Suporte

O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos Logix e Protheus SIGAGFE estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.


Transações/Entidades/Mensagens únicas


 


Método

IDDescriçãoOrigemDestinoXSD / API REST

Cadastros

01Cliente/Fornecedor/TransportadorLogixProtheusCustomerVendor_2_000.xsd
02EmbalagemLogixProtheus

Packaging_1_000.xsd

03CidadesLogixProtheus

City_1_000.xsd

Processos

01Documento de Frete de VendaProtheusLogixInvoice_3_011.xsd
02Nota fiscal de saídaLogixProtheusInvoice_3_011.xsd
03Simulação de frete de vendaProtheusLogixFREIGHTSIMULATION

Fluxo das Informações


Cadastros

A seguir temos as rotinas responsáveis pelos cadastros das informações da integração:

IDDescriçãoOrigemDestinoXSD
01Fornecedor/TransportadorLogixProtheusCustomerVendor_2_000.xsd
02ClienteLogixProtheusCustomerVendor_2_000.xsd
03CidadeLogixProtheusCity_1_000.xsd
04EmbalagemLogixProtheusPackaging_1_000.xsd


Ao executar o programa FIN00000 (Programas conversores), usuário poderá fazer a carga inicial dos cadastros:

  • Fornecedor/Transportador
  • Cliente
  • Embalagens
  • Cidades

Fornecedor/Transportador - CustomerVendor

Identificador da Mensagem: CustomerVendor

Versão: 2

Tipo de Envio: Síncrona

Gatilho: Ao executar inclusão, modificação e exclusão do cadastro de Cliente/Fornecedor no programa VDP10000, irá gerar mensagem única, enviada para o Protheus.


Mensagem Padrão

PROTHEUS

LOGIX

Tabela

Campo

Tabela

Campo

Code



fornecedorcod_fornecedor

ShortName



fornecedorraz_social_reduz

Name



fornecedorraz_social
Type = "Vendor"



EntityType= "Person"/"Company"



RegisterDate

fornecedordat_cadast
RegisterSituation= "Active"/"Inactive"

fornecedories_fornec_ativo
GovernmentalInformation/Id scope="Federal" name="CNPJ" issueOn="0001-01-01" expiresOn="9999-12-31"

fornecedornum_cgc_cpf
GovernmentalInformation/Id scope="State" name="Inscricao Estadual" issueOn="0001-01-01" expiresOn="9999-12-31"

fornecedorins_estadual
GovernmentalInformation/Id scope="Municipal" name="Inscricao Municipal" issueOn="0001-01-01" expiresOn="9999-12-31"

fornec_complins_municipal
GovernmentalInformation/Id scope="Federal" name="Inscricao Pis" issueOn="0001-01-01" expiresOn="9999-12-31"

sup_par_fornecedor onde empresa = 'SE' e parametro = "num_inscr_inss_2"parametro_texto
GovernmentalInformation/Id scope="Federal" name="NIF" issueOn="0001-01-01" expiresOn="9999-12-31"

sup_par_fornecedor onde empresa = 'SE' e parametro = "num_ident_fiscal"parametro_texto
Address/Address

fornecedorend_fornec
Address/Number

vdp_cli_fornec_cplnum_iden_lograd
Address/Complement

vdp_cli_fornec_cplcompl_endereco
Address/City/CityCode

obf_cidade_ibge (Origem=fornecedor)cidade_ibge/(Origem=cod_cidade)
Address/City/CityDescription

cidadesden_cidade
Address/District

fornecedorden_bairro
Address/State/StateCode

cidadesuni_feder
Address/State/StateDescription

uni_federden_uni_feder
Address/Country/CountryCode

uni_federcod_pais
Address/Country/CountryDescription

paisesden_pais
Address/ZIPCode

fornecedorcod_cep
Address/InternationalDiallingCode

vdp_cli_parametro onde parametro = "ddi_telefone_eai"texto_parametro
Address/DiallingCode

vdp_cli_parametro onde parametro = "ddd_telefone_eai"texto_parametro
ListOfCommunicationInformation/CommunicationInformation/PhoneNumber

fornecedornum_telefone
ListOfCommunicationInformation/CommunicationInformation/FaxNumber

fornecedornum_fax
ListOfCommunicationInformation/CommunicationInformation/Email

fornec_complendereco_web
ListOfBankingInformation/BankingInformation/BankCode

agencia_bcocod_agen_bco
ListOfBankingInformation/BankingInformation/BankName

bancosnom_banco
ListOfBankingInformation/BankingInformation/BranchCode

fornecedornum_agencia
ListOfBankingInformation/BankingInformation/BranchKey

fornecedornum_agencia
ListOfBankingInformation/BankingInformation/CheckingAccountNumber

fornecedornum_conta_banco
ListOfBankingInformation/BankingInformation/CheckingAccountNumberKey

fornecedornum_conta_banco
VendorInformation/VendorType/Code

fornecedories_tip_fornec

ListOfBankingInformation/BankingInformation/VendorTypeDescription=

Fornecedor, Transportador, Cliente, Fornecedor/Cliente, Fornecedor/Transportador, Produtor Rural, Prestador de Serviço, Município, Cooperado, Microempreendedor individual.











Limitações/Restrições

  • Para esta integração, não indica-se trabalhar com Transportador cadastrado no VDP10000 como tipo "2"-Apenas transportadora. Alterar o tipo do mesmo para "5"-Fornecedor/Transportador.
  • Para trabalhar com a integração é necessário estar trabalhando com TSS 2.000. Somente esta versão foi possível implementação para realizar o desvio e desconsiderar os Conhecimentos de Venda para que sejam tratados pelo GFE.

Cliente - CustomerVendor

Identificador da Mensagem: CustomerVendor

Versão: 2

Tipo de Envio: Síncrona

Gatilho: Ao executar inclusão, modificação e exclusão do cadastro de Cliente/Fornecedor no programa VDP10000, irá gerar mensagem única, enviada para o GFE.


Tag(*)

Descrição

Origem da Informação - Logix

Destino - GFE

_Code

Código do cliente

CLIENTES.cod_cliente


_ShortName

Nome reduzido do cliente

VDP_CLI_FORNEC_CPL.razao_social_reduz


_Name

Nome do cliente

VDP_CLI_FORNEC_CPL.razao_social


_Type(**)

Tipo de registro (Cliente = “Customer”; Fornecedor = “Vendor”; Ambos = “Both”)

Para esta mensagem será “Customer”


_EntityType

Tipo de pessoa (Pessoa Física = “Person”; Pessoa Jurídica = “Company”)

Se o cliente tiver CPF, será considerado “Person”, caso contrário será “Company”


_RegisterDate

Data de cadastro do cliente

CLIENTES.dat_cadastro


_RegisterSituation

Situação do cliente (Ativo = “Active”; Inativo = “Inactive”; Cancelado = “Canceled”; Pendente = “Pending”; Suspenso = “Suspended”)

CLIENTES.ies_situacao


_GovernmentalInformation

Esta tag pode conter até 5 (cinco) informações diferentes, que são diferenciadas pelo atributo _Name:

_Name

_Scope

_Id

_ExpiresOn

“CPF”

“Federal”

CPF do fornecedor (quando Pessoa Física)

NULL

“CNPJ”

“Federal”

CNPJ do fornecedor (quando Pessoa Jurídica)

NULL

“Inscricao Estadual”

“State”

Número da Inscrição Estadual do fornecedor

NULL

“Inscricao Municipal”

“Municipal”

Número da Inscrição Municipal do fornecedor

NULL

“Suframa”

“Federal”

Número do registro no SUFRAMA

Data de validação do registro no SUFRAMA

CPF → CLIENTES.num_cgc_cpf


CNPJ → CLIENTES.num_cgc_cpf


Inscrição Estadual → CLIENTES.ins_estadual


Inscrição Municipal → VDP_CLI_PARAMETRO.texto_parametro (filtrar pelo parâmetro “ins_municipal”)


Suframa → CLIENTES.num_suframa e VDP_CLI_PARAMETRO.dat_parametro (filtrar pelo parâmetro “dat_validade_suframa”)



_Address._Address

Endereço do cliente

VDP_CLI_FORNEC_CPL.logradouro


_Address._Number

Número do endereço do cliente

VDP_CLI_FORNEC_CPL.num_iden_lograd


_Address._Complement

Complemento do endereço do cliente

VDP_CLI_FORNEC_CPL.compl_endereco


_Address._City._Code

Código da cidade do endereço do cliente. Será considerado o código IBGE, conforme cadastro nacional.

CLIENTES.cod_cidade

Informações
title
OBS
Observação:
Através

Por meio desta informação é obtido o código IBGE na tabela OBF_CIDADE_IBGE) conforme parâmetro "Máscara do código da cidade IBGE na mensagem de integração vai EAI" no LOG00087


_Address._City._Description

Nome da cidade do cliente

CIDADES.den_cidade


_Address._District

Bairro do cliente

VDP_CLI_FORNEC_CPL.bairro


_Address._State._Code

Sigla do estado (UF) do cliente

CLIENTES.cod_uni_feder

Informações
title
OBS
Observação:

Se a UF do cliente não for uma das unidades de federação brasileiras é fixado o valor “EX” (Exterior).


_Address._State._Description

Nome do estado (UF) do cliente

UNI_FEDER.den_uni_feder


_Address._Country._Code

Código do país do cliente

UNI_FEDER.cod_pais


_Address._Country._Description

Nome do país do cliente

PAISES.den_pais


_Address._ZIPCode

Código de Endereçamento Postal (CEP) do cliente

CLIENTES.cod_cep

Informações
title
OBS
Observação:

São considerados apenas os dígitos.


_Address._POBox

Número da caixa postal do cliente

CLIENTES.num_caixa_postal


_ShippingAddress._Address

Endereço de entrega do cliente

CLI_END_ENT.logradouro


_ShippingAddress._Number

Número do endereço de entrega do cliente

CLI_END_ENT.num_iden_lograd


_ShippingAddress._Complement

Complemento do endereço de cobrança do cliente

CLI_END_ENT.complemento_endereco


_ShippingAddress._City._Code

Código da cidade do endereço de entrega do cliente. Será considerado o código IBGE, conforme cadastro nacional.

CLI_END_ENT.cod_cidade

Informações
title
OBS
Observação:
Através

Por meio desta informação é obtido o código IBGE na tabela OBF_CIDADE_IBGE) conforme parâmetro "Máscara do código da cidade IBGE na mensagem de integração vai EAI" no LOG00087


_ShippingAddress._City._Description

Nome da cidade de entrega do cliente

CIDADES.den_cidade


_ShippingAddress._District

Bairro de entrega do cliente

CLI_END_ENT.den_bairro


_ShippingAddress._State._Code

Sigla do estado (UF) de entrega do cliente

CIDADES.cod_uni_feder

Informações
title
OBS
Observação:

Se a UF do cliente não for uma das unidades de federação brasileiras é fixado o valor “EX” (Exterior).


_ShippingAddress._State._Description

Nome do estado (UF) de entrega do cliente

UNI_FEDER.den_uni_feder


_ShippingAddress._Country._Code

Código do país de entrega do cliente

UNI_FEDER.cod_pais


_ShippingAddress._Country._Description

Nome do país de entrega do cliente

PAISES.den_pais


_ShippingAddress._ZIPCode

Código de Endereçamento Postal (CEP) de entrega do cliente

CLI_END_ENT.cod_cep

Informações
title
OBS
Observação:

São considerados apenas os dígitos.


_ListOfCommunicationInformation.

_PhoneNumber

Número do telefone do cliente

VDP_CLI_FORNEC_CPL.telefone_1


_ListOfCommunicationInformation.

_FaxNumber

Número do fax do cliente

CLIENTES.num_fax


_ListOfCommunicationInformation.

_HomePage

Home (site) do cliente

VDP_CLI_FORNEC_CPL.endereco_web


_ListOfCommunicationInformation.

_Email

Email principal do cliente

VDP_CLI_FORNEC_CPL.correio_eletronico


_ListOfContacts._Code

Código do contato do cliente

CLI_CONTATOS.num_contato


_ListOfContacts._Name

Nome do contato do cliente

CLI_CONTATOS.nom_contato


_ListOfContacts._Department

Departamento do contato do cliente

CLI_CONTATOS.departno


_ListOfContacts.

_CommunicationInformation.

_PhoneNumber

Telefone do contato do cliente

CLI_CONTATOS.num_telefone


_ListOfContacts.

_CommunicationInformation.

_PhoneExtension

Ramal do contato do cliente

CLI_CONTATOS.num_ramal


_ListOfContacts.

_CommunicationInformation.

_FaxNumber

Fax do contato do cliente

CLI_CONTATOS.num_fax


_ListOfContacts.

_CommunicationInformation._Email

Fax do contato do cliente

CLI_CONTATOS.email


_Billinginformation._Address

Endereço de cobrança do cliente

CLI_END_DET_COBRANCA_ENTREGA.logradouro


_Billinginformation._Number

Número do endereço de cobrança do cliente

CLI_END_DET_COBRANCA_ENTREGA.num_iden_lograd


_Billinginformation._Complement

Complemento do endereço de cobrança do cliente

CLI_END_DET_COBRANCA_ENTREGA.complemento_endereco


_Billinginformation._City._Code

Código da cidade do endereço de cobrança do cliente. Será considerado o código IBGE, conforme cadastro nacional.

CLI_END_DET_COBRANCA_ENTREGA.cod_cidade

Informações
title
OBS
Observação:
Através

Por meio desta informação é obtido o código IBGE na tabela OBF_CIDADE_IBGE) conforme parâmetro "Máscara do código da cidade IBGE na mensagem de integração vai EAI" no LOG00087


_Billinginformation._City._Description

Nome da cidade de cobrança do cliente

CIDADES.den_cidade


_Billinginformation._District

Bairro de cobrança do cliente

CLI_END_COB.den_bairro


_Billinginformation._State._Code

Sigla do estado (UF) de cobrança do cliente

CIDADES.cod_uni_feder

Informações
title
OBS
Observação:

Se a UF do cliente não for uma das unidades de federação brasileiras é fixado o valor “EX” (Exterior).


_Billinginformation._State._Description

Nome do estado (UF) de cobrança do cliente

UNI_FEDER.den_uni_feder


_Billinginformation._Country._Code

Código do país de cobrança do cliente

UNI_FEDER.cod_pais


_Billinginformation._Country._Description

Nome do país de cobrança do cliente

PAISES.den_pais


_Billinginformation._ZIPCode

Código de Endereçamento Postal (CEP) de cobrança do cliente

CLI_END_COB.cod_cep

Informações
title
OBS
Observação:

São considerados apenas os dígitos.


_CreditInformation._CreditLimit

Limite de crédito do cliente

CLI_CREDITO.val_limite_cred


_CreditInformation._CreditLimitCurrency

Código da moeda na qual está expresso o valor de limite de crédito do cliente

PAR_CON.cod_moeda_padrao


_CreditInformation._CreditLimitDate

Data do limite de crédito do cliente

CLI_CREDITO.dat_val_lmt_cr


_CreditInformation._LatePeriods

Quantidade de dias para atraso de pagamento de duplicatas

CLI_CREDITO.qtd_dias_atr_dupl


Informações
titleNotas:

(*) As tag´s existentes no XSD (schema) da mensagem e que não foram mencionadas na lista acima não possuem tratamento na integração, ou seja, não são consideradas no envio da mensagem;

(**) Nos casos de registros do tipo “Ambos” (onde uma empresa é cliente e fornecedor ao mesmo tempo), o Logix enviará duas mensagens para o GFE, uma com o tipo “Customer” e outra com o tipo “Vendor”.

Cidade - City

Identificador da Mensagem: City

Versão: 1

Tipo de Envio: Síncrona

Gatilho: Ao executar inclusão, modificação e exclusão do cadastro de UF e Cidades (VDP10022) , irá gerar mensagem única, enviada para o GFE.


Tag

Descrição

Origem da Informação - Logix

Destino - GFE

_Code

Código da cidade

OBF_CIDADE_IBGE.cidade_logix


_OfficialCode(*)

Código oficial da cidade (IBGE)

OBF_CIDADE_IBGE.cidade_ibge

Informações
title
Obs
Observação:

Conforme parâmetro "Máscara do código da cidade IBGE na mensagem de integração vai EAI" no LOG00087


_Description

Descrição da cidade

CIDADES.den_cidade


_FederalUnit

Unidade de federação

OBF_CIDADE_IBGE.estado_logix


Informações
titleNota:

(*) Para a integração de cidades é considerado como campo chave entre os sistemas o código oficial, proveniente do IBGE. Desta forma, no Logix torna-se obrigatório o preenchimento desta informação no cadastro de cidades (VDP10022), quando esta mensagem estiver habilitada para envio.

Embalagem - Packaging

Identificador da Mensagem: Packaging

Versão: 1

Tipo de Envio: Síncrona

Gatilho: Ao executar inclusão, modificação e exclusão do cadastro de Embalagens (VDP10026) , irá gerar mensagem única, enviada para o GFE.


Tag

Descrição

Origem da Informação - Logix

Destino - GFE

_Code

Código da embalagem

EMBALAGEM.cod_embal


_Description

Descrição da embalagem

EMBALAGEM.den_embal


_Weight

Peso da embalagem

EMBALAGEM.pes_unit


_Height

Altura da Embalagem

EMBALAGEM.altura


_WidthLargura da embalagemEMBALAGEM.largura
_DepthProfundidade da embalagemEMBALAGEM.profundidade
_VolumeVolume da embalagemEMBALAGEM.volume



Processos 

A seguir temos os processos que transitam entre os produtos na integração:

IDDescriçãoOrigemDestinoXSD / API REST
01Conhecimento de frete de VendaProtheusLogixInvoice_3_011.xsd
02Nota fiscal de saídaLogixProtheusInvoice_3_011.xsd
03Simulação de frete de vendaProtheusLogixFREIGHTSIMULATION

Conhecimento de Frete de Venda - Invoice

Identificador da Mensagem: Invoice

Versão: 3

Tipo de Envio: Assíncrona

Ao receber a Invoice no Logix com tag indicando que trata-se de um conhecimento de venda (TypeofDocument = "COV") é acionado Adapter EaiAdapterInvoice3.

Este irá incluir ou excluir (de acordo com o tipo de processamento enviado) através de métodos padrões do ERP o conhecimento de frete de venda no Logix.

Para conferir se a integração ocorreu com sucesso pode-se utilizar a consulta do Status e Passo-a-passo no Monitor de integração do EAI: EAI100000. 

Para validar o documento no ERP utilizar o programa Sup0580.

  • Consistência
    Após a inclusão do conhecimento é automaticamente processada a consistencia do documento.
    Os valores da integração são carregados no declarado, para manter o histórico e acusar erro de diferença entre declarado e calculado caso algum parâmetro do Logix precise ser revisto.
    Pode ocorrer inconsistência no frete entre declarado e calculado, devido a cadastros que precisam ser arrumados no ERP. Se não forem revistos não há problema, visto que o valor declarado prevalece sobre o calculado. O único inconveniente é que a cada proxima nota que entrar continuará acusando diferença entre declarado e calculado.
    Se o parâmetro do Log00087 "Assume automaticamente erros dos conhecimentos recebidos via integração Gfe?" igual a "S" então após realizar a consistência, já assumir os erros do frete automaticamente. Irá cadastrar automaticamente o usuário que está integrando (usuário integrador) no Sup34698-Usuários responsáveis por assumir erros de frete.
    Conforme padrão do Recebimento, caso esteja parametrizado para contabilização online já irá gerar os lançamentos contábeis automaticamente na integração, assim como a integração com o fiscal. 
    Não integra com o Financeiro visto que a condição de pagamento é sem pagamento. E o Financeiro é tratado diretamente do GFE que envia os dados ao Módulo financeiro do Logix via integração.
    Também integra automaticamente com o GAO-Gestão de Aprovação de Orçamento, caso empresa trabalhe com este conceito.


Mensagem Padrão

PROTHEUS

LOGIX

Tabela

Campo

Tabela

Campo

CompanyId



frete_supcod_empresa
InvoiceNumber

frete_supnum_conhec

InvoiceSerie



frete_supser_conhec
InvoiceModel

sup_compl_fret_supreservado
TypeOfDocument = "COV"

frete_supies_tip_frete = "V"
VendorCode

frete_supcod_transpor
IssueDate

sac_embarquedat_entrega
InvoiceAmount

frete_supval_frete
InsuranceAmount

sup_par_frete onde parametro = "val_seguro_frt"parametro_texto
PaymentConditionCode

frete_supcnd_pgto_frt
PaymentConditionCode

frete_supcnd_pgto_tab
TaxOpCode

frete_supcod_fiscal_frete
TaxOperationCodeComplement

frete_supcod_fiscal_compl
GrossWeight

frete_suppes_vol_frete
ElectronicAccessKey

sup_par_frete onde parametro = "num_ft_eletronica"parametro_texto
ElectronicProtocol

sup_par_frete onde parametro = "chave_acesso_cte"parametro_texto
ElectronicKeyJustification

sup_par_frete onde parametro = "justif_chave_cteparametro_texto
ElectronicKeyJustification

obf_justif_cte_sefazjustificativa
TollValue

pedagio_freteval_pedagio
ListofRelatedInvoices/RelatedInvoices/InvoiceNumber

frete_sup_x_nffnum_nff
ListofRelatedInvoices/RelatedInvoices/InvoiceSerie

frete_sup_x_nffser_nf_saida
ListofRelatedInvoices/RelatedInvoices/InvoiceDateIssue

frete_sup_x_nffdat_hr_emis_nota_fiscal_fatura
ItemExpenseGroupCode

frete_supgru_ctr_desp_frete
ListofItens/Item/ListofTaxes/Taxe = "ICMS"



ListofItens/Item/ListofTaxes/CalculationBasis

frete_supval_base_c_frete_c
ListofItens/Item/ListofTaxes/Value

frete_supval_tot_icms_frt_c
ListofItens/Item/ListofTaxes/Taxe = "RETEN_INSS"



ListofItens/Item/ListofTaxes/CalculationBasis

sup_par_frete onde parametro = "bc_retencao_inss"parametro_val
ListofItens/Item/ListofTaxes/Percentage

sup_par_frete onde parametro = "perc_reten_inss"parametro_val
ListofItens/Item/ListofTaxes/HasTax

sup_par_frete onde parametro = "RETEN_INSS"par_ind_especial
ListofItens/Item/ListofTaxes/Taxe = "RECOLH_INSS"



ListofItens/Item/ListofTaxes/CalculationBasis

sup_par_frete onde parametro = "bc_recolhimento_inss"parametro_val
ListofItens/Item/ListofTaxes/HasTax

sup_par_frete onde parametro = "RECOLHIMENTO_INSS"par_ind_especial
ListofItens/Item/ListofTaxes/Taxe = "RETEN_ISS"



ListofItens/Item/ListofTaxes/HasTax

sup_par_frete onde parametro = "RETEN_ISS"par_ind_especial
ListofItens/Item/ListofTaxes/Taxe = "RETEN_SEST_SENAT"



ListofItens/Item/ListofTaxes/HasTax

sup_par_frete onde parametro = "RETEN_SEST_SENAT"par_ind_especial
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/AccountantAcountInternalId

dest_frete_supnum_conta_deb_desp
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/ProjectInternalId

dest_frete_supcod_area_negocio
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/SubProjectInternalId

dest_frete_supcod_lin_negocio
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/Percentual

dest_frete_suppct_particip_comp
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/AccountantAcountInternalId

dest_frete_sup4num_conta_deb_desp
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/ProjectInternalId

dest_frete_sup4cod_area_negocio
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/SubProjectInternalId

dest_frete_sup4cod_lin_negocio
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/MarketSegmentCode

dest_frete_sup4cod_seg_merc
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/ClassValueCode

dest_frete_sup4cod_cla_uso
ShippingAddress/City/CityCode

frete_sup_complcod_cidade

Limitações / Restrições Gerais

  • Percentual de ICMS - Busca alíquota do Logix da tabela de ICMS por grupo de despesa.
  • Somente grava a dest_frete_sup4 quando trabalha com 4 níveis de AEN, caso contrário grava apenas a dest_frete_sup.
  • Cidade é opcional - se informada busca a aliquota de ICMS dessa cidade no calculo do ICMS no frete, ao invés do padrão que é buscar de acordo com a UF do transportador.
  • PaymentConditionCode é opcional - Se informado parâmetro no Log00087 - "Condição de pagamento sem pagamento para recebimento de CTE" irá assumir esta condição de pagamento para o frete.

Nota Fiscal de Saída - Invoice

Identificador da Mensagem: Invoice

Versão: 3

Tipo de Envio: Assíncrona

Gatilho: Sempre que realizado o envio de uma nota fiscal de saída para a SEFAZ, após a geração da chave de acesso será feito o envio da nota fiscal via mensagem única (EAI2) para o GFE.

Quando a nota fiscal possuir tipo de frete diferente de 3 (FOB) será adicionado o contexto "gfe" na mensagem. Dessa forma é possível parametrizar no EAI10000 (EAI) apenas o envio de notas fiscais com frete para o GFE, utilizando-se do conceito de "rotas".


Tag(*)

Descrição

Campo de Origem da Informação

Campo de Destino da Informação

_CompanyId

Código da empresa

FAT_NF_MESTRE.empresa

GW1_FILIAL

_InvoiceNumber

Número da nota fiscal

FAT_NF_MESTRE.nota_fiscal

GW1_NRDC

_InvoiceSerie

Série da nota fiscal

FAT_NF_MESTRE.serie_nota_fiscal

GW1_SERDC
_InvoiceModelModelo da Nota Fiscal (Convênio ICMS 31/99)FAT_NF_MESTRE.modelo_nota_fiscalN/A
_InvoiceSituationSituação da Nota Fiscal (1-Normal 2-Cancelada)FAT_NF_MESTRE.sit_nota_fiscalN/A
_TypeOfDocumentTipo do documento (Controle da natureza de operação)NAT_OPERACAO.ies_tip_controleGW1_CDTPDC
_IssueDateData de EmissãoFAT_NF_MESTRE.dat_hor_emissaoGW1_DTEMIS
_InvoiceAmountValor da Nota FiscalFAT_NF_MESTRE.val_nota_fiscalN/A
_ValueofGoodsValor da MercadoriaFAT_NF_MESTRE.val_mercadoriaN/A
_FreightAmountValor do freteFAT_NF_MESTRE.val_frete_rodovN/A
_InsuranceAmountValor do SeguroFAT_NF_MESTRE.val_seguro_rodovN/A
_DiscountAmountValor do DescontoFAT_NF_MESTRE.val_desc_nfN/A
_CurrencyRateTaxa da Moeda Utilizada para Calcular o Valor da Nota FiscalCOTACAO.val_cotacao (ou PED_INF_COM_MESTRE.val_cotacao_fixa caso informada cotação fixa no pedido)N/A

_CustomerCode

Código do Cliente

FAT_NF_MESTRE.cliente

GW1_CDDEST
_CarrierCodeCódigo do TransportadorFAT_NF_MESTRE.transportadoraGWU_CDTRP
_ElectronicAccessKeyChave de acesso eletrônicaOBF_NF_ELETR.chave_acessoGW1_DANFE

_ListOfItems.

_InvoiceSequence

Sequência do item da nota fiscal

FAT_NF_ITEM.seq_item_nf

GW8_SEQ

_ListOfItems.

_OrderNumber

Número do Pedido que Originou o Item da Nota

FAT_NF_ITEM.pedido

GW1_PEDCLI

_ListOfItems.

_OrdemItem

Sequência do Item do Pedido que Gerou o Item da Nota

FAT_NF_ITEM.seq_item_pedido

N/A

_ListOfItems.

_ItemCode

Código do item

FAT_NF_ITEM.itemGW8_ITEM

_ListOfItems.

_Quantity

Quantidade do Item

FAT_NF_ITEM.qtd_item

GW8_QTDE

_ListOfItems.

_UnitofMeasureCode

Código da Unidade de MedidaFAT_NF_ITEM.unid_medidaN/A

_ListOfItems.

_UnityPrice

Preço Unitário do Item x Taxa da Moeda

FAT_NF_ITEM.preco_unit_bruto

N/A

_ListOfItems.

_GrossValue

Valor Bruto do Item. (Quantidade x Preço Unitário x Taxa da Moeda)

FAT_NF_ITEM.preco_unit_liquido

GW8_VALOR

_ListOfItems.

_FreightValue

Valor do Frete Unitário

FAT_NF_ITEM.val_frete_cliente

N/A

_ListOfItems.

_InsuranceValue

Valor do Seguro Unitário

FAT_NF_ITEM.val_seguro_cliente

N/A

_ListOfItems.

_DiscountValue

Valor do Desconto Unitário

FAT_NF_ITEM.val_desc_item


N/A

_ListOfItems.

_NetValue

Valor Líquido (Valor Bruto + Frete + Seguro - Desconto)

FAT_NF_ITEM.val_contab_item

N/A

_ListOfItems.

_AreAndLineOfBusinessCode

Código da área e linha. No Logix será uma string que poderá ter 4 (área/linha de negócio com 2 níveis) ou 8 caracteres (área/linha de negócio com 4 níveis). Os campos serão concatenados sem separador, respeitando a sequencia da chave da tabela "linha_prod".

(FAT_AEN_ITEM_NF.linha_produto + FAT_AEN_ITEM_NF.linha_receita + FAT_AEN_ITEM_NF.segmto_mercado + FAT_AEN_ITEM_NF.classe_uso) ou (ITEM.cod_lin_prod + ITEM.cod_lin_recei + ITEM.cod_seg_merc + ITEM.cod_cla_uso)

GW8_UNINEG

_ListOfItems.

_ItemGrossWeight

Peso total do item mais o peso rateado das embalagens da nota fiscal que estão relacionadas ao item. Peso em Kg

N/A

GW8_PESOR

_ListOfItems.

_ItemNetWeight

Peso liquído total do item em Kg

N/A

N/A

_ListOfItems.

_ItemVolume

Volume total do item em metros cúbicos, considerando as embalagens relacionadas ao item na nota fiscal

N/A

GW8_VOLUME

_ListOfItems.

_ItemDescription

Descrição do item

FAT_NF_ITEM.des_item

GW8_DSITEM

_ShippingAddress.

_Adress

Endereço de entregaFAT_NF_END_ENTREGA.endereco_entregaGW1_ENTEND

_ShippingAddress.

_City.

_CityCode

Código da cidade de entregaFAT_NF_END_ENTREGA.cidade_entregaGW1_ENTNRC

_ShippingAddress.

_District

Bairro de entregaFAT_NF_END_ENTREGA.bairro_entregaGW1_ENTBAI

_ShippingAddress.

_ZIPCode

CEP do endereço de entregaFAT_NF_END_ENTREGA.cep_entregaGW1_ENTCEP

_ListOfConsignee.

_Consignee.

_ConsigneeSequence

Sequência do consignatárioFAT_CONSIG_NF.seq_consignatarioGWU_SEQ

_ListOfConsignee.

_Consignee.

_ConsigneeCode

Código do consignatárioFAT_CONSIG_NF.consignatarioGWU_CDTRP

_ListOfConsignee.

_Consignee.

_FreightType

Tipo de FreteFAT_CONSIG_NF.tip_fret_consigGWU_PAGAR
Informações
titleNota:

(*) As tag´s existentes no XSD (schema) da mensagem e que não foram mencionadas na lista acima não possuem tratamento na integração, ou seja, não são consideradas no envio da mensagem.

Limitações / Restrições Gerais

  • Para as notas fiscais integradas com o GFE não deverá possuir subsérie informada, pois corre-se o risco de gerar duplicidade de numeração durante a integração.
  • É obrigatório utilização do painel da NFE (Parâmetro "Utilizar painel da NF-e e NFS-e?" ativado)

Simulação de Frete de Venda - FREIGHTSIMULATION

Identificador da Mensagem: FREIGHTSIMULATION

Versão: 1

Tipo de Envio: API REST

Gatilho: Através Por meio do botão "Simular frete GFE" localizado na aba "3 - Frete" do programa VDP20000 (Manutenção de Pedidos) ou do botão "simulaR GFE" localizado na tela de transportes dos programas VDP0742 (Faturamento automático) e VDP0746 (Faturamento Manual), é possível realizar a simulação de frete para o pedido/nota fiscal em questão, obtendo informações de transportadoras, valor de frete e imposto, prazo de entrega, rotas, etc diretamente do GFE. É possível realizar filtros por "transportador", "Tipo de veículo", "Classificação de frete" e "Tipo de operação".

Abaixo exemplo da tela de simulação no VDP20000:


Exemplo da tela de simulação utilizada no VDP0742 e VDP0746:

Os registros serão apresentados em ordem crescente de valor de frete, sendo que o primeiro registro (menor valor) sempre será selecionado automaticamente.


Como fazer (opcional)

Os passos para viabilizar a integração são:

  • Setar nos Parâmetros Gerais Logix (Log00087) os parâmetros: "Utilizar integração com o GFE - Gestão de Frete Embarcador? = "S" e "CT-e sobre NF de vendas será tratado pelo GFE?" = "S".
  • Configurar os demais parâmetros descritos na sessão Parâmetros Gerais (LOG00087) desse documento;
  • No Logix efetuar/atualizar o cadastro das seguintes informações: Clientes, fornecedores, transportadores, embalagens e cidades. A integração será efetuada automaticamente pelos programas de cadastro ou podem ser enviados ao GFE via carga de dados (FIN00000).
  • No Vendas/Faturamento Logix efetue o faturamento da nota de saída com tipo de frete diferente de 2 (FOB) e realize o envio para a SEFAZ;
  • No GFE confira as informações do faturamento
  • No GFE efetue a inclusão do conhecimento de frete
  • No Logix efetue a conferência do conhecimento de frete no Sup0580.


Situações comuns (opcional)

  • Quando uma mensagem é enviada do Logix para o Protheus, podem ocorrer situações em que o WebService não estará totalmente funcional. Nestes casos uma mensagem de erro genérica irá aparecer na tela:

Exemplo:

Erro ao enviar a mensagem de Cidade via Integração

Se o arquivo de log for analisado, poderemos ver a falha na comunicação com o sistema destino:

-------------------------------------------------------------------------------

WSCERR044 / Não foi possível POST : URL http://172.16.31.57:8011/ws/FWWSEAI.apw

ADVPL WSDL Client 1.080707 / tst on 20120315 08:49:51

-------------------------------------------------------------------------------

Para resolver este problema, verifique as configurações do sistema de destino, analisando o funcionamento do servidor utilizado para esta comunicação e a habilitação do endereço do WebService. 


Checklist de suporte da aplicação



Anexos