Árvore de páginas

Versões comparadas

Chave

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

CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
  3. Tela Adapter EAI
  4. Tela Configuração do Adapter MATA410
  5. Exemplos de mensagem EAI - JSON
  6. Tags
  7. Pontos de Entrada
  8. 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 (MATA120MATA410) 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).

03. TELA ADAPTER EAI         

...


Dica
titleVersã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 

      Image Removed

...

 

...

         Exemplo de configuração da mensagem ORDER.

            


         Campo Formato configurado para XML.

...

         Campo Formato configurado para JSON.

       

...

03

...

EXEMPLOS DE MENSAGEM EAI - JSON

Expandir
titleExemplos de arquivo JSON
XML 2.000
Deck of Cards
idTags
effectTypefade
Card
id1
label
Envio
effectTypefade
Bloco de código
languageyml
themeMidnight
firstline1
titleJSON de envio (GET)
linenumberstrue
{
   "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
id2
labelRecebimento
effectTypefade
Bloco de código
languagejs
themeMidnight
firstline1
titleJSON de Recebimento (POST)
linenumberstrue
{
   "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

Deck of Cards
idTags
effectTypefade
Card
id1
labelXML 2.000
effectTypefade
ElementoDescriçãoObservação
BusinessContent
CompanyIdEmpresaO campo é preenchido com valor de referência do De/Para de Empresa.
CompanyInternalIdInternalId da empresaO campo é preenchido com valor de referência do De/Para de Empresa e Filial.
BranchIdFilialO campo é preenchido com valor de referência do De/Para de Filial.
OrderPurposeObjetivo do pedido

Indica se o Pedido se trata de:
1 - Compra

2 - Venda

InternalIdInternalId do PedidoO campo é preenchido com valor de referência do De/Para de Pedidos (SC5/SC7).
RegisterDateData de Emissão
OrderIdNúmero do Pedido

Código referente ao registro Protheus (C5_NUM).

CustomerCodeCó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.

CustomerInternalIdInternalId do Cli/For

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

Para utilização deve possuir o Adapter CUSTOMERVENDOR (MATA030 ou MATA360)cadastrado.

PaymentTermCodeCondição de PagamentoCó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 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
InternalIdInternalID Item do Pedido

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

OrderItemItem do PedidoO campo é preenchido com valor sequencial de referência do De/Para de Itens do Pedido (C6_ITEM).
ItemInternalIdInternalId 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.

ItemCodeCódigo do ProdutoCódigo referente ao registro Protheus (B1_COD).
QuantityQuantidade
UnityPricePreço unitário
TotalPriceValor Total
TypeOperationTipo da OperaçãoSe menor que 3 será tratado como C6_OPER, caso contrario será tratado como C6_TES.
CostCenterCodeCentro de CustoCódigo referente ao registro Protheus (CTT_CUSTO).
CostCenterInternalIdInternalID 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.

Card
id2
labelXML 3.002
effectTypefade
InternalId Pedidos (SC5/SC7).Condição de PagamentoE4CODIGO
ElementoDescriçãoObservação
BusinessContent
CompanyIdEmpresaO campo é preenchido com valor de referência do De/Para de Empresa.
CompanyInternalIdInternalId da empresaO campo é preenchido com valor de referência do De/Para de Empresa e Filial.
BranchIdFilialO campo é preenchido com valor de referência do De/Para de Filial.
OrderPurposeObjetivo do pedido

Indica se o Pedido se trata de:
1 - Compra

2 - Venda

InternalIdInternalId do PedidoO campo é preenchido com valor de referência do De/Para de Pedidos (SC5/SC7).
RegisterDateData de Emissão
OrderIdNúmero do Pedido

Código referente ao registro Protheus (C5_NUM).

CustomerCodeCó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.

CustomerInternalIdInternalId do Cli/For

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

Para utilização deve possuir o Adapter CUSTOMERVENDOR (MATA030 ou MATA360)cadastrado.

PaymentTermCodeCondição de PagamentoCó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
InternalIdInternalID Item do Pedido
ElementoDescriçãoObservação
BusinessContent
CompanyIdEmpresaO campo é preenchido com valor de referência do De/Para de Empresa.
CompanyInternalIdInternalId da empresaO campo é preenchido com valor de referência do De/Para de Empresa e Filial.
BranchIdFilial

O campo é preenchido com valor de referência do De/Para de

Filial.
OrderPurposeObjetivo do pedido

Indica se o Pedido se trata de:
1 - Compra

2 - Venda

Itens do Pedido (C6_ITEM).

OrderItemItem InternalId do PedidoO campo é preenchido com valor sequencial de referência do De/Para de RegisterDateData de Emissão
OrderIdNúmero do Pedido

Código referente ao registro Protheus (C5_NUM).

CustomerCodeCó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.

Itens do Pedido (C6_ITEM).
ItemInternalIdInternalId do Produto

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

CustomerInternalIdInternalId do Cli/For

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

Para utilização deve possuir o Adapter CUSTOMERVENDOR ITEM (MATA030 ou MATA360MATA010) cadastrado.

PaymentTermCode
ItemCodeCódigo do ProdutoCódigo referente ao registro Protheus (B1_COD).
PaymentConditionInternalIdQuantity

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

Quantidade
UnityPricePreço unitário
TotalPriceValor Total
TypeOperationTipo da OperaçãoSe menor que 3 será tratado como C6_OPER, caso contrario será tratado como C6_TES.
CostCenterCodeCentro de CustoCódigo referente ao registro Protheus (CTT_CUSTO).
CostCenterInternalIdInternalID do Centro de Custo

O campo é preenchido

PriceTableNumber

Tabela de Preços

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

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



card
Card
id3
labelXML 4.003
effectTypefade
Item do Pedido sequencial Itens do Pedido (C6_ITEM)
ElementoDescriçãoObservação
BusinessContent
CompanyIdEmpresa
SalesOrderItens.Item
InternalIdInternalID Item do PedidoO campo é preenchido com valor de referência do De/Para de Itens do Pedido (C6_ITEM)Empresa.OrderItem
CompanyInternalIdInternalId da empresaO campo é preenchido com valor de referência do De/Para de Empresa e Filial.
ItemInternalIdBranchIdInternalId do ProdutoFilialO campo é preenchido com valor de referência do De/Para de Produto (B1_COD).

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

ItemCodeCódigo do ProdutoCódigo referente ao registro Protheus (B1_COD).
QuantityQuantidade
Para de Filial.
OrderPurposeObjetivo do pedido

Indica se o Pedido se trata de:
1 - Compra

2 - Venda

InternalIdInternalId do PedidoO campo é preenchido com valor de referência do De/Para de Pedidos (SC5/SC7).
RegisterDateData de Emissão
OrderIdNúmero do Pedido
UnityPricePreço unitárioTotalPriceValor Total
TypeOperationTipo da OperaçãoSe menor que 3 será tratado como C6_OPER, caso contrario será tratado como C6_TES.
CostCenterCodeCentro de Custo

Código referente ao registro Protheus (

CTT

C5_

CUSTO

NUM).

CostCenterInternalIdCustomerCodeCó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.

CustomerInternalIdInternalId do Cli/For

Código referente ao De/Para (XXF

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 CUSTOMERVENDOR (CTBA030MATA030 ou MATA360) cadastrado.

PaymentTermCode
id2
labelXML 3.002
effectTypefade

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

Para utilização deve possuir o Adapter CUSTOMERVENDOR (MATA030 ou MATA360)cadastrado.InternalID do Centro de Custo
Condição de PagamentoCódigo referente ao registro Protheus (E4_CODIGO).
PaymentConditionInternalId

InternalId da condição

de pagamento

Código

ElementoDescriçãoObservação
BusinessContent
CompanyIdEmpresaO campo é preenchido com valor de referência do De/Para de Empresa.
CompanyInternalIdInternalId da empresaO campo é preenchido com valor de referência do De/Para de Empresa e Filial.
BranchIdFilialO campo é preenchido

com valor de referência do De/Para de

Filial.
OrderPurposeObjetivo do pedido

Indica se o Pedido se trata de:
1 - Compra

2 - Venda

InternalIdInternalId do PedidoO campo é preenchido com valor de referência do De/Para de Pedidos (SC5/SC7).
RegisterDateData de Emissão

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.

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
InternalIdInternalID Item do Pedido

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

OrderItemItem do PedidoO campo é preenchido com valor sequencial de referência do De/Para de Itens do Pedido (C6_ITEM).
ItemInternalIdInternalId do Produto

O campo é preenchido

OrderIdNúmero do Pedido

Código referente ao registro Protheus (C5_NUM).

CustomerCodeCó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.

CustomerInternalIdInternalId do Cli/For
PaymentTermCodeCondição de PagamentoCó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 (SE4Produto (B1_COD).

Para utilização deve possuir o Adapter PAYMENTCONDITION ITEM (MATA360MATA010) 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
InternalIdInternalID Item do Pedido

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

OrderItemItem do PedidoO campo é preenchido com valor sequencial de referência do De/Para de Itens do Pedido (C6_ITEM).
ItemCodeCódigo do ProdutoCódigo referente ao registro Protheus (B1_COD).
QuantityQuantidade
UnityPricePreço unitário
TotalPriceValor Total
TypeOperationTipo da OperaçãoSe menor que 3 será tratado como C6_OPER, caso contrario será tratado como C6_TES.
CostCenterCodeCentro de CustoCódigo referente ao registro Protheus (CTT_CUSTO).
CostCenterInternalIdInternalID do Centro de CustoItemInternalIdInternalId do Produto

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

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

ItemCodeCódigo do ProdutoCódigo referente ao registro Protheus (B1_COD).
QuantityQuantidadeUnityPricePreço unitárioTotalPriceValor Total
TypeOperationTipo da OperaçãoSe menor que 3 será tratado como C6_OPER, caso contrario será tratado como C6_TES.
CostCenterCodeCentro de CustoCódigo referente ao registro Protheus (CTT_CUSTO).
CostCenterInternalId



O campo é preenchido
Card
id4
labelJSON
effectTypefade
ElementoDescriçãoObservação
BusinessContent
CompanyIdEmpresaO campo é preenchido com valor de referência do De/Para de Empresa.
CompanyInternalIdInternalId da empresaO campo é preenchido com valor de referência do De/Para de Empresa e Filial.
BranchIdFilialO 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.

Card
id3
labelXML 4.003
effectTypefade
Filial.
OrderPurposeObjetivo do pedido

Indica se o Pedido se trata de:
1 - Compra

2 - Venda

InternalIdInternalId do PedidoO campo é preenchido com valor de referência do De/Para de Pedidos (SC5/SC7).
RegisterDateData de Emissão
OrderIdNúmero do Pedido

Código referente ao registro Protheus (C5_NUM).

CustomerCodeCó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.

CustomerInternalIdInternalId do Cli/For

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

Para utilização deve possuir o Adapter CUSTOMERVENDOR (MATA030 ou MATA360)cadastrado.

PaymentTermCodeCondição de PagamentoCódigo referente ao registro Protheus (E4_CODIGO).
PaymentConditionInternalId

InternalId da condição de pagamento

Código

ElementoDescriçãoObservação
BusinessContent
CompanyIdEmpresaO campo é preenchido com valor de referência do De/Para de Empresa.
CompanyInternalIdInternalId da empresaO campo é preenchido com valor de referência do De/Para de Empresa e Filial.
BranchIdFilialO campo é preenchido com valor de referência do De/Para de Filial.
OrderPurposeObjetivo do pedido

Indica se o Pedido se trata de:
1 - Compra

2 - Venda

InternalIdInternalId do Pedido

com valor de referência do De/Para de Condição de

Pedidos

Pagamento (

SC5/SC7

SE4).

RegisterDateData de Emissão
OrderIdNúmero do Pedido

Código referente ao registro Protheus (C5_NUM).

CustomerCodeCó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.

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

CustomerInternalIdInternalId do Cli/ForCódigo referente ao De/Para (XXF

).

Para utilização deve possuir o Adapter

CUSTOMERVENDOR

CARRIERS (

MATA030 ou MATA360

MATA050) cadastrado

.

PaymentTermCode
InvoiceMessage

Mensagem da nota

Condição de Pagamento

Código referente ao registro Protheus (

E4

C5_

CODIGO

MENNOTA).

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.

PriceTableNumber
FreightValueValor 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

Tabela de Preços

Código com valor de referência do De/Para de

Tabela de Preços

Vendedores (

DA0

SE3).

Para utilização deve possuir o Adapter

PRICELISTHEADERITEM 

SELLER (

OMSA010

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

SalesOrderItens.ItemInternalIdInternalID Item do Pedido

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

SellerIdCode

Código do vendedor

Código referente ao registro Protheus (A3_COD)

Para utilização deste, o SellerCode não deve ser enviado.

PriceTableNumber

Tabela de Preços

Código com valor

OrderItemItem do PedidoO campo é preenchido com valor sequencial

de referência do De/Para de Tabela de

Itens do Pedido (C6_ITEM

Preços (DA0).

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

Para utilização deve possuir o Adapter PRICELISTHEADERITEM (OMSA010) cadastrado.

PriceTableIdCode

Tabela de Preços

Código referente ao registro Protheus (DA0_CODTAB)

Para utilização deste, o PriceTableNumber não deve ser enviado.

InvoiceNumber

Número da Nota

ItemCodeCódigo do Produto

Código referente ao registro Protheus (

B1

C5_

COD

NOTA).

QuantityQuantidadeUnityPricePreço unitárioTotalPriceValor TotalTypeOperationTipo da OperaçãoSe menor que 3 será tratado como C6_OPER, caso contrario será tratado como C6_TES.CostCenterCodeCentro de Custo
InvoiceSerie

Série da Nota

Código referente ao registro Protheus (

CTT

C5_

CUSTO

SERIE).

CostCenterInternalIdInternalID do Centro de Custo
CurrencyId

Moeda

Código

O campo é preenchido

com valor de referência do De/Para de

Centro de Custo (CTT_CUSTO

Moeda (CTO).

Para utilização deve possuir o Adapter

COSTCENTER

CURRENCY(

CTBA030

CTBA140) cadastrado.

card
CurrencyCode
id4
labelJSON
effectTypefade

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
InternalIdInternalID Item do Pedido
ElementoDescriçãoObservaçãoBusinessContentCompanyIdEmpresaO campo é preenchido com valor de referência do De/Para de Empresa.CompanyInternalIdInternalId da empresaO campo é preenchido com valor de referência do De/Para de Empresa e Filial.BranchIdFilial

O campo é preenchido com valor de referência do De/Para de

Filial.OrderPurposeObjetivo do pedido

Indica se o Pedido se trata de:
1 - Compra

2 - Venda

InternalId

Itens do Pedido (C6_ITEM).

OrderItemItem
InternalId
do PedidoO campo é preenchido com valor sequencial de referência do De/Para de
Pedidos (SC5/SC7
Itens do Pedido (C6_ITEM).
RegisterDateData de EmissãoOrderIdNúmero do Pedido

Código referente ao registro Protheus (C5_NUM).

CustomerCodeCódigo do Cli/For
ItemInternalIdInternalId do Produto

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

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

deve possuir o Adapter ITEM (MATA010) cadastrado.

ItemCodeCódigo do Produto
InternalId do Cli/For

Código referente ao

De/Para (XXF

registro Protheus (C6_PRODUTO).

Para utilização

deve possuir o Adapter CUSTOMERVENDOR (MATA030 ou MATA360)cadastrado.PaymentTermCodeCondição de Pagamento

deste, o ItemInternalId não deve ser enviado.

ItemDescriptionDescrição do ItemCódigo referente ao registro Protheus (
E4
C6_
CODIGO
PRODUTO).
PaymentConditionInternalId

InternalId da condição

de pagamento

WarehouseInternalIdLocais de Estoque

O campo é preenchido

Código

com valor de referência do De/Para de

Condição de Pagamento

Armazém (

SE4

NRR).

Para utilização deve possuir o Adapter

PAYMENTCONDITION

WAREHOUSE (

MATA360

AGRA045) cadastrado.

FreightType
UnitOfMeasureInternalId
Tipo
Unidade de
Frete

Código referente ao registro Protheus (C5_TPFRETE).

Carrier Code

Transportadora

Medida do Item

O campo é preenchido

Código

com valor de referência do De/Para de

Transportadora

Unidade de Medida (

SA4

SAH).

Para utilização deve possuir o Adapter

CARRIERS

UNITOFMEASURE (

MATA050

QIEA030) cadastrado.

Invoice MessageMensagem da nota
QuantityQuantidadeCódigo referente ao registro Protheus (
C5
C6_
MENNOTA
QTDVEN).
FreightValueValor do Frete
UnityPricePreço unitárioCódigo referente ao registro Protheus (
C5_FRETE
C6_PRCVEN) e na mensagem de recebimento grava também o campo (C6_PRUNIT).
GrossWeight
TotalPrice

Peso Bruto

Código referente ao registro Protheus (C5_PBRUTO).

InsuranceValueValor do Seguro
Valor TotalCódigo referente ao registro Protheus (C6_VALOR).
TypeOperationTipo da OperaçãoSe menor que 3 será tratado como C6_OPER, caso contrario será tratado como C6_TES.
CostCenterCodeCentro de CustoCódigo referente ao registro Protheus (
C5
CTT_
SEGURO
CUSTO).
SellerCode
CostCenterInternalId

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.

InternalID do Centro de Custo

O campo é preenchido

PriceTableNumber

Tabela de Preços

Código

com valor de referência do De/Para de

Tabela

Centro de

Preços

Custo (

DA0

CTT_CUSTO).

Para utilização deve possuir o Adapter

PRICELISTHEADERITEM (OMSA010) cadastrado.InvoiceNumber

COSTCENTER (CTBA030) cadastrado.

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

LotNumberLote do Item

Código referente ao registro Protheus (C6_LOTECTL).

SubLotNumberSub Lote do Item
Número da Nota

Código referente ao registro Protheus (

C5

C6_

NOTA

NUMLOTE).

InvoiceSerie
SeriesItemSerie do Item 
Série da Nota

Código referente ao registro Protheus (

C5

C6_

SERIE

NUMSERI).

CurrencyId
AddressingItem

Moeda

Endereço do Item

Código referente ao registro Protheus (C6_LOCALIZ).

InvoicingDateData do Faturamento

Código referente ao registro Protheus (C6_DTFAT).

DeliveryDateData de Entrega

Código referente ao registro Protheus (C6_ENTREG).

InvoiceNumberNúmero da Nota

Código referente ao registro Protheus (C6_NOTA) se o item já tiver sido faturado parcialmente.

InvoiceSerieNúmero da Série da Nota

Código referente ao registro Protheus (C6_SERIE) se o item já tiver sido faturado parcialmente.

AllocatedQuantityQuantidade Alocada

Código com valor de referência do De/Para de Moeda (CTO).

Para utilização deve possuir o Adapter CURRENCY(CTBA140) cadastrado.SalesOrderItens.ItemInternalIdInternalID Item do Pedido

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

OrderItemItem do PedidoO campo é preenchido com valor sequencial de referência do De/Para de Itens do Pedido (C6_ITEM).ItemInternalIdInternalId 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.

ItemCodeCódigo do Produto

Código referente ao registro Protheus (

B1

C6_

COD

QTDEMP).

ItemDescription
QuantityDeliveredQuantidade Entregue
Descrição do Item

Código referente ao registro Protheus (C6_

PRODUTO

QTDENT).

WarehouseInternalId
ItemReserveInternalIdReserva do Item
Locais de Estoque

O campo é preenchido com valor de referência do De/Para de

Armazém (NRR

Reserva do Item (C0_DOCRES).

Para utilização deve possuir o Adapter

WAREHOUSE (AGRA045) cadastrado.UnitOfMeasureInternalId

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

CustomerOrderNumberNúmero do Pedido do Cliente

Código referente ao registro Protheus (C6_PEDCLI).

ListOfApportionOrderItem
InternalIdInternalId do Pedido de Venda

Específico se houver integração com SIGAPMS.

ProjectInternalIdCódigo do Projeto
Unidade de Medida do Item

O campo é preenchido com valor de referência do De/Para de

Unidade de Medida (SAH

Projeto (AF8_PROJET).

Para utilização deve possuir o Adapter

UNITOFMEASURE (QIEA030) cadastrado.QuantityQuantidadeCódigo referente ao registro Protheus (C6_QTDVEN).UnityPricePreço unitárioCódigo referente ao registro Protheus (C6_PRCVEN).TotalPriceValor TotalCódigo referente ao registro Protheus (C6_PRUNIT).TypeOperationTipo da OperaçãoSe menor que 3 será tratado como C6_OPER, caso contrario será tratado como C6_TES.CostCenterCodeCentro de CustoCódigo referente ao registro Protheus (CTT_CUSTO).CostCenterInternalIdInternalID do Centro de CustoO campo é preenchido com valor de referência do De/Para de Centro de Custo (CTT_CUSTO

PROJECT  (PMSA200) cadastrado.

TaskInternalIdCó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.

CostCenterInternalIdInternalId do Centro de Custo

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

Para utilização deve possuir o Adapter COSTCENTER (CTBA030)

 

cadastrado.

ItemDiscounts
ValueValor 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). Para outras versões, o tratamento desta TAG é alterada, adicionando o desconto no cabeçalho (SC5) por exemplo.

rateio por centro de custo

Específico para mensagem de envio se houver integração com SIGAPMS.

QuantityQuantidade do rateio por centro de custo

Específico para mensagem de envio se houver integração com SIGAPMS.

PercentualPercentual do rateio por centro de custo


ListOfCreditDocument

CreditDocumentInternalIdInternalId do Título a Receber (Recebimento Antecipado)

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

Para utilização deve possuir o Adapter ACCOUNTRECEIVABLEDOCUMENT (FINA040)cadastrado.

ValueValor do Título RA
LotNumberLote do Item

Código referente ao registro Protheus (C6_LOTECTL).

SubLotNumberSub Lote do Item

Código referente ao registro Protheus (C6_NUMLOTE).

SeriesItemSerie do Item 

Código referente ao registro Protheus (

C6

E1_

NUMSERI

VALOR).

AddressingItemEndereço do Item

Código referente ao registro Protheus (C6_LOCALIZ).

InvoicingDateData do Faturamento

C6_DTFAT).

DeliveryDateData de Entrega

C6_ENTREG).

AllocatedQuantityQuantidade Alocada

C6_QTDEMP).

QuantityDeliveredQuantidade Entregue

C6_QTDENT).

ItemReserveInternalIdReserva do Item

O campo é preenchido com valor de referência do De/Para de Reserva do Item (C0_DOCRES).

Para utilização deve possuir o Adapter ITEMRESERVE (LOJA704) cadastrado.

CustomerOrderNumberNúmero do Pedido do Cliente

Código referente ao registro Protheus (C6_PEDCLI).

ListOfApportionOrderItemProjectInternalIdCó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.

TaskInternalIdCó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.

...

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

Aviso
titleInformações adicionais
  1. Campos sem tag - mensagem de recebimento (SC5 e SC6):
    • Os campos sem tag a serem gravados nas tabelas SC5 e SC6 são de responsabilidade do cliente, assim como o conteúdo a ser gravado nesses campos;
  2. Exclusões na seção "AddFields":
    • Os campos Log de Inclusão (_USERLGI), Log de Alteração (_USERLGA) e UUID (_MSUIDT) das tabelas SC5 e SC6 os campos já tagueados não serão incluídos na seção "AddFields";
    • Na mensagem de recebimento se houver integração com módulo SIGAPMS ou integração Protheus x HIS, o campo C5_NATUREZ será excluso da seção "AddFields pois será gravado com o conteúdo do parâmetro MV_SLMNTPV;
    • Na mensagem de recebimento o campo C5_ORIGEM não será incluído na seção "AddFields", pois se a integração for Protheus x Logix, o campo será gravado com conteúdo LOGIX, caso contrário será gravado com conteúdo MSGEAI.

06. PONTOS DE ENTRADA

07. TABELAS UTILIZADAS

  • XX4 - Adapters EAI

  • SC5 - Pedidos de Venda
  • SC6 - Itens do Pedidos de Venda

...