Exibir origem

CONTEÚDO

Visão Geral
Exemplo de utilização
Configuração do Adapter MATA030
Exemplos de mensagem EAI - JSON
Tags
Processamento de campos sem tags e/ou customizados
Tabelas utilizadas

01. VISÃO GERAL

Configuração do Adapter CustomerVendor com formatos diferentes (XML,JSON).

02. EXEMPLO DE UTILIZAÇÃO

Quando utilizado o Adapter CustomerVendor (MATA020,MATA030) ambos obrigatoriamente, devem ter a mesma configuração do formato de arquivo (XML,JSON).

03. CONFIGURAÇÃO DO ADAPTER MATA030

No modulo SIGACFG (Configurador) Ambiente>Schedule>Adapter EAI>Incluir MATA030

Campo Formato, configurado para JSON.

Linha Microsiga Protheus > Adapter EAI - CustomerVendor > image2021-11-25_14-18-59.png

04. EXEMPLOS DE MENSAGEM EAI - JSON

{
   "Header":{
      "UUID":"436601c4-51c9-eff2-2ee2-b678a055b9b8",
      "Type":"BusinessMessage",
      "SubType":"event",
      "Event":"upsert",
      "Transaction":"CUSTOMERVENDOR",
      "StandardVersion":"1.000",
      "Version":"2.002",
      "SourceApplication":"P1212310T1",
      "CompanyId":"T1",
      "BranchId":"D MG 01 ",
      "Enterprise":"D ",
      "BusinessUnit":"MG ",
      "ProductName":"Protheus",
      "ProductVersion":"12",
      "GeneratedOn":"2025-03-25T18:12:36Z",
      "DeliveryType":"Async"
   },
   "Content":{
      "CompanyId":"T1",
      "BranchId":"D MG 01 ",
      "CompanyInternalId":"T1|D MG 01 ",
      "Code":"FTC009",
      "StoreId":"01",
      "InternalId":"T1|D MG|FTC009|01|C",
      "ShortName":"CT009 - Incluir",
      "Name":"Inclui - Envio EAI JSON - CT009",
      "Type":1,
      "StrategicCustomerType":"1",
      "EntityType":1,
      "RegisterDate":"1990-03-01",
      "RegisterSituation":"Active",
      "GovernmentalInformation":[
         {
            "Name":"INSCRICAO ESTADUAL",
            "Scope":"State",
            "Id":"860883954180"
         },
         {
            "Name":"INSCRICAO MUNICIPAL",
            "Scope":"Municipal",
            "Id":"260325"
         },
         {
            "Name":"CNPJ",
            "Scope":"Federal",
            "Id":"77337553000169"
         },
         {
            "Name":"SUFRAMA",
            "Scope":"Federal",
            "Id":"202503260"
         },
         {
            "Name":"INSCRICAO RURAL",
            "Scope":"State",
            "Id":"11223344"
         },
         {
            "Name":"RG",
            "Scope":"Federal",
            "Id":"11223345"
         }
      ],
      "Segment":[
         {
            "Name":"Segment1",
            "InternalId":"T1||000001",
            "CodeERP":"000001",
            "Description":"Industria Quimica\/Resinas\/Tintas\/Sinteticos"
         },
         {
            "Name":"Segment2",
            "InternalId":"T1||000002",
            "CodeERP":"000002",
            "Description":"Industria Faramaceutica\/Veterinaria"
         },
         {
            "Name":"Segment3",
            "InternalId":"T1||000003",
            "CodeERP":"000003",
            "Description":"Industria Refino Petroleo\/Destilacao Alcool"
         },
         {
            "Name":"Segment4",
            "InternalId":"T1||000004",
            "CodeERP":"000004",
            "Description":"Industria Plasticos"
         },
         {
            "Name":"Segment5",
            "InternalId":"T1||000005",
            "CodeERP":"000005",
            "Description":"Industria Textil"
         },
         {
            "Name":"Segment6",
            "InternalId":"T1||000006",
            "CodeERP":"000006",
            "Description":"Industria Vestuario\/Confeccoes"
         },
         {
            "Name":"Segment7",
            "InternalId":"T1||000007",
            "CodeERP":"000007",
            "Description":"Industria Informatica"
         },
         {
            "Name":"Segment8",
            "InternalId":"T1||000008",
            "CodeERP":"000008",
            "Description":"Industria Nautica"
         }
      ],
      "FreightType":{
         "Code":"C",
         "Description":"CIF"
      },
      "Carrier":{
         "CodeERP":"FAT001",
         "InternalId":"T1|D MG|FAT001",
         "Description":"TRANSPORTADORA FATURAMENTO PADRAO"
      },
      "Address":{
         "Address":"RUA TESTE",
         "Number":"1",
         "Complement":"CASA 1",
         "City":{
            "CityCode":"3550308",
            "CityInternalId":"3550308",
            "CityDescription":"SAO PAULO"
         },
         "District":"SANTANA",
         "State":{
            "StateCode":"SP",
            "StateInternalId":"SP",
            "StateDescription":"SAO PAULO"
         },
         "Country":{
            "CountryCode":"105",
            "CountryInternalId":"105",
            "CountryDescription":"BRASIL"
         },
         "Region":{
            "RegionCode":"001",
            "RegionInternalId":"T1||001",
            "RegionDescription":"NORTE"
         },
         "ZIPCode":"02510000",
         "POBox":"C1058"
      },
      "ShippingAddress":{
         "Address":"RUA TESTE",
         "Number":"2",
         "Complement":"BLOCO A",
         "City":{
            "CityCode":"3550308",
            "CityDescription":"SAO PAULO"
         },
         "District":"SANTANA",
         "State":{
            "StateCode":"SP"
         },
         "ZIPCode":"04278050"
      },
      "ListOfCommunicationInformation":[
         {
            "PhoneNumber":"551112345678",
            "FaxNumber":"87654321",
            "HomePage":"www.teste.com.br",
            "Email":"[email protected]"
         }
      ],
      "ListOfContacts":[
         {
            "ContactInformationName":"TESTE"
         }
      ],
      "BillingInformation":{
         "Address":{
            "Address":"RUA TESTE",
            "Number":"3",
            "Complement":"",
            "District":"IPIRANGA",
            "ZIPCode":"04278050",
            "City":{
               "CityDescription":"SAO PAULO"
            },
            "State":{
               "StateCode":"SP"
            }
         }
      },
      "VendorInformation":{
         "VendorType":{
            "Code":"FAT001",
            "VendorInformationInternalID":"T1|D MG|FAT001"
         }
      },
      "PaymentConditionCode":"030",
      "PaymentConditionInternalId":"T1|D MG 01|030",
      "PriceListHeaderItemCode":"001",
      "PriceListHeaderItemInternalId":"T1|D MG|001",
      "CreditInformation":{
         "CreditLimit":1
      },
      "Taxpayer":"1"
   }
}

{
   "Header":{
      "UUID":"DSERFAT-31227-15931641-JSON-FTAG0101",
      "Type":"BusinessMessage",
      "SubType":"event",
      "Event":"upsert",
      "Transaction":"CUSTOMERVENDOR",
      "StandardVersion":"1.000",
      "Version":"2.000",
      "SourceApplication":"environment",
      "CompanyId":"T1",
      "BranchId":"D MG 01",
      "Enterprise":"D",
      "BusinessUnit":"MG",
      "ProductName":"PROTHEUS",
      "ProductVersion":"12",
      "GeneratedOn":"2025-03-31T00:20:27Z",
      "DeliveryType":"sync"
   },
   "Content":{
      "CompanyId":"T1",
      "BranchId":"D MG 01",
      "CompanyInternalId":"T1|D MG 01",
      "Code":"FTAG01",
      "StoreId":"01",
      "InternalId":"T1|D MG|FTAG01|01|C",
      "ShortName":"CLIENTE FTAG01",
      "Name":"CADASTRO CLIENTE FTAG01",
      "Type":1,
      "StrategicCustomerType":"3",
      "EntityType":2,
      "RegisterDate":"1999-01-04",
      "RegisterSituation":"Active",
      "GovernmentalInformation":[
         {
            "Name":"INSCRICAO ESTADUAL",
            "Scope":"State",
            "Id":"860883954180"
         },
         {
            "Name":"INSCRICAO MUNICIPAL",
            "Scope":"Municipal",
            "Id":"260325"
         },
         {
            "Name":"CNPJ",
            "Scope":"Federal",
            "Id":"77337553000169"
         },
         {
            "Name":"SUFRAMA",
            "Scope":"Federal",
            "Id":"202503260"
         },
         {
            "Name":"RG",
            "Scope":"Federal",
            "Id":"11223345"
         },
         {
            "Name":"INSCRICAO RURAL",
            "Scope":"State",
            "Id":"11223344"
         }
      ],
      "Segment":[
         {
            "Name":"Segment1",
            "InternalId":"T1||000001",
            "CodeERP":"000001",
            "Description":"Industria Quimica\/Resinas\/Tintas\/Sinteticos"
         },
         {
            "Name":"Segment2",
            "InternalId":"T1||000002",
            "CodeERP":"000002",
            "Description":"Industria Faramaceutica\/Veterinaria"
         },
         {
            "Name":"Segment3",
            "InternalId":"T1||000003",
            "CodeERP":"000003",
            "Description":"Industria Refino Petroleo\/Destilacao Alcool"
         },
         {
            "Name":"Segment4",
            "InternalId":"T1||000004",
            "CodeERP":"000004",
            "Description":"Industria Plasticos"
         },
         {
            "Name":"Segment5",
            "InternalId":"T1||000005",
            "CodeERP":"000005",
            "Description":"Industria Textil"
         },
         {
            "Name":"Segment6",
            "InternalId":"T1||000006",
            "CodeERP":"000006",
            "Description":"Industria Vestuario\/Confeccoes"
         },
         {
            "Name":"Segment7",
            "InternalId":"T1||000007",
            "CodeERP":"000007",
            "Description":"Industria Informatica"
         },
         {
            "Name":"Segment8",
            "InternalId":"T1||000008",
            "CodeERP":"000008",
            "Description":"Industria Nautica"
         }
      ],
      "FreightType":{
         "Code":"S",
         "Description":"Sem frete"
      },
      "Carrier":{
         "CodeERP":"FAT001",
         "InternalId":"T1|D MG|FAT001",
         "Description":"TRANSPORTADORA FATURAMENTO PADRAO"
      },
      "Address":{
         "Address":"RUA TESTE",
         "Number":"1",
         "Complement":"CASA 10",
         "City":{
            "CityCode":"3550308",
            "CityInternalId":"3550308",
            "CityDescription":"SAO PAULO"
         },
         "District":"VILA MADALENA",
         "State":{
            "StateCode":"SP",
            "StateInternalId":"SP",
            "StateDescription":"SAO PAULO"
         },
         "Country":{
            "CountryCode":"105",
            "CountryInternalId":"105",
            "CountryDescription":"BRASIL"
         },
         "Region":{
            "RegionCode":"001",
            "RegionInternalId":"T1||001",
            "RegionDescription":"NORTE"
         },
         "ZIPCode":"05417110",
         "POBox":"C1058"
      },
      "ShippingAddress":{
         "Address":"RUA TESTE",
         "Number":"2",
         "Complement":"BLOCO A",
         "City":{
            "CityCode":"3550308",
            "CityDescription":"SAO PAULO"
         },
         "District":"IPIRANGA",
         "State":{
            "StateCode":"SP"
         },
         "ZIPCode":"04278050"
      },
      "ListOfCommunicationInformation":[
         {
            "PhoneNumber":"551112342467",
            "FaxNumber":"12342468",
            "HomePage":"www.teste.com.br",
            "Email":"[email protected]"
         }
      ],
      "ListOfContacts":[
         {
            "ContactInformationName":"TESTE"
         }
      ],
      "BillingInformation":{
         "Address":{
            "Address":"RUA TESTE",
            "Number":"50",
            "Complement":"123",
            "District":"IPIRANGA",
            "ZIPCode":"04278050",
            "City":{
               "CityDescription":"SAO PAULO"
            },
            "State":{
               "StateCode":"SP"
            }
         }
      },
      "VendorInformation":{
         "VendorType":{
            "Code":"FTEAI2",
            "VendorInformationInternalID":"T1|D MG 01 |FTEAI2"
         }
      },
      "PaymentConditionCode":"030",
      "PaymentConditionInternalId":"T1|D MG 01|030",
      "PriceListHeaderItemCode":"001",
      "PriceListHeaderItemInternalId":"T1|D MG|001",
      "CreditInformation":{
         "CreditLimit":1,
         "MaturityCreditLimit":"2099-10-01"
      },
      "Taxpayer":"1"
   }
}

05. Tags

Elemento	Descrição	Observação
BusinessContent
CompanyId	Empresa	O campo é preenchido com valor de referência do De/Para de Empresa.
CompanyInternalId	InternalId da empresa	O campo é preenchido com valor de referência do De/Para de Empresa e Filial.
BranchId	Filial	O campo é preenchido com valor de referência do De/Para de Filial.
Code	Código do Cliente	Código referente ao registro Protheus (A1_COD).
StoreId	Loja do Cliente	Código referente ao registro Protheus (A1_LOJA).
InternalId	InternalId do Cliente	O campo é preenchido com valor de referência do De/Para de Clientes (SA1).
ShortName	Nome Reduzido	Código referente ao registro Protheus (A1_NREDUZ).
Name	Nome do Cliente	Código referente ao registro Protheus (A1_NOME).
Type	Tipo de Emitente	Código para considerar o emitente: 1 - Cliente, 2 - Fornecedor ou 3 - Ambos.
StrategicCustomerType	Tipo do Cliente	Código referente ao registro Protheus (A1_TIPO).
EntityType	Tipo de Documento	Indica o tipo de documento: 1 - CPF ou 2 - CNPJ.
RegisterDate	Data de Emissão
RegisterSituation	Situação do Cliente	Código referente ao registro Protheus (A1_MSBLQL).
GovernmentalInformation
Name Scope Id	Inscrição Estadual	INSCRICAO ESTADUAL State Código referente ao registro Protheus (A1_INSCR).
Name Scope Id	Inscrição Municipal	INSCRICAO MUNICIPAL Municipal Código referente ao registro Protheus (A1_INSCRM).
Name Scope Id	CNPJ/CPF	CNPJ ou CPF Federal Código referente ao registro Protheus (A1_CGC).
Name Scope Id	SUFRAMA	SUFRAMA Federal Código referente ao registro Protheus (A1_SUFRAMA).
Name Scope Id	Inscrição Rural	INSCRICAO RURAL State Código referente ao registro Protheus (C6_INSCRUR).
Name Scope Id	RG	Se A1_EST = EX, PASSAPORTE, senão, RG Federal Código referente ao registro Protheus (A1_PFISICA).
Segment
Name InternalId CodeERP Description	Segmento de Atividade 1	Segment1 Código da Empresa \| Compartilhamento da SX5 \| Conteúdo do campo A1_SATIV1 Código referente ao registro Protheus (A1_SATIV1). Descrição do segmento de atividade (A1_DSATIV1).
Name InternalId CodeERP Description	Segmento de Atividade 2	Segment2 Código da Empresa \| Compartilhamento da SX5 \| Conteúdo do campo A1_SATIV2 Código referente ao registro Protheus (A1_SATIV2). Descrição do segmento de atividade (A1_DSATIV2).
Name InternalId CodeERP Description	Segmento de Atividade 3	Segment3 Código da Empresa \| Compartilhamento da SX5 \| Conteúdo do campo A1_SATIV3 Código referente ao registro Protheus (A1_SATIV3). Descrição do segmento de atividade (A1_DSATIV3).
Name InternalId CodeERP Description	Segmento de Atividade 4	Segment4 Código da Empresa \| Compartilhamento da SX5 \| Conteúdo do campo A1_SATIV4 Código referente ao registro Protheus (A1_SATIV4). Descrição do segmento de atividade (A1_DSATIV4).
Name InternalId CodeERP Description	Segmento de Atividade 5	Segment5 Código da Empresa \| Compartilhamento da SX5 \| Conteúdo do campo A1_SATIV5 Código referente ao registro Protheus (A1_SATIV5). Descrição do segmento de atividade (A1_DSATIV5).
Name InternalId CodeERP Description	Segmento de Atividade 6	Segment6 Código da Empresa \| Compartilhamento da SX5 \| Conteúdo do campo A1_SATIV6 Código referente ao registro Protheus (A1_SATIV6). Descrição do segmento de atividade (A1_DSATIV6).
Name InternalId CodeERP Description	Segmento de Atividade 7	Segment7 Código da Empresa \| Compartilhamento da SX5 \| Conteúdo do campo A1_SATIV7 Código referente ao registro Protheus (A1_SATIV7). Descrição do segmento de atividade (A1_DSATIV7).
Name InternalId CodeERP Description	Segmento de Atividade 8	Segment8 Código da Empresa \| Compartilhamento da SX5 \| Conteúdo do campo A1_SATIV8 Código referente ao registro Protheus (A1_SATIV8). Descrição do segmento de atividade (A1_DSATIV8).
FreightType
Code	Tipo de Frete	Código referente ao registro Protheus (A1_TPFRET).
Description	Descrição do Tipo de Frete	Descrição do tipo do frete.
Carrier
CodeERP	Código da Transportadora	Código referente ao registro Protheus (A1_TRANSP).
InternalId	InternalId da Transportadora	Código com valor de referência do De/Para de Transportadora (SA4). Para utilização deve possuir o Adapter CARRIERS (MATA050) cadastrado.
Description	Nome da transportadora	Nome do fornecedor (A4_NOME).
Address
Address	Logradouro	Código referente ao registro Protheus (A1_END).
Number	Número	Código referente ao registro Protheus (A1_END).
Complement	Complemento do Endereço	Código referente ao registro Protheus (A1_COMPLEMEM).
District	Bairro	Código referente ao registro Protheus (A1_BAIRRO).
ZIPCode	CEP	Código referente ao registro Protheus (A1_CEP).
POBox	Caixa Postal	Código referente ao registro Protheus (A1_CXPOSTA).
Address > City
CityCode	Código Do Estado padrão IBGE	Código referente ao registro Protheus (A1_EST + A1_COD_MUN).
CityInternalId	Código Do Estado padrão IBGE	Código referente ao registro Protheus (A1_EST + A1_COD_MUN).
CityDescription	Município do Cliente	Código referente ao registro Protheus (A1_MUN).
Address > State
StateCode	Estado do cliente	Código referente ao registro Protheus (A1_EST).
StateInternalId	InternalId do Estado do Cliente	Código referente ao registro Protheus (A1_EST).
StateDescription	Descrição do Estado	Descrição do estado (Tabela 12 da SX5).
Address > Country
CountryCode	Código do País	Código referente ao registro Protheus (A1_PAIS).
CountryInternalId	InternalId do Código do País	Código referente ao registro Protheus (A1_PAIS).
CountryDescription	Descrição do País	Nome do País (YA_DESCR)
Address > Region
RegionCode	Código da Região	Código referente ao registro Protheus (A1_REGIAO).
RegionInternalId	InternalId da Região	Código da Empresa \| Compartilhamento da SX5 \| Conteúdo do campo A1_REGIAO
RegionDescription	Descrição da Região	Descrição do região (Tabela A2 da SX5).
ShippingAddress
Address	Logradouro do Endereço de Entrega	Código referente ao registro Protheus (A1_ENDENT).
Number	Número do Endereço de Entrega	Código referente ao registro Protheus (A1_ENDENT).
Complement	Complemento do Endereço de Entrega	Código referente ao registro Protheus (A1_COMPENT).
District	Bairro de Entrega	Código referente ao registro Protheus (A1_BAIRROE).
ZIPCode	CEP de Entrega	Código referente ao registro Protheus (A1_CEPE).
ShippingAddress > City
CityCode	Código Do Estado de Entrega	Código referente ao registro Protheus (A1_ESTE + A1_COD_MUNE).
CityDescription	Município do Cliente de Entrega	Código referente ao registro Protheus (A1_MUNE).
ShippingAddress > State
StateCode	Estado do cliente de Entrega	Código referente ao registro Protheus (A1_ESTE).
ListOfCommunicationInformation
PhoneNumber	Número do Telefone	Código referente ao registro Protheus (A1_DDD ou A1_DDI + A1+TEL).
FaxNumber	Número do FAX	Código referente ao registro Protheus (A1_FAX).
HomePage	Home Page	Código referente ao registro Protheus (A1_PAGE).
Email	E-mail	Código referente ao registro Protheus (A1_EMAIL).
ListOfContacts
ContactInformationName	Nome do Contato	Código referente ao registro Protheus (A1_CONTATO).
BillingInformation
BillingInformation > Address
Address	Logradouro do Endereço de Cobrança	Código referente ao registro Protheus (A1_ENDCOB).
Number	Número do Endereço de Cobrança	Código referente ao registro Protheus (A1_ENDCOB).
Complement	Complemento do Endereço de Cobrança	Código referente ao registro Protheus (A1_ENDCOB).
District	Bairro de Cobrança	Código referente ao registro Protheus (A1_BAIRROC).
ZIPCode	CEP de Cobrança	Código referente ao registro Protheus (A1_CEPC).
BillingInformation > Address > City
CityDescription	Município do Cliente de Cobrança	Código referente ao registro Protheus (A1_MUNC).
BillingInformation > Address > State
StateCode	Estado do cliente de Cobrança	Código referente ao registro Protheus (A1_ESTC).
VendorInformation
VendorInformation > VendorType
Code	Código do Vendedor	Código referente ao registro Protheus (A1_VEND).
VendorInformationInternalID	InternalId do Código do Vendedor	Código com valor de referência do De/Para de Vendedores (SE3). Para utilização deve possuir o Adapter SELLER (MATA040) cadastrado ou cadastrar manualmente o valor de referência.
PaymentConditionCode	Condição de Pagamento	Código referente ao registro Protheus (A1_COND).
PaymentConditionInternalId	InternalId da Condição de Pagamento	Código com valor de referência do De/Para de Condição de Pagamento (SE4). Para utilização deve possuir o Adapter PAYMENTCONDITION (MATA360) cadastrado.
PriceListHeaderItemCode	Tabela de Preço	Código referente ao registro Protheus (A1_TABELA).
PriceListHeaderItemInternalId	InternalId da Tabela de Preço	Código referente ao registro Protheus (DA0_CODTAB) Para utilização deste o PriceTableNumber não deve ser enviado.
CreditInformation
CreditLimit	Limite de Credito	Código referente ao registro Protheus (A1_LC).
MaturityCreditLimit	Vencimento do Limite de Credito	Código referente ao registro Protheus (A1_VENCLC).
Taxpayer	Contribuinte	Código referente ao registro Protheus (A1_CONTRIB).

06. PROCESSAMENTO DE CAMPOS SEM TAGS E/OU CUSTOMIZADOS

Para o processamento de campos sem tag, sejam eles customizados ou padrão, acesse o link abaixo para obter maiores informações sobre o processo para integrar os campos, sem a necessidade de customizar o Protheus.

Integração - Processamento de campos sem tag e/ou customizados

Gravação da tabela AI0:
- Será controlada apenas pelo parâmetro MV_MVCSA1 = .T..
Campos sem tag - mensagem de recebimento (SA1 e AI0):
- Os campos sem tag a serem gravados na tabela SA1 e AI0 são de responsabilidade do cliente, assim como o conteúdo a ser gravado nesses campos;
Tabela AI0 - Inclusão:
- Não é necessário enviar código de cliente e loja no processo de inclusão; esses dados são exigidos apenas em alterações.
Exclusões na seção "AddFields":
- Os campos Log de Inclusão (A1_USERLGI), Log de Alteração (A1_USERLGA) e os campos já tagueados não serão incluídos na seção "AddFields".

07. TABELAS UTILIZADAS

XX4 - Adapters EAI
SA1 - Cadastro de Clientes