Histórico da Página

CONTEÚDO

Visão Geral
Exemplo de utilização
Tela Adapter EAI
Tela Configuração do Adapter MATA410
Exemplos de mensagem EAI - JSON
Tags
Pontos de Entrada
Tabelas utilizadas

01. VISÃO GERAL

Configuração do Adpater Order com formatos diferentes (XML,JSON).

02.

...

CONFIGURAÇÃO DO ADAPTER MATA410

Quando utilizado o Adpater Order (MATA120, MATA410) ambos, obrigatoriamente, devem ter a mesma configuração do formato de arquivo (XML,JSON).

É recomendado a utilização da versão mais atual (4.003).

...

Dica

title	Versão do adapter

Utilizar a versão 4.003 que é a última homologada para integração via XML ou JSON.

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

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

Image Removed

Image Added

Campo Formato configurado para XML.

Image Added

...

Campo Formato configurado para JSON.

Image Removed

Image Removed

05. TAGS

...

tabs	JSON
ids	JSON

...

default	yes
referencia	JSON

...

Indica se o Pedido se trata de:
1 - Compra

2 - Venda

...

Código referente ao registro Protheus (C5_NUM).

...

Código referente ao registro Protheus (A1_COD+A1_LOJA/A2_COD+A2_LOJA).

Para utilização deste o CustomerInternalId não deve ser enviado.

...

Código referente ao De/Para (XXF).

...

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.

...

Desconto

...

Realiza cálculo com base no valor total de cada item e adiciona no campo C6_VALDESC (valor de desconto para cada item). Para outras versões, o tratamento desta TAG é alterada, adicionando o desconto no cabeçalho (SC5) por exemplo.

...

Tabela de Preços

...

Código com valor de referência do De/Para de Tabela de Preços (DA0).

Para utilização deve possuir o Adapter PRICELISTHEADERITEM (OMSA010) cadastrado ou cadastrar manualmente o valor de referência.

...

O campo é preenchido com valor de referência do De/Para de Itens do Pedido (C6_ITEM).

...

O campo é preenchido com valor de referência do De/Para de Produto (B1_COD).

Para utilização deve possuir o Adapter ITEM (MATA010) cadastrado.

...

Image Added

03. EXEMPLOS DE MENSAGEM EAI - JSON

Expandir

title	Exemplos de arquivo JSON

Deck of Cards

id	Tags
effectType	fade

Card

id	1
label	Envio
effectType	fade

Bloco de código

language	yml
theme	Midnight
firstline	1
title	JSON de envio (GET)
linenumbers	true

{
   "Header":{
      "UUID":"111111111-1111-1111-1111-11111111111",
      "Type":"BusinessMessage",
      "SubType":"event",
      "Event":"upsert",
      "Transaction":"ORDER",
      "StandardVersion":"1.000",
      "Version":"4.003",
      "SourceApplication":"environment",
      "CompanyId":"T1",
      "BranchId":"D MG 01 ",
      "Enterprise":"D ",
      "BusinessUnit":"MG ",
      "ProductName":"Protheus",
      "ProductVersion":"12",
      "GeneratedOn":"2015-01-01T12:00:00Z",
      "DeliveryType":"Async"
   },
   "Content":{
      "InternalId":"T1|D MG 01|FTADD1|2",
      "OrderPurpose":"2",
      "CompanyId":"T1",
      "BranchId":"D MG 01 ",
      "CompanyInternalId":"T1|D MG 01",
      "OrderId":"FTADD1",
      "CustomerInternalId":"T1|D MG|FATADD|01|C",
      "CustomerCode":"FATADD01",
      "CurrencyCode":"1 ",
      "CurrencyId":"T1|D MG 01|1",
      "PaymentTermCode":"006",
      "PaymentConditionInternalId":"T1|D MG 01|006",
      "RegisterDate":"2025-05-13",
      "FreightType":"2",
      "FreightValue":10,
      "GrossWeight":5,
      "InsuranceValue":20,
      "SellerCode":"T1|D MG|000001",
      "Discounts":[
         {
            "Discount":1
         },
         {
            "Discount":2
         },
         {
            "Discount":3
         },
         {
            "Discount":0
         }
      ],
      "PriceTableNumber":"T1|D MG|057",
      "CarrierCode":"T1|D MG|000001",
      "InvoiceMessage":"TESTE MENSAGEM",
      "InvoiceNumber":"",
      "InvoiceSerie":"",
      "WorkCode":"00000000000001",
      "ListOfCreditDocument":[
         {
            "CreditDocumentInternalId":"T1|D MG 01|FAT|EAIFLDS01|1|RA",
            "Value":100
         }
      ],
      "SalesOrderItens":[
         {
            "InternalId":"T1|D MG 01|FTADD1|01|2",
            "CompanyId":"T1",
            "BranchId":"D MG 01",
            "OrderId":"FTADD1",
            "OrderItem":"01",
            "ItemCode":"FATIADDFIELDS01",
            "ItemDescription":"FAT INT ADDFIELDS 01",
            "ItemInternalId":"T1|D MG 01|FATIADDFIELDS01",
            "ItemUnitOfMeasure":"UN",
            "UnitOfMeasureInternalId":"T1|D MG|UN",
            "Quantity":5,
            "QuantityReached":"",
            "UnityPrice":94.11,
            "TotalPrice":470.55,
            "CostCenterCode":"",
            "CostCenterInternalId":"",
            "ItemDiscounts":{
               "ItemDiscount":0
            },
            "WarehouseInternalId":"T1|D MG|01",
            "TypeOperation":"506",
            "LotNumber":"",
            "SubLotNumber":"",
            "SeriesItem":"",
            "AddressingItem":"",
            "RequestItemInternalId":"",
            "InvoicingDate":"    -  -  ",
            "DeliveryDate":"2025-05-13",
            "InvoiceNumber":"",
            "InvoiceSerie":"",
            "AlloccatedQuantity":5,
            "QuantityDelivered":0,
            "CustomerOrderNumber":"TSTFAT   ",
            "ItemReserveInternalId":"      ",
            "ListOfApportionOrderItem":[
               {
                  "InternalId":"T1|D MG 01|FTADD1|01|2|01",
                  "CostCenterInternalId":"T1|D MG 01 |FAT000001",
                  "AccountantAcountInternalId":"T1|D MG    |000001",
                  "Percentual":40
               },
               {
                  "InternalId":"T1|D MG 01|FTADD1|01|2|02",
                  "CostCenterInternalId":"T1|D MG 01 |FAT000002",
                  "AccountantAcountInternalId":"T1|D MG    |000002",
                  "Percentual":60
               }
            ],
         },
         {
            "InternalId":"T1|D MG 01|FTADD1|02|2",
            "CompanyId":"T1",
            "BranchId":"D MG 01",
            "OrderId":"FTADD1",
            "OrderItem":"02",
            "ItemCode":"FATIADDFIELDS02",
            "ItemDescription":"FAT INT ADDFIELDS 02",
            "ItemInternalId":"T1|D MG 01|FATIADDFIELDS02",
            "ItemUnitOfMeasure":"UN",
            "UnitOfMeasureInternalId":"T1|D MG|UN",
            "Quantity":5,
            "QuantityReached":"",
            "UnityPrice":112.93,
            "TotalPrice":564.65,
            "CostCenterCode":"",
            "CostCenterInternalId":"",
            "ItemDiscounts":{
               "ItemDiscount":141.15
            },
            "WarehouseInternalId":"T1|D MG|01",
            "TypeOperation":"506",
            "LotNumber":"ADDFIELDS",
            "SubLotNumber":"",
            "SeriesItem":"",
            "AddressingItem":"0001",
            "RequestItemInternalId":"",
            "InvoicingDate":"    -  -  ",
            "DeliveryDate":"2025-05-13",
            "InvoiceNumber":"",
            "InvoiceSerie":"",
            "AlloccatedQuantity":0,
            "QuantityDelivered":0,
            "CustomerOrderNumber":"         ",
            "ItemReserveInternalId":"FATADD",
         }
      ]
   }
}

Card

id	2
label	Recebimento
effectType	fade

Bloco de código

language	js
theme	Midnight
firstline	1
title	JSON de Recebimento (POST)
linenumbers	true

{
   "Header":{
      "Version":"4.003",
      "CompanyId":"T1",
      "BranchId":"D MG 01",
      "GeneratedOn":"2025-05-13T09:10:36Z",
      "Enterprise":"01",
      "ProductVersion":"12",
      "SourceApplication":"environment",
      "ProductName":"PROTHEUS",
      "Transaction":"ORDER",
      "StandardVersion":"1.000",
      "UUID":"DSERFAT-31315-12345678-ADDFIELDS-01",
      "SubType":"event",
      "Event":"upsert",
      "Type":"BusinessMessage",
      "DeliveryType":"sync"
   },
   "Content":{
      "BranchId":"D MG 01",
      "InternalId":"FTADD2",
      "CustomerCode":"FATADD01",
      "CarrierCode":"000001",
      "PaymentTermCode":"006",
      "Discounts":0,
      "SellerCode":"",
      "SellerIdCode":"FAT001",
      "RegisterDate":"2025-05-13T09:10:36Z",
      "PriceTableNumber":"",
      "PriceTableIdCode":"057",
      "InvoiceMessage":"Teste 12345",
      "FreightType":"2",
      "FreightValue":10,
      "GrossWeight":5,
      "InsuranceValue":20,
      "Event":"upsert",
      "OrderPurpose":"2",
      "WorkCode":"00000000000001",
      "ListOfCreditDocument":[
         {
            "CreditDocumentInternalId":"T1|D MG 01|FAT|EAIFLDS02|1|RA",
            "Value":200
         }
      ],
      "SalesOrderItens":[
         {
            "BranchId":"01",
            "OrderId":"3878",
            "OrderItem":"1",
            "ItemCode":"FATIADDFIELDS01",
            "WarehouseInternalId":"T1|D MG|01",
            "Quantity":5,
            "UnityPrice":90,
            "TypeOperation":"506",
            "DeliveryDate":"2025-05-13T09:10:36Z",
            "ItemUnitOfMeasure":"UN",
            "InternalId":"FTADD201",
            "CustomerOrderNumber":"123455",
            "ItemDiscounts":{
               "ItemDiscount":10
            }
         },
         {
            "BranchId":"01",
            "OrderId":"3878",
            "OrderItem":"1",
            "ItemCode":"FATIADDFIELDS02",
            "WarehouseInternalId":"T1|D MG|01",
            "Quantity":5,
            "UnityPrice":135,
            "TypeOperation":"506",
            "DeliveryDate":"2025-05-13T09:10:36Z",
            "ItemUnitOfMeasure":"UN",
            "InternalId":"FTADD202",
            "CustomerOrderNumber":"123455",
            "ItemDiscounts":{
               "ItemDiscount":10
            }
         }
      ]
   }
}

04. TAGS

...

O campo é preenchido com valor de referência do De/Para de Centro de Custo (CTT_CUSTO).

...

Deck of Cards
id Tags
effectType fade
Order 2.000Order
Card
id 1
label XML 2.000
effectType fade
Totvs custom tabs box items
default no
referencia
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.
OrderPurpose Objetivo do pedido
Indica se o Pedido se trata de:
1 - Compra
2 - Venda
InternalId InternalId do Pedido O campo é preenchido com valor de referência do De/Para de Pedidos (SC5/SC7).
RegisterDate Data de Emissão
OrderId Número do Pedido
Código referente ao registro Protheus (C5_NUM).
CustomerCode Código do Cli/For
Código referente ao registro Protheus (A1_COD+A1_LOJA/A2_COD+A2_LOJA).
Para utilização deste o CustomerInternalId não deve ser enviado.
CustomerInternalId InternalId do Cli/For
Código referente ao De/Para (XXF).
Para utilização deve possuir o Adapter CUSTOMERVENDOR (MATA030 ou MATA360)cadastrado.
PaymentTermCode Condição de Pagamento Código referente ao registro Protheus (E4_CODIGO).
PaymentConditionInternalId
InternalId da
condição
Condição
de
pagamento
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.
Discount
Desconto
Realiza cálculo com base no valor total de cada item e adiciona no campo C5_DESC1 (valor de desconto no cabeçalho). Para outras versões, o tratamento desta TAG é alterada, adicionando o desconto no cabeçalho (SC5) por exemplo.
PriceTableNumber
Tabela de Preços
Código com valor de referência do De/Para de Tabela de Preços (DA0).
Para utilização deve possuir o Adapter PRICELISTHEADERITEM (OMSA010) cadastrado ou cadastrar manualmente o valor de referência.
SalesOrderItens.Item
InternalId InternalID Item do Pedido
O campo é preenchido com valor de referência do De/Para de Itens do Pedido (C6_ITEM).
OrderItem Item do Pedido O campo é preenchido com valor sequencial de referência do De/Para de Itens do Pedido (C6_ITEM).
ItemInternalId InternalId do Produto
O campo é preenchido com valor de referência do De/Para de Produto (B1_COD).
Para utilização deve possuir o Adapter ITEM (MATA010) cadastrado.
ItemCode Código do Produto Código referente ao registro Protheus (B1_COD).
Quantity Quantidade
UnityPrice Preço unitário
TotalPrice Valor Total
TypeOperation Tipo da Operação Se menor que 3 será tratado como C6_OPER, caso contrario será tratado como C6_TES.
CostCenterCode Centro de Custo Código referente ao registro Protheus (CTT_CUSTO).
CostCenterInternalId InternalID do Centro de Custo
O campo é preenchido com valor de referência do De/Para de Centro de Custo (CTT_CUSTO).
Para utilização deve possuir o Adapter COSTCENTER (CTBA030) cadastrado
.
Totvs custom tabs box items
default no
referencia
.
InternalID Item do Pedido
Card
id 2
label XML 3.002
effectType fade
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.
OrderPurpose Objetivo do pedido
Indica se o Pedido se trata de:
1 - Compra
2 - Venda
InternalId InternalId do Pedido O campo é preenchido com valor de referência do De/Para de Pedidos (SC5/SC7).
RegisterDate Data de Emissão
OrderId Número do Pedido
Código referente ao registro Protheus (C5_NUM).
CustomerCode Código do Cli/For
Código referente ao registro Protheus (A1_COD+A1_LOJA/A2_COD+A2_LOJA).
Para utilização deste o CustomerInternalId não deve ser enviado.
CustomerInternalId InternalId do Cli/For
Código referente ao De/Para (XXF).
Para utilização deve possuir o Adapter CUSTOMERVENDOR (MATA030 ou MATA360)cadastrado.
PaymentTermCode Condição de Pagamento Código referente ao registro Protheus (E4_CODIGO).
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.
Discount
Desconto
Realiza cálculo com base no valor total de cada item e adiciona no campo C6_VALDESC (valor de desconto para cada item). Para outras versões, o tratamento desta TAG é alterada, adicionando o desconto no cabeçalho (SC5) por exemplo.
SalesOrderItens.Item
InternalId InternalID Item do Pedido
O campo é preenchido com valor de referência do De/Para de Itens do Pedido (C6_ITEM).
OrderItem Item
do Pedido O campo é preenchido com valor sequencial de referência do De/Para de Itens do Pedido (C6_ITEM).
ItemInternalId InternalId do Produto
InternalId
O campo é preenchido com valor de referência do De/Para de

Para utilização deve possuir o Adapter PAYMENTCONDITION (MATA360) cadastrado.
FreightType	Tipo de Frete	Código numérico correspondente ao campo C5_TPFRETE, utilizado para representar o tipo de frete, sendo: "1" = C "2" = F "3" = T "4" = R "5" = D "6" = S
CarrierCode	Transportadora	Código com valor de referência do De/Para de Transportadora (SA4

FreightValue	Valor do Frete	Código referente ao registro Protheus (C5_FRETE).
GrossWeight	Peso Bruto	Código referente ao registro Protheus (C5_PBRUTO).
InsuranceValue	Valor do Seguro	Código referente ao registro Protheus (C5_SEGURO).
SellerCode	Código do vendedor

Moeda	Código referente ao registro Protheus (C5_MOEDA) Para utilização deste, o CurrencyId não deve ser enviado.
WorkCode	Código da Obra	Código referente ao registro Protheus (C5_CNO).
Discounts
Discount	Percentual do desconto	Código referente ao registro Protheus (C5_DESC1, C5_DESC2, C5_DESC3 e C5_DESC4). Específico para mensagem de envio.
SalesOrderItens
InternalId	InternalID Item do Pedido

.
ItemDiscounts	Valor do Desconto do Item	Realiza cálculo com base no valor total de cada item e adiciona no campo C6_VALDESC (valor de desconto para cada item). Específico para mensagem de recebimento.
LotNumber	Lote do Item

Serie do Item	Código referente ao registro Protheus (C6_NUMSERI).
AddressingItem	Endereço do Item	Código referente ao registro Protheus (C6_LOCALIZ).
InvoicingDate	Data do Faturamento	Código referente ao registro Protheus (C6_DTFAT).
DeliveryDate	Data de Entrega	Código referente ao registro Protheus (C6_ENTREG).
InvoiceNumber	Número da Nota

Árvore de páginas

Versões comparadas

Versão antiga 50

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL

02.

CONFIGURAÇÃO DO ADAPTER MATA410

05. TAGS

03. EXEMPLOS DE MENSAGEM EAI - JSON

04. TAGS

05. PROCESSAMENTO DE CAMPOS SEM TAGS E/OU CUSTOMIZADOS

06. PONTOS DE ENTRADA

07. TABELAS UTILIZADAS

Produto (B1_COD). Para utilização deve possuir o Adapter ITEM (MATA010) cadastrado.
ItemCode	Código do Produto	Código referente ao registro Protheus (B1_COD).
Quantity	Quantidade
UnityPrice	Preço unitário
TotalPrice	Valor Total
TypeOperation	Tipo da Operação	Se menor que 3 será tratado como C6_OPER, caso contrario será tratado como C6_TES.
CostCenterCode	Centro de Custo	Código referente ao registro Protheus (CTT_CUSTO).
CostCenterInternalId	InternalID do Centro de Custo

Empresa e Filial.
BranchId	Filial	O campo é preenchido com valor de referência do De/Para de Filial.
OrderPurpose	Objetivo do pedido	Indica se o Pedido se trata de: 1 - Compra 2 - Venda
InternalId	InternalId do Pedido

do De/Para de Pedidos (SC5/SC7).
RegisterDate	Data de Emissão
OrderId	Número do Pedido	Código referente ao registro Protheus (C5_NUM).
CustomerCode	Código do Cli/For	Código referente ao registro Protheus (A1_COD+A1_LOJA/A2_COD+A2_LOJA). Para utilização deste o CustomerInternalId não deve ser enviado.
CustomerInternalId	InternalId do Cli/For	Código referente ao De/Para (XXF). Para utilização deve possuir o Adapter CUSTOMERVENDOR (MATA030 ou MATA360)cadastrado.
PaymentTermCode	Condição de Pagamento	Código referente ao registro Protheus (E4_CODIGO).
PaymentConditionInternalId	InternalId da condição de pagamento	Código

OMSA010) cadastrado ou cadastrar manualmente o valor de referência.
SalesOrderItens.

Item
InternalId	InternalID Item do Pedido	O campo é preenchido com valor de referência do De/Para de Itens do Pedido (C6_ITEM).
OrderItem	Item do Pedido	O campo é preenchido com valor sequencial

Itens do Pedido (C6_ITEM).
ItemInternalId	InternalId do Produto

Para de Produto (B1_COD). Para utilização deve possuir o Adapter ITEM (MATA010) cadastrado.
ItemCode	Código do Produto	Código referente ao registro Protheus (B1_COD).
Quantity	Quantidade
UnityPrice	Preço unitário
TotalPrice	Valor Total
TypeOperation	Tipo da Operação	Se menor que 3 será tratado como C6_OPER, caso contrario será tratado como C6_TES.
CostCenterCode	Centro de Custo	Código referente ao registro Protheus (CTT_CUSTO).
CostCenterInternalId	InternalID do Centro de Custo

/Para de Pedidos (SC5/SC7).
RegisterDate	Data de Emissão
OrderId	Número do Pedido	Código referente ao registro Protheus (C5_NUM).
CustomerCode	Código do Cli/For	Código referente ao registro Protheus (A1_COD+A1_LOJA/A2_COD+A2_LOJA). Para utilização deste, o CustomerInternalId não deve ser enviado.
CustomerInternalId	InternalId do Cli/For	Código referente ao De/Para (XXF). Para utilização deve possuir o Adapter CUSTOMERVENDOR (MATA030 ou MATA360)cadastrado.
PaymentTermCode	Condição de Pagamento	Código referente ao registro Protheus (E4_CODIGO).
PaymentConditionInternalId	InternalId da condição de pagamento	Código

deve possuir o Adapter ITEM (MATA010) cadastrado.
ItemCode	Código do Produto

deste, o ItemInternalId não deve ser enviado.
ItemDescription	Descrição do Item	Código referente ao registro Protheus (

Adapter WAREHOUSE (AGRA045) cadastrado.
UnitOfMeasureInternalId	Unidade de Medida do Item	O campo é preenchido

AllocatedQuantity	Quantidade Alocada	Código referente ao registro Protheus (C6_QTDEMP).
QuantityDelivered	Quantidade Entregue	Código referente ao registro Protheus (C6_QTDENT).
ItemReserveInternalId	Reserva

LOJA704) cadastrado, caso contrário, será enviado o código o número de documento da reserva (C6_RESRVA).
CustomerOrderNumber	Número do Pedido do Cliente

PEDCLI).
ListOfApportionOrderItem
InternalId	InternalId do Pedido de Venda	Específico se houver integração com SIGAPMS.
ProjectInternalId	Código do Projeto	O campo é preenchido com valor de referência do De/Para de Projeto (AF8_PROJET). Para utilização deve possuir o Adapter PROJECT (PMSA200) cadastrado.
TaskInternalId	Código da Tarefa	O campo é preenchido com valor de referência do De/Para do Código da Tarefa (AF9_TAREFA). Para utilização deve possuir o Adapter TASKPROJECT (PMSA203) cadastrado. Específico para mensagem de envio se houver integração com SIGAPMS.
CostCenterInternalId	InternalId do Centro de Custo	Código referente ao De/Para (XXF). Para utilização deve possuir o Adapter COSTCENTER (CTBA030)

rateio por centro de custo	Específico para mensagem de envio se houver integração com SIGAPMS.
Quantity	Quantidade do rateio por centro de custo	Específico para mensagem de envio se houver integração com SIGAPMS.
Percentual	Percentual do rateio por centro de custo
ListOfCreditDocument
CreditDocumentInternalId	InternalId do Título a Receber (Recebimento Antecipado)	Código referente ao De/Para (XXF). Para utilização deve possuir o Adapter ACCOUNTRECEIVABLEDOCUMENT (FINA040)cadastrado.
Value	Valor do Título RA