Histórico da Página

1. VISÃO GERAL

Implementada a funcionalidade de Integração BackOffice do sistema Microsiga Protheus® (Importante: para release 12.1.25 ou superior) com o sistema E-Commerce da VTEX®, possibilitando a troca de informações e processos detalhados abaixo.

Os dados são enviados/recebidos por meio da mensagem padronizada TOTVS com a funcionalidade EAI (Enterprise Application Integration), disponível no módulo Configurador.

Nesse modelo as integrações serão direcionandas direcionadas diretamente a à rotina MATA410 (Pedido de VendasFINA040 (Títulos a Receber).

2. DETALHAMENTO

Deck of Cards

id	Cenario
effectType	fade

Card

id	1
label	Preparação Integração EAI
effectType	fade

Expandir

title	Configuração EAI

Para maiores informações de como configurar a integração,

Acesse:

Integração Microsiga Protheus e VTEX via FINANCEVTEX x VTEX - Via Mensagem Padronizada (EAI) - Integração Financeira

Card

id	1
label	Configurações
effectType	fade

Expandir

title	Parâmetros Necessários

MV_LJEAIVT : Habilita a integração do VTEX com o MATA410 (Pedido de venda)

Configurar o parâmetro como .T.

Card

id	1
label	Breve explicação dos campos
effectType	fade

LJGERTX : SIGALOJA 0013 Finalidade do parâmetro MV_LJGERTX - Linha Microsiga Protheus - TDN (totvs.com)

Quando o parâmetro MV_LJGERTX estiver configurado com conteúdo igual a .T., o valor das taxas cobradas pelas Administradoras Financeiras é discriminado nos títulos do Contas a Pagar, e o valor bruto da venda (valor líquido somado à taxa da administradora), é exibido nos títulos gerados em Contas a Receber.

Se for igual a .F. o valor da taxa, será descontado do titulo a receber.

Configurar os parâmetros relacionados as naturezas, conforme link: SIGALOJA 0320 Quais são os parâmetros que definem os tipos de Naturezas?

MV_NATVALE;

MV_NATCART;

MV_NATTEF;

MV_NATCONV;

MV_LJNATFI;

MV_NATFIN;

MV_NATPGDG;

MV_NATOUTR;

MV_NATPGPX

Expandir

title	Campos Json

"Transaction": "RETAILSALES", - Campo necessário para o correto direcionamento ao adapter EAI

"Event":"upsert", - Indicativo da operação (upsert - Inclusao ou alteração/DELETE - Exclusao do pedido)

"DeliveryType":"sync" - Indica se a operação será sincrona ou assincrona

"ItemCode":"VTEX001", - Codigo do produto

"OperationCode":"630", Código da TES

"CustomerVendorInternalId":"LOJ701_214_CLIENTE", - Código do Cliente

"ItemReserveInternalId":"" - Código da Reserva

"UUID":"LOJ701_214_RETAILSALES_A81", - Identificado único da comunicação (Presente na tabela XX3, campo XX3_UUID)

Card

id	1
label	Mensagem JSONRegras de Validação
effectType	fade

Regras de validação:

Caso o "PaymentMethodCode" for diferente de cartão de crédito, não é necessário enviar o "PaymentDetail":

Se não for enviado o DocumentCode, o sistema irá gerar com a próxima numeração da SE1

Se for enviado o DocumentCode, o FinanceNature também passa a ser obrigatório ser enviado

Para pagamentos via boleto bancário, as TAG´s ProductName e PaymentMethodCode deverão ser enviadas:

"PaymentMethodCode": "BOL",

Caso as tags abaixo sejam enviadas em conjunto do tipo Boleto, os títulos serão baixados automaticamente:

  "BankCode": "237",
                "AgencyCode": "00000",
                "AccountCode": "0000000000",

Card

id	1
label	Breve explicação dos campos
effectType	fade

Expandir

title	Campos Json

Header:

"Transaction": "LISTOFACCOUNTRECEIVABLEDOCUMENT", → Campo necessário para o correto direcionamento ao adapter EAI

"DeliveryType":"sync" → Indica se a operação será síncrona ou assíncrona

"UUID":"000000000000000860", → Identificado único da comunicação (Presente na tabela XX3, campo XX3_UUID)

Documents:

"Prefix":"LF3", → Prefixo do título (E1_PREFIXO)

"DocumentCode":"000000001", → Número do Título E1_NUM. Caso não for preenchido o sistema irá buscar uma próxima numeração considerando Prefixo(E1_PREFIXO) e Tipo(E1_TIPO).

"CustomerCode":"LF0001", → Cód. Cliente (A1_COD/E1_CLIENTE)

"CustomerStore":"01", → Loja Cliente (A1_LOJA/E1_LOJA)

"CustomerVendorInternalId":"", → Id do Cliente na aplicação de origem. Caso não forem preenchidos CustomerCode e CustomerStore, o sistema irá consultar o CustomerVendorInternalId no cadastro de De/Para de Mensagem Única (tabela XXF)

"PaymentMethodCode":"CC", → Tipo do título (E1_TIPO)

"FinanceNature":"LF007", → Natureza do título (E1_NATUREZ)

"IssueDate":"29/06/2021", → Data Emissão (E1_EMISSAO)

"RealDate":"29/06/2021", → Data Vencimento (E1_VENCTO)

"Observation":"OBSERVACAO", → Histórico (E1_HIST)

"ECommerceOrder":"000011", → Identificação na aplicação origem

"CurrencyCode":"1", → Moeda do título (E1_MOEDA)

"TotalPrice":200, → Valor do título (E1_VALOR)

"BankCode":"237", → Banco (A6_COD)

"AgencyCode":"00001", → Agência (A6_AGENCIA)

"AccountCode":"0000000001", → Conta (A6_NUMCON)

PaymentDetail

"UniqueSerialNumber":"123456", → Identificador da transação TEF - Cartão de Crédito

"DateOfPayment":"2020-11-26T00:00:00", → Data Pagamento

"FinancialManagerCode":"001", → Código da administradora Financeira (AE_COD)

"PaymentValue":100, → Valor Total do Pagamento

"Parcel":"2", → Quantidade de Parcelas do Pagamento

Caso o pedido tenha que ser excluído deve ser enviado o Campo "Event", com o contéudo "DELETE" , o protheus irá entender que o pedido deverá serexcluído, caso tenha as condições necessárias para a exclusão

Exemplo JSON de Exclusão:

{
   "Header":{
      "Version":"2.005",

{
    "Header": {
        "Version": "1.000",

"CompanyId": "T1",

"BranchId": "D MG 01",

"BusinessUnit": "MG ",

"GeneratedOn": "2021-06-09T11:53:47Z",

"Enterprise": "T1",

"ProductVersion": "12",

"SourceApplication": "VTEX",

"ProductName": "

VTEX

ECOMMERCE",

"Transaction": "

RETAILSALES

LISTOFACCOUNTRECEIVABLEDOCUMENT",

"StandardVersion": "1.000",

"UUID":

"LOJ701_214_RETAILSALES_A81

"000000000000000860",

"SubType": "event",

"Type": "BusinessMessage",

"DeliveryType": "

sync

async"

},

"Content": {

"Event": "upsert",

"

CompanyId

Documents":

"T1",
"BranchId

[
{
"Prefix": "

D MG 01

001",

"InternalId":"LOJ701_348",
"

"DocumentCode": "

701222

000001",

"CustomerVendorInternalId": "

LOJ701_214_CLIENTE

",

"ECommerceOrder": "

1133730662947-01

000001",

"PersonalIdentification":"26624641860",

"TotalPrice":

160

200.00,

"

DiscountValue

CurrencyCode":

0.00,
"IncreaseValue":0

"1",

"

NetPrice

CustomerCode":

160.00,
"IssueDateDocument":"2021-06-09T11:55:00

"000001",

"

SerieCode

CustomerStore": "

U15

01",

"

GrossPrice

FinanceNature":

160.00,
      "CommodityPrice":160.00,
      "OperatorCode":"C07",
      "StationCode":"001",
      "Change":"0",
      "FreightValue": 11.83,
      "KindOfDocument":"CF",
      "IsCanceled":false,
      "KeyAcessNFe":"",
      "StationSalePointCode":"001",
      "CarrierCode":"",
      "CarrierInternalId":"",
      "ListOfSaleItem":{
         "SaleItem":[
            {
               "ItemCode":"VTEX001",
               "ItemOrder":"1",
               "Quantity":1.00,
               "UnitPrice":160.00,
               "ItemPrice":160.00,
               "DiscountAmount":10.00000,
               "OperationCode":"630",
               "IsCanceled":false,
               "ItemDeliveryType":"3",
               "ItemReserveInternalId":""
            }
         ]
      },
      "ListOfSaleCondition":{
         "SaleCondition":[
            {
               "DateOfPayment":"2021-06-09T00:00:00",
               "PaymentValue":75.00,
               "PaymentMethodCode":"CC",
               "FinancialManagerCode":"",
               "EftDate":"",
               "EftAutorization":"",
               "EftInstitute":"",
               "UniqueSerialNumber":"",
               "EftDocument":""
            },
            {
               "DateOfPayment":"2021-06-09T00

"999999",
                "IssueDate": "24/06/2021",
                "RealDate": "24/06/2021",
                "Observation": "OBSERVACAO",
                "PaymentMethodCode": "CC",
                "BankCode": "237",
                "AgencyCode": "00000",
                "AccountCode": "0000000000",
                "PaymentDetail": [
                    {
                        "FinancialManagerCode": "001",
                        "UniqueSerialNumber": "123456",
                        "DateOfPayment": "2020-11-26T00:00:00",

"PaymentValue":

75.00

100,

"

PaymentMethodCode

Parcel": "

BOL

2"

,
               "FinancialManagerCode":"",
               "EftDate":"",
               "EftAutorization":"",
               "EftInstitute":"",
               "UniqueSerialNumber":"",
               "EftDocument":""
            }
         ]
      }

                    }
                ]
            }
        ]
    }
}

Card

id	1
label	Mensagem JSON
effectType	fade

Mensagens JSON para a integração dos Pedidos de Venda

Expandir

title	Json Pedido de Venda - Inclusão

{
   "Header":{
      "Version":"2.005",
      "CompanyId": "T1",
      "BranchId": "D MG 01",
      "BusinessUnit":"MG ",
      "GeneratedOn":"2021-06-09T11:53:47Z",
      "Enterprise": "T1",
      "ProductVersion":"12",
      "SourceApplication": "VTEX",
      "ProductName": "VTEX",
      "Transaction": "RETAILSALES",
      "StandardVersion":"1.000",
      "UUID":"LOJ701_214_RETAILSALES_A81",
      "SubType":"event",
      "Type":"BusinessMessage",
      "DeliveryType":"sync"
   },
   "Content":{
      "Event":"upsert",
     "CompanyId": "T1",
      "BranchId": "D MG 01",
      "InternalId":"LOJ701_348",
      "DocumentCode":"701222",
      "CustomerVendorInternalId":"LOJ701_214_CLIENTE",
      "ECommerceOrder": "1133730662947-01",
      "PersonalIdentification":"26624641860",
      "TotalPrice":160.00,
      "DiscountValue":0.00,
      "IncreaseValue":0,
      "NetPrice":160.00,
      "IssueDateDocument":"2021-06-09T11:55:00",
      "SerieCode":"U15",
      "GrossPrice":160.00,
      "CommodityPrice":160.00,
      "OperatorCode":"C07",
      "StationCode":"001",
      "Change":"0",
      "FreightValue": 11.83,
      "KindOfDocument":"CF",
      "IsCanceled":false,
      "KeyAcessNFe":"",
      "StationSalePointCode":"001",
      "CarrierCode":"",
      "CarrierInternalId":"",
      "ListOfSaleItem":{
         "SaleItem":[
            {
               "ItemCode":"VTEX001",
               "ItemOrder":"1",
               "Quantity":1.00,
               "UnitPrice":160.00,
               "ItemPrice":160.00,
               "DiscountAmount":10.00000,
               "OperationCode":"630",
               "IsCanceled":false,
               "ItemDeliveryType":"3",
               "ItemReserveInternalId":""
            }
         ]
      },
      "ListOfSaleCondition":{
         "SaleCondition":[
            {
               "DateOfPayment":"2021-06-09T00:00:00",
               "PaymentValue":75.00,
               "PaymentMethodCode":"CC",
               "FinancialManagerCode":"",
               "EftDate":"",
               "EftAutorization":"",
               "EftInstitute":"",
               "UniqueSerialNumber":"",
               "EftDocument":""
            },
            {
               "DateOfPayment":"2021-06-09T00:00:00",
               "PaymentValue":75.00,
               "PaymentMethodCode":"BOL",
               "FinancialManagerCode":"",
               "EftDate":"",
               "EftAutorization":"",
               "EftInstitute":"",
               "UniqueSerialNumber":"",
               "EftDocument":""
            }
         ]
      }
   }
}

Expandir

title	Json Pedido de Venda - Alteração

Caso o pedido tenha que ser alterado deve ser enviado o Campo "InternalId", com o numero do pedido do VTEX, o protheus irá entender que o pedido já existe e irá alterá-lo caso tenha as condições necessárias para a alteração

Exemplo JSON de Alteração:

{
   "Header":{
      "Version":"2.005",
      "CompanyId": "T1",
      "BranchId": "D MG 01",
      "BusinessUnit":"MG ",
      "GeneratedOn":"2021-06-09T11:53:47Z",
      "Enterprise": "T1",
      "ProductVersion":"12",
      "SourceApplication": "VTEX",
      "ProductName": "VTEX",
      "Transaction": "RETAILSALES",
      "StandardVersion":"1.000",
      "UUID":"LOJ701_214_RETAILSALES_A81",
      "SubType":"event",
      "Type":"BusinessMessage",
      "DeliveryType":"sync"
   },
   "Content":{
      "Event":"upsert",
     "CompanyId": "T1",
      "BranchId": "D MG 01",
      "InternalId":"LOJ701_348",
      "DocumentCode":"701222",
      "CustomerVendorInternalId":"LOJ701_214_CLIENTE",
      "ECommerceOrder": "1133730662947-01",
      "PersonalIdentification":"26624641860",
      "TotalPrice":160.00,
      "DiscountValue":0.00,
      "IncreaseValue":0,
      "NetPrice":160.00,
      "IssueDateDocument":"2021-06-09T11:55:00",
      "SerieCode":"U15",
      "GrossPrice":160.00,
      "CommodityPrice":160.00,
      "OperatorCode":"C07",
      "StationCode":"001",
      "Change":"0",
      "FreightValue": 11.83,
      "KindOfDocument":"CF",
      "IsCanceled":false,
      "KeyAcessNFe":"",
      "StationSalePointCode":"001",
      "CarrierCode":"",
      "CarrierInternalId":"",
      "ListOfSaleItem":{
         "SaleItem":[
            {
               "ItemCode":"VTEX001",
               "ItemOrder":"1",
               "Quantity":1.00,
               "UnitPrice":160.00,
               "ItemPrice":160.00,
               "DiscountAmount":10.00000,
               "OperationCode":"630",
               "IsCanceled":false,
               "ItemDeliveryType":"3",
               "ItemReserveInternalId":""
            }
         ]
      },
      "ListOfSaleCondition":{
         "SaleCondition":[
            {
               "DateOfPayment":"2021-06-09T00:00:00",
               "PaymentValue":75.00,
               "PaymentMethodCode":"CC",
               "FinancialManagerCode":"",
               "EftDate":"",
               "EftAutorization":"",
               "EftInstitute":"",
               "UniqueSerialNumber":"",
               "EftDocument":""
            },
            {
               "DateOfPayment":"2021-06-09T00:00:00",
               "PaymentValue":75.00,
               "PaymentMethodCode":"BOL",
               "FinancialManagerCode":"",
               "EftDate":"",
               "EftAutorization":"",
               "EftInstitute":"",
               "UniqueSerialNumber":"",
               "EftDocument":""
            }
         ]
      }
   }
}

Expandir

title	Json Pedido de Venda - Exclusão

HTML

<!-- esconder o menu --> 


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave