Child pages
  • DI Integração Logix x GFE
Skip to end of metadata
Go to start of metadata

INTEGRAÇÃO LOGIX X GFE

Índice

1. 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.


A integração do ERP Logix com o GFE visa manter os dados cadastrais do ERP, quando necessário, sincronizados ao GFE; manter os dados relacionados a documentos, custos e despesas com transporte, integrados aos demais módulos do ERP e possibilitar a simulação do preço do frete durante os processos do ERP (pedidos de venda, pedidos de compra, faturamento etc.) nos quais essa informação possa ser necessária.

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

CidadesCidades

Plano de ContasContas Contábeis
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

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

Documento de FreteDocumentos de Frete de Vendas

Fatura de FreteApropriação de Despesa


2. Sistemas Envolvidos

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


3. Integração (Fluxograma)

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 mensagem ú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.


4. 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) permitem a integração para a base de dados do TOTVS SIGAGFE, ficando os cadastros iguais em ambos os lados.

Também é possível uma carga inicial de dados, por meio de rotina que permite o envio de toda a massa de dados, ou 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.


5. Pré-requisitos instalação

5.1 Logix

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

  • EAI2/Mensagem única instalado e configurado.


5.2 Protheus

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

  • Atualização da Build 131227a a partir da versão 13.2.3.6.
  • Adapter EAI configurado no Configurador (SIGACFG).


6. Instalação/Atualização

6.1 Logix

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

 Execute o programa EAI10000 (Monitor EAI).

  •  Acesse o menu Configuração > Aplicativo Hospedeiro. Clique no botão Buscar novos adapters para recarregar os adapters existentes no RPO, de acordo com as novas configurações.
  • Acesse o menu Configuração > Aplicativos Externos. Clique em Incluir e depois no botão Configurar. Selecione a Classe canal correspondente ao produto com o qual queira se comunicar. 

  • No quadro Propriedades, preencha as informações solicitadas e clique em Confirmar. Em seguida, serão apresentadas 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. Clique 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 esta será enviada.
  • As mensagens abaixo deverão estar habilitadas para o funcionamento da integração:

    Mensagem\Transação

    Versão

    City1.000

    CustomerVendor            

    2.000

    ListOfAccountantAccount2.002

    Invoice

    3.011
    ListOfAccountPayableDocument1.000

6.1.2 Parâmetros Gerais (LOG00087)

  • Aplique os conversores de parâmetros: sup01878.cnv, sup01876.cnv, sup01864.cnv, sup01868.cnv, sup01908.cnv, sup01909.cnv, sup01913.cnv, vdp02564.cnv, vdp02603.cnv, fin00179.cnv e fin00180.cnv.
  • Execute o programa LOG00086 (Administração de Parâmetros) e libere permissão para os seguintes caminhos:
    • PROCESSO ENTRADAS / FRETES / INTEGRAÇÕES; 
    • PROCESSO SAÍDAS / FRETE / FRETE - GFE.
    • LOGIX FINANCEIRO / CONTAS A PAGAR / TRANSFERÊNCIAS/INTEGRAÇÕES

Os parâmetros abaixo fazem parte desta integração e devem ser devidamente atualizados antes da utilização:

ParâmetroObjetivo
Permite infrmar empresa/filial externa no cadastro de empresas? (integracao_eai_empresa_externa)

Indica se será ou não permitido informar a empresa e filial externa para integração utilizando o EAI.

Habilita o preenchimento no LOG00083 (Cadastro de Empresas) da empresa e filial do Protheus que corresponde à empresa do Logix

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

Conversor: sup01878.cnv

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

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) Conversor: sup01909.cnv

Parâmetro é opcional, se não informado considera:

1- Irá buscar o primeiro grupo cadastrado na tabela de ICMS(Sup0650) com as seguintes características:
  • Estado da cidade destino da mensagem Invoice (Tag: BusinessContent/DestinationCity/CityCode)
  • Percentual de ICMS da mensagem Invoice (Tag: ListOfItens/Item/ListOfTaxes/Taxes/Percentage onde ListOfItens/Item/ListOfTaxes/Taxes/Taxe = "ICM" )
  • Percentual de redução de base de cálculo de ICMS igual a zero (pct_red_base_calc)
  • Percentual de diferencial de aliquota de ICMS igual a zero (pct_diferen_icms)

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) Conversor: sup01876.cnv

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.

Observação:

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)

Conversor: sup01864.cnv

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 a 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 a 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, 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 estiver com a integração GFE ligada, irá permitir incluir, modificar ou excluir qualquer conhecimento de frete, sem apresentar aviso em tela).

CST para PIS sem direito a crédito - frete venda
CST para COFINS sem direito a crédito - frete venda

Conversor: sup01908.cnv

Parâmetro opcional.

Permite informar CST (Código Situação Tributária) PIS/COFINS sem direito a crédito - frete venda.

Não informando continua assumindo CST de PIS/COFINS do configurador fiscal com base no grupo de despesa do frete.

Caso informe CST (exemplo 70 - isento) este será assumido quando não for gerado PIS/COFINS frete venda..

Mais detalhes consultar Faq: LRECFR0021 - Como é calculado o PIS/COFINS para frete venda?


Observação:

Informar CST (Código de Situação Tributária) válida para PIS/COFINS.

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

Conversor: sup01913.cnv

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

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)

Conversor: sup01868.cnv

Caso a empresa trabalhar com integração do Logix com GFE (Gestão de 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 de frete relacionados 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.

URL do serviço REST para requisições do módulo GFE (servidor_de_servicos_rest_gfe)

Conversores: vdp02564.cnv e vdp02603.cnv

Informar a URL completa do serviço REST disponibilizada pelo GFE (Gestão de Frete Embarcador) para integração entre os produtos. Essas informações deverão ser obtidas na seção HTTPV11 do appserver.ini do Application Server do GFE.

Exemplo: http://192.168.10.1:8030/rest/

Tipo de despesa para ADs de faturas originadas no GFE  (fin_tip_desp_fatura_gfe)Informar o tipo de despesa que será utilizado como padrão quando houver uma integração de fatura para pagamento de frete originada do Protheus GFE. 
Tipo de valor para registro de desconto em títulos originados do GFE. (cod_tip_val_desconto_gfe)

Tipo de valor que será utilizado para fazer o registro de desconto em Apropriações de Despesas originadas do Protheus GFE.
O tipo de valor deve estar previamente cadastrado no FIN30030 com o campo 'Altera valor a pagar?' igual a 'Subtrai' para diminuir o valor líquido da AD e o campo 'Ajuste de ADs/APs?' igual a 'AD'. A contabilização deste movimento também dependerá das informações contábeis previamente cadastradas na pasta de informações contábeis do FIN30030.

Tipo de valor para registro de juros em títulos originados do GFE. (cod_tip_val_juros_gfe)Tipo de valor que será utilizado para fazer o registro de juros em Apropriações de Despesas originadas do Protheus GFE.  O tipo de valor deve estar previamente cadastrado no FIN30030 com o campo 'Altera valor a pagar?' igual a 'Soma' para aumentar o valor líquido da AD e o campo 'Ajuste de ADs/APs?' igual a 'AD'. A contabilização deste movimento também dependerá das informações contábeis previamente cadastradas na pasta de informações contábeis do FIN30030. 


6.1.3 Relacionamento De/Para de Empresa/Filial:

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

EAI:

  • Acessar o programa EAI10000 (Monitor EAI)
  • Selecionar o menu Configuração > Aplicativos Externos
  • Consultar o aplicativo externo do Protheus e clicar no botão "De/Para Empresas"
  • Na tela de De/Para, informar a empresa Logix no campo "cod_empresa" e empresa e filial do Protheus nos campos "Empresa" e "Filial"

API Rest (Simulação de Frete / Validação de Cancelamento de Nota):

  • Ativar o parâmetro "Permite informar empresa/filial externa no cadastro de empresas?" no LOG00086 (Administração de Parâmetros)
  • Acessar o programa LOG00083 (Cadastro de Empresas)
  • Consultar empresa do Logix que deseja relacionar
  • Iniciar a modificação da empresa e informar a empresa e filial do Protheus, correspondente à do Logix, nos campos "Empresa Externa" e "Filial Externa" no final do formulário


Nota:

Para que estes campos possam ser informados, é necessário ativar o parâmetro Permite informar empresa/filial externa no cadastro de empresas? no LOG00087.


6.1.4 Totvs Colaboração

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

Para isso, é realizado 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. Após, o Conhecimento é enviado e integrado ao Logix.


6.1.5 Tratamentos no ERP

    • Conforme a parametrização nos Parâmetros Gerais Logix, Conhecimento venda integrado GFE pode sofrer modificações no Logix?, permitirá incluir um frete de vendas no Logix.
      Se o parâmetro estiver igual a "1", no sup0580, ao tentar incluir um conhecimento de nota de venda, este irá alertar que trabalha com integração com GFE, e a inclusão deveria ser realizada no GFE.
      Se o parâmetro estiver igual a "2", no sup0580, ao tentar incluir um conhecimento de nota de venda, este irá bloquear a inclusão, avisando que existe a integração com o GFE, e informando que a inclusão deve ser realizada no GFE. 
      E se o parâmetro estiver igual a "3", permitirá incluir conhecimento normalmente no sup0580, mesmo se estiver com a integração GFE ligada.

Apropriações de Despesas originadas do sistema Protheus GFE não poderão ser excluídas diretamente pelo Logix - FIN30058 (Manutenção de ADs). Os títulos devem ser excluídos diretamente no sistema origem quando necessário. 


6.1.6 Ajuste dos transportadores no Logix

  • Existe uma condição para integração que os transportadores precisam estar cadastrado no Logix como tipo "5"-Fornecedor/Transportador. 
    Então para facilitar a implantação criamos um conversor chamado SUCA_TRANSP de base que atualiza os transportadores que estiverem como tipo "2"-Apenas Transportador para "5"-Fornecedor/Transportador.
    Para executá-lo cadastrar o mesmo no menu (Men0050) e liberar permissão (Log05050). Executar então através do menu e processar conversão.

    Importante: Os novos transportadores que vierem a ser cadastrados após a implantação devem ser cadastrados como tipo  "5"-Fornecedor/Transportador.


6.1.7 Cadastro de grupos de despesa de frete no Logix

  • Caso não seja informado grupo de despesa único para frete venda no parâmetro 'grupo_desp_frete_gfe'. deve criar e cadastrar grupos de despesa de frete no Logix (SUP0650 - ICMS), ordenado com o menor número de grupo de despesa disponível, necessário para a busca automática de grupo de despesa com base na alíquota / UF / incidência gerada na Invoice. 
  • Cadastrar no VDP0696 / VDP10068 (configurador Fiscal), PIS_REC e COFINS_REC para os novos grupos de despesa, mais informações consultar LRECNF0123 - Como parametrizar o CST das notas fiscais de entrada?

6.1.8 Contabilização do CTe de Venda no Logix

         Como os fretes de venda que são recebidos no Logix (Sup0580) entram com condição de pagamento sem pagamento (para que sejam integrados os títulos posteriormente consolidados diretamente no Financeiro) então é necessário que sejam parametrizados os CFOP´s no Sup0294 (Códigos fiscais contabilizados) com a opção "Com e sem pagamento" marcado. 

         Com isso ao receber o conhecimento de frete é efetuada contabilização automática do mesmo, a qual já irá gerar lançamento contábil também para o valor cheio do frete à Crédito na  "Conta contábil a débito" do tipo de despesa (Fin30058/Informações Contábeis), que seria a conta transitória do fornecedor. 

         Na contabilização da AD(Adiantamento de despesa) no financeiro do Logix (recebe os lançamentos consolidados via título do GFe para o Logix via integração) este lançamento à Crédito terá a contrapartida com um lançamento a Débito na mesma  "Conta contábil a débito" do tipo de despesa (Fin30058/Informações Contábeis). E um lançamento a Débito na conta definitiva do fornecedor, o qual será baixado lançamento com a contrapartida posteriormente na AP-Apropriação de pagamento do mesmo.


Importante:

Como nesta primeira fase da integração  apenas os fretes de compra estão sendo integrados via GFE, caso os mesmos transportadores realizem fretes de compra e de venda, não é possível utilizar a conta transitória de Fornecedor para contabilização do Sup0670, pois neste caso, iria contabilizar também os frete de compra nesta conta. Deve-se usar, neste caso então, a conta contábil a débito do tipo de despesa (FIN30056), conforme explicado acima.


Observação:

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


6.2 Protheus

6.2.1 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
    CityGFEA020CidadesNãoSimSíncrono1.000
    CustomerVendorGFEA015EmitentesNãoSimSíncrono2.000
    ListOfAccountantAccountGFEA090Contas ContábeisNãoSimSincrono2.002
    InvoiceGFEA044Notas Fiscais de SaídaNãoSimAssíncrono3.011
    InvoiceGFEA065Documentos de FreteSimNãoAssíncrono3.011
    ListOfAccountPayableDocumentGFEA070Fatura de FreteSimNãoAssincrono2.002



6.2.2 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.

6.2.3 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 Agendamentos, inclua um cadastro da rotina FWEAI para realizar o processamentos das integrações Assíncronas.

Em EAI, é possível consultar as mensagens enviadas e recebidas pelo EAI.


6.2.4 Configuração do REST:

Para realizar a configuração do REST no Protheus, é necessário adicionar a configuração no arquivo Appserver.ini, conforme o documento: http://tdn.totvs.com.br/pages/viewpage.action?pageId=185748193.

Após realizar a configuração, o serviço será inicializado e apresentado no console:

image2017-10-11_16-3-15.png


6.2.5 Configuração do De/Para do Tipo de Documento de Carga:

Os tipos de documentos do ERP Logix são classificados de acordo com o campo NAT_OPERACAO.ies_tip_controle, sendo este, enviado por meio da tag TypeOfDocument da mensagem única Invoice.
O campo correspondente ao tipo da nota fiscal é o GW1_CDTPDC, portanto, para que o módulo SIGAGFE consiga identificar e diferenciar o tipo de documento enviado pelo ERP Logix, é necessário cadastrar o De/Para na tabela genérica MQ.
Para realizar o cadastro, acesse Configurador (SIGACFG) > Base de Dados > Dicionário > Base de Dados.  

Pesquise pela tabela genérica MQ:

Em itens, realize a inclusão de um tipo de documento de carga, correspondente ao enviado na mensagem única:


6.2.6 Configurações de Negócio

Outras configurações de negócio são realizadas nos Parâmetros do Módulo do Frete Embarcador. Por exemplo, ERP Integrado = "Logix".  

6.2.7 Ajuste do tamanho dos campos de Código do Emitente (Protheus) X Código Cliente/Fornecedor (Logix)

O produto Logix  envia as informações de Clientes e Fornecedores para o SIGAGFE. Por padrão, o campo GU3_CDEMIT tem 14 caracteres sendo que no Logix o campo código tem 15 caracteres.

Desta forma é necessário alterar o tamanho do campo GU3_CDEMIT e TODOS outros campos relacionados para 15 caracteres. Estes campos estão vinculados a um grupo de campos chamado "Código do Emitente"

No módulo SIGAGFE (Protheus) acesse Base de dados > Dicionário > Bases de Dados na tela aberta, acesse Grupo de Campos e procure o grupo "Código do Emitente". Altere o registro e em tamanho informe o valor 15. Salve o registro de depois clique no botão "Atualizar Base de Dados" (Disquete) para alterar o tamanho no banco de dados.



6.2.8 Ajuste do tamanho dos campos de Unidade de Negócio (Protheus) X Área e Linha (Logix)

O produto Logix trabalha com Área e Linha e ao realizar a integração das Notas Fiscais do Logix com o SIGAGFE, esta informação será gravada no campo GW8_UNINEG da tabela dos itens.

Por padrão, o campo GW8_UNINEG tem 3 caracteres sendo que no Logix o campo área a linha tem 8 caracteres.

Desta forma é necessário alterar o tamanho do campo GW8_UNINEG e outros campos relacionados para 8 caracteres. Estes campos estão vinculados a um grupo de campos chamado "Unidade de Negócio"

No módulo SIGAGFE (Protheus) acesse Base de dados > Dicionário > Bases de Dados na tela aberta, acesse Grupo de Campos e procure o grupo "Unidade de Negócio". Altere o registro e em tamanho informe o valor 8. Salve o registro de depois clique no botão "Atualizar Base de Dados" (Disquete) para alterar o tamanho no banco de dados.


7. Conceitos da Integração


7.1 Contabilização



8. 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.


9. Transações/Entidades/Mensagens Únicas

Método

IDDescriçãoOrigemDestinoXSD / API REST

Cadastros

01Cliente/Fornecedor/TransportadorLogixProtheusCustomerVendor_2_000.xsd
02CidadesLogixProtheus

City_1_000.xsd

03Plano de ContasLogixProtheusListOfAccountantAccount_2_002.xsd

Processos

01Documento de Frete de VendaProtheusLogixInvoice_3_011.xsd
02Nota fiscal de saída Logix ProtheusInvoice_3_011.xsd
03Simulação de frete de vendaProtheusLogixFREIGHTSIMULATION
04Apropriação de DespesaProtheusLogixListOfAccountPayableDocument_1_000.xsd


9.1 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
04Plano de ContasLogixProtheusListOfAccountantAccount_2_002.xsd


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

  • Fornecedor/Transportador;
  • Cliente;
  • Cidades;
  • Plano de contas.


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 GFE.

Mensagem Padrão (*)

Origem da Informação - Logix

Destino - GFE

Code

fornecedor.cod_fornecedorGU3_CDEMIT

ShortName

fornecedor.raz_social_reduzGU3_NMABRV

Name

fornecedor.raz_socialGU3_NMEMIT
Type = "Vendor"
GU3_FORN
EntityType= "Person"/"Company"
GU3_NATUR
RegisterDatefornecedor.dat_cadastGU3_DTIMPL
RegisterSituation= "Active"/"Inactive"fornecedor.ies_fornec_ativoGU3_SIT
GovernmentalInformation/Id scope="Federal" name="CNPJ" fornecedor.num_cgc_cpfGU3_IDFED
GovernmentalInformation/Id scope="State" name="Inscricao Estadual" fornecedor.ins_estadualN/A
GovernmentalInformation/Id scope="Municipal" name="Inscricao Municipal" fornec_compl.ins_municipalN/A
GovernmentalInformation/Id scope="Federal" name="Inscricao Pis" sup_par_fornecedor onde empresa = 'SE' e parametro = "num_inscr_inss_2"N/A
GovernmentalInformation/Id scope="Federal" name="NIF" sup_par_fornecedor onde empresa = 'SE' e parametro = "num_ident_fiscal"N/A
Address/Addressfornecedor.end_fornecGU3_ENDER
Address/Numbervdp_cli_fornec_cpl.num_iden_logradGU3_ENDER
Address/Complementvdp_cli_fornec_cpl.compl_enderecoGU3_COMPL
Address/City/CityCodeobf_cidade_ibge (Origem=fornecedor)GU3_NRCID
Address/City/CityDescriptioncidades.den_cidadeGU3_NMCID
Address/Districtfornecedor.den_bairroGU3_BAIRRO
Address/State/StateCodecidades.uni_federGU3_UF
Address/State/StateDescriptionuni_feder.den_uni_federN/A
Address/Country/CountryCodeuni_feder.cod_paisN/A
Address/Country/CountryDescriptionpaises.den_paisN/A
Address/ZIPCodefornecedor.cod_cepGU3_CEP
Address/InternationalDiallingCodevdp_cli_parametro onde parametro = "ddi_telefone_eai"N/A
Address/DiallingCodevdp_cli_parametro onde parametro = "ddd_telefone_eai"N/A
ListOfCommunicationInformation/CommunicationInformation/PhoneNumberfornecedor.num_telefoneGU3_FONE1
ListOfCommunicationInformation/CommunicationInformation/FaxNumberfornecedor.num_faxGU3_FAX
ListOfCommunicationInformation/CommunicationInformation/Emailfornec_compl.endereco_webGU3_EMAIL
ListOfBankingInformation/BankingInformationN/AN/A
VendorInformation/VendorType/Codefornecedor.ies_tip_fornecGU3_TRANSP (quando "5")

Notas:

(*) 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”.


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 para 5 - Fornecedor/Transportador. A configuração do tipo 2- Apenas transportadora não será integrada com o GFE e a configuração do tipo 5- Fornecedor/Transportador irá gerar um cadastro de Fornecedor e Transportador no GFE.
  • Para esta integração, é necessário trabalhar com TSS 2.000. Somente nesta versão foi possível a implementação para realizar o desvio e desconsiderar os Conhecimentos de Venda para que sejam tratados pelo GFE.
  • VDP10000 – Fornecedor – Informações Bancárias: Parâmetro “Gera ordem de pagamento?” deve estar marcado como “NF’s e conhecimento” para as transportadoras.


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.

Mensagem Padrão (*)

Descrição

Origem da Informação - Logix

Destino - GFE

Code

Código do cliente

CLIENTES.cod_cliente

GU3_CDEMIT

ShortName

Nome reduzido do cliente

VDP_CLI_FORNEC_CPL.razao_social_reduz

GU3_NMABRV

Name

Nome do cliente

VDP_CLI_FORNEC_CPL.razao_social

GU3_NMEMIT

Type(**)

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

Para esta mensagem será “Customer”

GU3_CLIEN, GU3_FORN, GU3_TRANSP

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”

GU3_NATUR

RegisterDate

Data de cadastro do cliente

CLIENTES.dat_cadastro

GU3_DTIMPL

RegisterSituation

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

CLIENTES.ies_situacao

GU3_SIT

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 (se Pessoa Física)

NULL

“CNPJ”

“Federal”

CNPJ do fornecedor (se Pessoa Jurídica)

NULL

“Inscricao Estadual”

“State”

Inscrição Estadual do fornecedor

NULL

“Inscricao Municipal”

“Municipal”

Inscrição Municipal do fornecedor

NULL

“Suframa”

“Federal”

Número do registro no SUFRAMA

Data de validação 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”)


GU3_IDFED

Address/Address

Endereço do cliente

VDP_CLI_FORNEC_CPL.logradouro

GU3_ENDER

Address/Number

Número do endereço do cliente

VDP_CLI_FORNEC_CPL.num_iden_lograd

GU3_ENDER

Address/Complement

Complemento do endereço do cliente

VDP_CLI_FORNEC_CPL.compl_endereco

GU3_COMPL

Address/City/Code

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

CLIENTES.cod_cidade

Observação:

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 via EAI, no LOG00087.

GU3_NRCID

Address/City/Description

Nome da cidade do cliente

CIDADES.den_cidade

GU3_NMCID

Address/District

Bairro do cliente

VDP_CLI_FORNEC_CPL.bairro

GU3_BAIRRO

Address/State/Code

Sigla do estado (UF) do cliente

CLIENTES.cod_uni_feder

Observação:

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

GU3_UF

Address/State/Description

Nome do estado (UF) do cliente

UNI_FEDER.den_uni_feder

N/A

Address/Country/Code

Código do país do cliente

UNI_FEDER.cod_pais

N/A

Address/Country/Description

Nome do país do cliente

PAISES.den_pais

N/A

Address/ZIPCode

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

CLIENTES.cod_cep

Observação:

São considerados apenas os dígitos.

GU3_CEP

Address/POBox

Número da caixa postal do cliente

CLIENTES.num_caixa_postal

N/A

ShippingAddress

Informações endereço de entrega do cliente

N/AN/A

ListOfCommunicationInformation/

CommunicationInformation/PhoneNumber

Número do telefone do cliente

VDP_CLI_FORNEC_CPL.telefone_1

GU3_FONE1

ListOfCommunicationInformation/

CommunicationInformation/FaxNumber

Número do fax do cliente

CLIENTES.num_fax

GU3_FAX

ListOfCommunicationInformation/

CommunicationInformation/HomePage

Home (site) do cliente

VDP_CLI_FORNEC_CPL.endereco_web

N/A

ListOfCommunicationInformation/

CommunicationInformation/Email

Email principal do cliente

VDP_CLI_FORNEC_CPL.correio_eletronico

GU3_EMAIL

ListOfContacts

Lista de contatos do cliente

CLI_CONTATOS.num_contato

N/A

Billinginformation

Dados de cobrança do cliente

N/A

N/A

CreditInformation

Dados de crédito do cliente

N/A

N/A

Notas:

(*) 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”.


Limitações / Restrições Gerais

  • Para que uma Transportadora no Logix seja considerada uma Transportadora para o Protheus, é necessário que no VDP10000 (Cadastro de Cliente e Fornecedor) a transportadora esteja cadastrada como tipo "Ambos", e que o tipo do fornecedor, na aba "3 - Fornecedor", esteja como "Fornecedor/Transportadora"
  • Caso ocorra algum erro durante a integração do Cliente/Fornecedor no programa VDP10000 (Cadastro de Cliente e Fornecedor), os campos em tela ficarão desativados e a operação deverá ser cancelada. Esse problema já foi corrigido, e a correção será expedida na Versão 12.1.21 do Logix
  • VDP10000 – Fornecedor – Informações Bancárias: Parâmetro “Gera ordem de pagamento?” deve estar marcado como “NF’s e conhecimento” para as transportadoras.


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.

Mensagem Padrão

Descrição

Origem da Informação - Logix

Destino - GFE

Code

Código da cidade

OBF_CIDADE_IBGE.cidade_logix

N/A

OfficialCode(*)

Código oficial da cidade (IBGE)

OBF_CIDADE_IBGE.cidade_ibge

Observação:

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

GU7_NRCID
Description

Descrição da cidade

CIDADES.den_cidade

GU7_NMCID

FederalUnit

Unidade de federação

OBF_CIDADE_IBGE.estado_logix

GU7_UF



GU7_CDPAIS = "105" (Brasil)

Nota:

(*) 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.


Plano de Contas - AccountantAccount

Identificador da Mensagem: AccountantAccount

Versão: 2.002

Tipo de Envio: Síncrona

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

Mensagem Padrão

Descrição

Origem da Informação - Logix

Destino - GFE

CompanyId

Empresa da Conta Contábil

plano_contas.cod_empresa

N/A

BranchId

Filial da conta contábil


N/A
CompanyInternalId

InternalId da empresa


N/A

Code

Código com máscara (exemplos: '1', '1.1', '1.1.001')

plano_contas.num_conta

GUE_CTACTB
ShortCodeCódigo Reduzidoplano_contas.num_conta_reduzN/A
DescriptionDescrição da contaplano_contas.den_contaGUE_TITULO
PostingNatureNaturezaplano_contas.ies_saldo_conta

N/A

AnalyticalOrSyntheticSe Analítico ou Sintéticoplano_contas.ies_tituloN/A
ActiveOrInactiveSe 1(Ativa) ou 2(Inativa)plano_contas.ies_sit_contaN/A


9.2 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
04Apropriação de DespesaProtheusLogixListOfAccountPayableDocument_1_000.xsd


Conhecimento de Frete de Venda - Invoice

Identificador da Mensagem: Invoice

Versão: 3

Tipo de Envio: Assíncrona

No GFE, a mensagem de Invoice é gerada e enviada para o Logix quando se realiza o processo de "Atualizar Fiscal" do Documento de Frete. O documento de frete fica com situação "Pendente" até que o Logix retorne a mensagem de resposta, indicando o status do processamento, que pode ser: "Rejeitada" ou "Atualizada".

No Logix, ao receber a Invoice 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), por meio 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 consistência 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 aos 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 próxima 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? estiver igual a S, então após realizar a consistência, já assume 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 a empresa trabalhe com este conceito.

Mensagem Padrão (*)

Origem da Informação - GFE

Destino - Logix

Tabela

Campo

Tabela

Campo

CompanyId

GW3

FILIALfrete_supcod_empresa
InvoiceNumberGW3NRDFfrete_supnum_conhec

InvoiceSerie

GW3

SERDFfrete_supser_conhec
InvoiceModelN/AN/Asup_compl_fret_supreservado
TypeOfDocument = "COV"N/ACOVfrete_supies_tip_frete = "V"
VendorCodeGW3EMISDFfrete_supcod_transpor
IssueDateGW3DTEMISsac_embarquedat_entrega
InvoiceAmountGW3VLDFfrete_supval_frete
InsuranceAmountN/AN/Asup_par_frete onde parametro = "val_seguro_frt"parametro_texto
PaymentConditionCodeN/AN/Afrete_supcnd_pgto_frt
PaymentConditionCodeN/AN/Afrete_supcnd_pgto_tab
TaxOpCodeGW3CFOPfrete_supcod_fiscal_frete
TaxOperationCodeComplementN/AN/Afrete_supcod_fiscal_compl
GrossWeightN/AN/Afrete_suppes_vol_frete
Purpose

sup_par_frete onde parametro = "tipo_cte"

Valores: 0-Normal,

1-Complemento de Valores,

2-Anulação de Valores,

3-Substituto

parametro_val
ElectronicAccessKeyN/AN/Asup_par_frete onde parametro = "num_ft_eletronica"parametro_texto
ElectronicProtocol



ElectronicKeyJustificationN/AN/Asup_par_frete onde parametro = "chave_acesso_cte"parametro_texto
ElectronicKeyJustificationN/AN/Asup_par_frete onde parametro = "justif_chave_cteparametro_texto
TollValueN/AN/Aobf_justif_cte_sefazjustificativa
OriginCity/CityCode

sup_par_frete onde parametro = "cidade_origem"

parametro_texto

  • Código da cidade IBGE
DestinationCity/CityCode

sup_par_frete onde parametro = "cidade_destino"

parametro_texto

  • Código da cidade IBGE
ListofRelatedInvoices/RelatedInvoices/InvoiceNumberGW4NRDCfrete_sup_x_nffnum_nff
ListofRelatedInvoices/RelatedInvoices/InvoiceSerieGW4SERDCfrete_sup_x_nffser_nf_saida
ListofRelatedInvoices/RelatedInvoices/InvoiceDateIssueGW1DTEMISfrete_sup_x_nffdat_hr_emis_nota_fiscal_fatura
ItemExpenseGroupCodeN/AN/Afrete_supgru_ctr_desp_frete
ListofItens/Item/ListofTaxes/Taxe = "ICMS"N/AICMS

ListofItens/Item/ListofTaxes/CalculationBasisGW3BASIMPfrete_supval_base_c_frete_c
ListofItens/Item/ListofTaxes/ValueGW3VLIMPfrete_supval_tot_icms_frt_c
ListofItens/Item/ListofTaxes/Taxe = "RETEN_INSS"N/AN/A

ListofItens/Item/ListofTaxes/CalculationBasisN/AN/Asup_par_frete onde parametro = "bc_retencao_inss"parametro_val
ListofItens/Item/ListofTaxes/PercentageN/AN/Asup_par_frete onde parametro = "perc_reten_inss"parametro_val
ListofItens/Item/ListofTaxes/HasTaxN/AN/Asup_par_frete onde parametro = "RETEN_INSS"par_ind_especial
ListofItens/Item/ListofTaxes/Taxe = "RECOLH_INSS"N/AN/A

ListofItens/Item/ListofTaxes/CalculationBasisN/AN/Asup_par_frete onde parametro = "bc_recolhimento_inss"parametro_val
ListofItens/Item/ListofTaxes/HasTaxN/AN/Asup_par_frete onde parametro = "RECOLHIMENTO_INSS"par_ind_especial
ListofItens/Item/ListofTaxes/Taxe = "RETEN_ISS"N/AN/A

ListofItens/Item/ListofTaxes/HasTaxN/AN/Asup_par_frete onde parametro = "RETEN_ISS"par_ind_especial
ListofItens/Item/ListofTaxes/Taxe = "RETEN_SEST_SENAT"N/AN/A

ListofItens/Item/ListofTaxes/HasTaxN/AN/Asup_par_frete onde parametro = "RETEN_SEST_SENAT"par_ind_especial
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/AccountantAcountInternalIdGWACTADEBdest_frete_supnum_conta_deb_desp
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/ProjectInternalIdGWAUNINEG (1,2)dest_frete_supcod_area_negocio
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/SubProjectInternalIdGWAUNINEG (3,4)dest_frete_supcod_lin_negocio
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/PercentualGWA e GW3(GWA_VLMOV / GW3_VLDF) * 100)dest_frete_suppct_particip_comp
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/AccountantAcountInternalIdGWACTADEBdest_frete_sup4num_conta_deb_desp
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/ProjectInternalIdGWAUNINEG (1,2)dest_frete_sup4cod_area_negocio
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/SubProjectInternalIdGWAUNINEG (3,4)dest_frete_sup4cod_lin_negocio
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/MarketSegmentCodeGWAUNINEG (5,6)dest_frete_sup4cod_seg_merc
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/ClassValueCodeGWAUNINEG (7,8)dest_frete_sup4cod_cla_uso
ShippingAddress/City/CityCodeN/AN/Afrete_sup_complcod_cidade

Notas:

(*) 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

  • Percentual de ICMS - Busca alíquota do Logix da tabela de ICMS por grupo de despesa e estado de acordo com a cidade destino enviada (ou cidade do transportador caso não envie a cidade destino).
  • 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 alíquota de ICMS dessa cidade no cálculo 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".


Mensagem Padrão (*)

Descrição

Origem da Informação - Logix

Destino - GFE

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/Item/InvoiceSequence

Sequência do item da nota fiscal

FAT_NF_ITEM.seq_item_nf

GW8_SEQ

ListOfItems/Item/OrderNumber

Número do Pedido que Originou o Item da Nota

FAT_NF_ITEM.pedido

GW1_PEDCLI

ListOfItems/Item/OrdemItem

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

FAT_NF_ITEM.seq_item_pedido

N/A

ListOfItems/Item/ItemCode

Código do item

FAT_NF_ITEM.itemGW8_ITEM

ListOfItems/Item/Quantity

Quantidade do Item

FAT_NF_ITEM.qtd_item

GW8_QTDE

ListOfItems/Item/UnitofMeasureCode

Código da Unidade de MedidaFAT_NF_ITEM.unid_medidaN/A

ListOfItems/Item/UnityPrice

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

FAT_NF_ITEM.preco_unit_bruto

N/A

ListOfItems/Item/GrossValue

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

FAT_NF_ITEM.preco_unit_liquido

Esta informação subtraindo o valor da tag "DiscountValue" formará o valor disponível no campo GW8_VALLIQ.

ListOfItems/Item/FreightValue

Valor do Frete Unitário

FAT_NF_ITEM.val_frete_cliente

N/A

ListOfItems/Item/InsuranceValue

Valor do Seguro Unitário

FAT_NF_ITEM.val_seguro_cliente

N/A

ListOfItems/Item/DiscountValue

Valor do Desconto Unitário

FAT_NF_ITEM.val_desc_item

Esta informação será subtraída da tag "GrossValue" para formar o valor disponível no campo GW8_VALLIQ.

ListOfItems/Item/NetValue

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

FAT_NF_ITEM.val_contab_item

GW8_VALOR

ListOfItems/Item/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 sequência 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/Item/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/Item/ItemNetWeight

Peso liquído total do item em Kg

N/A

N/A

ListOfItems/Item/ItemVolume

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

N/A

GW8_VOLUME

ListOfItems/Item/ItemDescription

Descrição do item

FAT_NF_ITEM.des_item

GW8_DSITEM
ListOfItems/Item/TaxOpCodeItemCódigo da CFOPFAT_NF_ITEM_FISC.cod_fiscalGW8_CFOP

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

Nota:

(*) 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

  • As notas fiscais integradas com o GFE não deverão possuir subsérie informada, pois corre-se o risco de gerar duplicidade de numeração durante a integração.
  • É obrigatório a 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: 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".

A Simulação do Faturamento no programa VDP20000 realiza automaticamente a Simulação de Frete para buscar o valor de frete da nota. Caso for encontrada mais e uma rota/transportadora, será escolhida automaticamente a rota com o menor valor de frete. Atenção: Apenas será realizada a busca do valor de frete no GFE caso o pedido possui tipo de frete CIF Pago ou CIF Cobrado.

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.


Apropriação de Despesa - ListOfAccountPayableDocument

Identificador da Mensagem: ListOfAccountPayableDocument

Versão: 1

Tipo de Envio: Assíncrona

No GFE, a mensagem de ListOfAccountPayableDocument é gerada e enviada para o Logix no momento que se realiza o processo de "Atualizar Financeiro" da Fatura de Frete. A fatura fica com situação "Pendente" até que o Logix retorne a mensagem de resposta, indicando o status do processamento, que pode ser: "Rejeitada" ou "Atualizada".

No Logix, ao receber a Fatura de frete, é acionado Adapter EAIAdapterListOfAccountPayableDocument1. Este irá incluir ou excluir (de acordo com o tipo de processamento enviado), por meio de métodos padrões do ERP, a Apropriação de Despesa 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 FIN30058.

Mensagem Padrão (*)

Descrição

Origem da Informação - GFE

Destino da Informação

CompanyId

Código da empresa

GW6_FILIAL

ad_mestre.cod_empresa

BranchId

Filial

N/A


AccountPayableDocument/DocumentNumber

Número interno que ficará relacionado a Apropriação de DespesaGW6_NRFAT

vdp_dpara_geral.campo_dpara

AccountPayableDocument/ListOfSourceDocument/SourceDocument/SourceDocument

Número do Processo de Exportação (se houver)

N/A

cap_par_ad - parâmetro 'num_proc_exp'

AccountPayableDocument/ListOfSourceDocument/SourceDocument/SourceDocumentSerie

Série da Nota Fiscal

(se nulo, será preenchido com 001)

GW6_SERFATad_mestre.ser_nf

AccountPayableDocument/ListOfSourceDocument/SourceDocument/SourceDocumentSubSerie

SubSérie da Nota Fiscal

(se nulo, será preenchido com 01)
N/Aad_mestre.ssr_nf

AccountPayableDocument/IssueDate

Data de EmissãoGW6_DTEMIS ad_mestre.dat_emis_nf
AccountPayableDocument/ReceiptDateData de Envio para o FinanceiroGW6_DTFINad_mestre.dat_rec_nf

AccountPayableDocument/DueDate

Data de VencimentoGW6_DTVENC ad_mestre.dat_venc
AccountPayableDocument/RealDueDateData de Vencimento RealGW6_DTVENC ad_mestre.dat_venc

AccountPayableDocument/VendorCode

FornecedorGW6_EMIFATad_mestre.cod_fornecedor

AccountPayableDocument/GrossValue

Valor BrutoGW6_VLFATUad_mestre.val_tot_nf

AccountPayableDocument/CurrencyCode

MoedaN/Aad_mestre.cod_moeda

AccountPayableDocument/CurrencyRate

Cotação negociada da moedaN/A

cap_par_ad - parâmetro 'cotacao_emissao'

AccountPayableDocument/Taxes/Tax/Attributes/Taxe

Tipo de Imposto

"ISS", se GW6_VLISRE > 0N/A

AccountPayableDocument/Taxes/Tax/Attributes/CityCode

Código da Cidade (IBGE)

GWU_NRCIDDN/A

AccountPayableDocument/Taxes/Tax/Attributes/CalculationBasis

Base de Calculo para o ImpostoGW3_BASIMPreten_iss.val_base_calc_iss

AccountPayableDocument/ApportionmentDistribution/Apportionment/CostCenterInternalId

Área e linha de negócio

Nota:

Formato:

Linha de produto = _CostCenterInternalId[1,2]
Linha de receita = _CostCenterInternalId[3,4]
Segmento de mercado = _CostCenterInternalId[5,6]
Classe de uso = _CostCenterInternalId[7,8]

GW7_UNINEGad_aen / ad_aen_4 / ad_aen_conta / ad_aen_conta_4

AccountPayableDocument/ApportionmentDistribution/Apportionment/Value

Valor da área e linha de negócioGW7_VLMOVad_aen / ad_aen_4 / ad_aen_conta / ad_aen_conta_4

AccountPayableDocument/Observation

Observação da Apropriação de DespesaGW6_OBS

ad_mestre.observ

AccountPayableDocument/Origin

Sistema de origem do título"PROTHEUS_GFE"N/A

BusinessEvent/Identification/<key name="FinancialAdjustment1"></key>




Tipo de ajuste

Nota:

Opções válidas:

"DESCONTO" - vai gerar um desconto na AD com o tipo de valor parametrizado no LOG00087.

"JUROS" - vai gerar um registro de juros na AD com o tipo de valor parametrizado no LOG00087.

"JUROS"N/A
BusinessEvent/Identification/<key name="ValueAdjustment1"></key>Valor do AjusteGW6_VLJUROad_valores.valor
BusinessEvent/Identification/<key name="FinancialAdjustment2"></key>

Nota:

Opções válidas:

"DESCONTO" - vai gerar um desconto na AD com o tipo de valor parametrizado no LOG00087.

"JUROS" - vai gerar um registro de juros na AD com o tipo de valor parametrizado no LOG00087.

"DESCONTO"


N/A
BusinessEvent/Identification/<key name="ValueAdjustment2"></key>
GW6_VLDESCad_valores.valor

Nota:

(*) 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

  • O Logix está preparado para receber somente a informação de "ISS". 
    Para fazer uso da retenção do ISS originando o título do Protheus GFE, é necessário trabalhar com o ISS aberto por município.
    Parâmetro no CAP2360 / 6. Param. Tributos / INFORMACOES REFERENTE A PAGAMENTO DE IMPOSTOS. / Gerar Ads Pgto ISS por prefeitura igual a "T" 

    FIN30030 - Deve existir um tipo de valor de retenção de ISS, que no botão "ISS Prefeitura" tenha o relacionamento do município com o tipo de despesa da integração GFE, pois vai ser deste relacionamento que o tipo de valor será encontrado para fazer a retenção do ISS na inclusão da AD originada do sistema Protheus GFE.
  • VDP10000 – Fornecedor – Informações Bancárias: Parâmetro “Gera ordem de pagamento?” deve estar marcado como “NF’s e conhecimento” para as transportadoras.
  • Retenção de INSS: é sempre destacada na AD a retenção do INSS, salvo nos casos em que o tipo de despesa (FIN30056) estiver com o parâmetro “Reter INSS de tributos de importação/Trade Easy?” desmarcado na pasta de informações tributárias.

  • Número da NF (FIN30058): Número sequencial conforme parâmetro “ult_num_nf_exportacao” do LOG00087.

ListofRelatedInvoices/RelatedInvoices/InvoiceNumberGW4NRDCfrete_sup_x_nffnum_nff
ListofRelatedInvoices/RelatedInvoices/InvoiceSerieGW4SERDCfrete_sup_x_nffser_nf_saida
ListofRelatedInvoices/RelatedInvoices/InvoiceDateIssueGW1DTEMISfrete_sup_x_nffdat_hr_emis_nota_fiscal_fatura
ItemExpenseGroupCodeN/AN/Afrete_supgru_ctr_desp_frete
ListofItens/Item/ListofTaxes/Taxe = "ICMS"N/AICMS

ListofItens/Item/ListofTaxes/CalculationBasisGW3BASIMPfrete_supval_base_c_frete_c
ListofItens/Item/ListofTaxes/ValueGW3VLIMPfrete_supval_tot_icms_frt_c
ListofItens/Item/ListofTaxes/Taxe = "RETEN_INSS"N/AN/A

ListofItens/Item/ListofTaxes/CalculationBasisN/AN/Asup_par_frete onde parametro = "bc_retencao_inss"parametro_val
ListofItens/Item/ListofTaxes/PercentageN/AN/Asup_par_frete onde parametro = "perc_reten_inss"parametro_val
ListofItens/Item/ListofTaxes/HasTaxN/AN/Asup_par_frete onde parametro = "RETEN_INSS"par_ind_especial
ListofItens/Item/ListofTaxes/Taxe = "RECOLH_INSS"N/AN/A

ListofItens/Item/ListofTaxes/CalculationBasisN/AN/Asup_par_frete onde parametro = "bc_recolhimento_inss"parametro_val
ListofItens/Item/ListofTaxes/HasTaxN/AN/Asup_par_frete onde parametro = "RECOLHIMENTO_INSS"par_ind_especial
ListofItens/Item/ListofTaxes/Taxe = "RETEN_ISS"N/AN/A

ListofItens/Item/ListofTaxes/HasTaxN/AN/Asup_par_frete onde parametro = "RETEN_ISS"par_ind_especial
ListofItens/Item/ListofTaxes/Taxe = "RETEN_SEST_SENAT"N/AN/A

ListofItens/Item/ListofTaxes/HasTaxN/AN/Asup_par_frete onde parametro = "RETEN_SEST_SENAT"par_ind_especial
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/AccountantAcountInternalIdGWACTADEBdest_frete_supnum_conta_deb_desp
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/ProjectInternalIdGWAUNINEG (1,2)dest_frete_supcod_area_negocio
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/SubProjectInternalIdGWAUNINEG (3,4)dest_frete_supcod_lin_negocio
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/PercentualGWA e GW3(GWA_VLMOV / GW3_VLDF) * 100)dest_frete_suppct_particip_comp
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/AccountantAcountInternalIdGWACTADEBdest_frete_sup4num_conta_deb_desp
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/ProjectInternalIdGWAUNINEG (1,2)dest_frete_sup4cod_area_negocio
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/SubProjectInternalIdGWAUNINEG (3,4)dest_frete_sup4cod_lin_negocio
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/MarketSegmentCodeGWAUNINEG (5,6)dest_frete_sup4cod_seg_merc
ListofItens/Item/ListofApportionInvoiceItem/ApportionInvoiceItem/ClassValueCodeGWAUNINEG (7,8)dest_frete_sup4cod_cla_uso
ShippingAddress/City/CityCodeN/AN/Afrete_sup_complcod_cidade