Histórico da Página

OperationCode

1- Configurações iniciais. 

1.1- Primeiramente é imprescindível que o smartclient seja 32 bits para uso do SIGALOJA, podendo usar o Appserver 64 bits.

1.2- Para que o Protheus seja capaz de receber a mensagem RetailSales o serviço REST deve estar configurado em seu ambiente: Configuração REST. Para mais detalhes sobre o conceito de um serviço REST clique aqui.

1.3- Visando evitar erros do tipo, "String size overflow" é imprescindível configuração do Appserver e DBAccess, para suportar a mensagem RetailSales com até 30MB, para realizar esta configuração Clique aqui.

1.4- Para que o envio e recebimento das mensagens assíncronas seja realizado, é necessário efetuar o cadastro das rotinas FWEAIRECE /FWEAISEND, no Schedule Protheus:

FWEAISEND : Esta rotina é exclusiva para o envio das mensagens da fila do EAI. O agendamento desta rotina é realizado por Empresa cadastrada no sistema. No envio da mensagem, um canal de comunicação é aberto com o webservice do produto integrado, e esta comunicação é encerrada após o recebimento da mensagem de retorno (no caso das Mensagens Única Totvs, após o recebimento da ReceiptMessage, indicando que que o processo ocorreu corretamente) ou por timeout (mensagem com status de falha).

FWEAIRECE :   Esta rotina é exclusiva para o recebimento das mensagens do EAI Protheus. Quando configurada esta rotina inicia o processamento das mensagens disponíveis para processamento na fila do EAI Protheus.Para mais informações sobre as rotinas e forma de configuração esta disponível na documentação: Camada do EAI.

1.5- O pacote de expedição contínua do Varejo deverá estar atualizado, mais informações sobre Clique Aqui.

Obs.: A integração com VTEX, faz uso de outras mensagens padronizadas, para mais informações acessar a documentação do time de FrameWork: Integração Protheus x VTEX - Via Mensagem Padronizada (EAI)

2- Parâmetros/Ponto de Entrada

2.1- No Configurador (SIGACFG), acesse Ambientes/Cadastros/Parâmetros (CFGX017).

2.2- Configure\Crie os parâmetros abaixo:

3- Adapter

3.1- Para que o Protheus possa receber a mensagem RetailSales é necessário realizar o cadastro dos seguintes adapters: LOJA701, LOJA704 e LOJI701A. Para mais informações de como cadastrar um adapter Clique aqui.

3.2- Abaixo um exemplo do cadastro do adapter LOJA704:

3.3- Abaixo um exemplo do cadastro do adapter LOJA701:

3.4- Abaixo um exemplo do cadastro do adapter LOJI701A:

4- Configurações no modulo Controle de Lojas (Identificação de Lojas)

4.1- No modulo 12 (Controle de Lojas) acesse, Atualizações/ Gerencia de Vendas/ Identificação de Lojas gerencia.

4.2- Abaixo um exemplo do cadastro simples de Identificação de Lojas:

5- De/Para

5.1- Para que serve um De/Para?  

Devido a integração de dois sistemas diferentes nem sempre temos códigos do mesmo produto iguais entre os dois sistemas. Com isso o De/Para é muito importante, pois recebe um código do sistema externo e relaciona com o código do produto no Protheus.

5.2- Onde realizo o cadastro do De/Para?

No modulo Configurador acesse, Atualizações/ Schedule/ De/Para de Mensagem Unica. Abaixo um exemplo de como cadastrar um De/Para de produto:

• No campo Valor Externo é necessário informar o código que do produto no sistema externo.
• No campo Valor Interno, deve ser informado o Código da Empresa|Filial|Código do produto. Caso sua tabela seja compartilhada não deve ser informado a Filial na composição do Valor Interno.

5.3- Quais os De/Para utilizados no processamento da mensagem RetailSales?

• Vendedor - Não é necessário o de/para de vendedor, sendo usado o parâmetro MV_VENDPAD (Vendedor Padrão - Modulo SIGALOJA)
• Cliente - Para integração VTEX o de/para é feito automaticamente, sendo usado para a MP - RetailSales (Orçamento/Venda). Documentação na pagina: Clientes - CustomerVendor
• Produto - Na integração VTEX o de/para é feito automaticamente no momento da inclusão do produto no Protheus, sendo possível também ser realizado manualmente. Documentação na pagina: Cadastro de Produtos - Item
• Armazém/Estoque - Documentação disponível na pagina: Saldo de Estoque - Stocklevel
• Forma de Pagamento /Administradora Financeira - É necessário o de/para da tabela SX5 - Formas de pagamento, exemplo para tabela compartilhada: 

O De/Para deve ser realizado a partir da bloco Json recebido na MP - RetailSales, colocando a informação recebida no valor externo, como mostra no exemplo:

"SaleCondition": [
					{
						"UniqueSerialNumber": "745492",
						"DateOfPayment": null,
						"PaymentValue": 105,
						"PaymentMethodCode": "CC",
						"FinancialManagerCode": "CAR"
					}
				]

• Reserva - Na Integração VTEX de/para é feito automaticamente no recebimento da MP - ItemReserve. Documentação na pagina: Reserva de Item - ItemReserve
• Transportadora - No caso da Transportadora não é necessário o uso do de/para, sendo possível usar o código recebido pela tag "CarrierCode". Agora queira usar o de/para poderá ser usado da seguinte forma pela tabela SA4:

• Estação de Trabalho - Na Integração VTEX  de/para é feito automaticamente no recebimento da MP - RetailSales, caso queira usar outra basta realizar o seguinte cadastro de/para de exemplo:

Documentação Cadastro de Estação de Trabalho (PDV) - ListOfStationSalePoint

Obs.: Por padrão a integração recebe na tag StationSalePointInternalId=AUTOMATICA, se desejar definir uma estação diferente, basta informar na TAG um valor de referência para de/para.

• Operador de Caixa - Na Integração VTEX  de/para é feito automaticamente no recebimento da MP - RetailSales, caso queira usar outra basta realizar o seguinte cadastro de/para de exemplo:

6- Fluxo da integração da mensagem

6.1 - RetailSales - item Entrega

Após ter realizado as configurações acima a integração de Venda - RetailSales seguirá os seguintes fluxos:

• ItemReserve - Com a venda realizada na plataforma do E-Commerce será disparado uma Mensagem Padronizada de Reserva de itens - Produtos no Protheus, essa reserva por sua vez ira percorrer o processo configurado pelo modulo estoque, podendo retirar do estoque o que foi enviado na MP - ItemReserve.

  Aviso
  title Aviso!
  Reservas utilizando produto com Controle de Lote (B1_RASTRO), não estão homologadas com o VTEX. Caso o produto a ser reservado tenha controle de Lote ativo (B1_RASTRO), deverá ser informado o os dados do lote de acordo com as tags abaixo: "LotNumber" - Lote "SubLotNumber" - SubLote "AddressingItem" - Endereçamento "SeriesItem" - Serie Caso as tags referende aos dados do lote não forem enviadas na mensagem, o sistema irá carregar as informações automaticamente utilizando como ordem a data de validade do Lote. Para reservas integradas via MP - ItemReserve o cancelamento automático de reserva com a validade expirada (C0_VALIDA) está desabilitado. O cancelamento de Reserva só será realizado via Mensagem Padronizada com o evento delete que se encontra dentro do Content no Json EVENT = DELETE O cancelamento de reserva também poderá ser realizado via tela na rotina Controle de Reservas - MATA430.

• CustomerVendor - Apos a confirmação de Reserva de Itens é disparado uma Mensagem Padronizada de Clientes para o Protheus. A MP de Clientes pode ser de inclusão ou de alteração.
• RetailSales - Apos a confirmação de inclusão ou alteração de Cliente é disparado uma Mensagem Padronizada de Vendas para o Protheus. O processo de inclusão do orçamento das tabelas SL1, SL2 e SL4 passa por toda a validação de registros do modulo SIGALOJA. O registro totalmente validado é incluído para próxima etapa, quaisquer informações invalidas identificado nesse processo ira retornar uma critica a integração E-Commerce. 
  •  Importante : Somente é homologado pedidos com pagamento confirmado na plataforma VTEX, não é homologado pedido com boleto para controle de pagamento via Protheus.
• Serviço Gravabatch - Esse serviço é responsável pelo processamento do orçamento das tabelas incluídas pela MP - RetailSales. Para as vendas que estejam campo L1_SITUA = RX, este serviço tem como objetivo: Gerar financeiro, Baixa de estoque, Livros fiscais etc. Caso seja encontrado alguma inconsistência no processamento deste serviço o campo L1_SITUA é atualizado para ER. Caso o processamento da venda seja finalizado com sucesso o campo L1_SITUA é atualizado para FR.

Importante: Após explodir o orçamento SL1 o registro Pai é atualizado o campo L1_SITUA = FR e criará o registro filho com o campo L1_SITUA em branco. Qualquer mudança desses registros falhará no envio da tag RetailSalesInternalId na próxima MP - DocumentTraceAbilityOrder.

Para auxiliar na analise de erros ou criticas é possível habilitar o log do loja, abaixo segue a documentação do log:

SIGALOJA 0290 Quais são os logs auxiliares Protheus Varejo?

Links com orientações de configuração do GravaBatch:

Configuração do Job LJGRVBATCH para processamento das vendas no Protheus

SIGALOJA 0057 Qual o conceito, Configuração e Correção do campo L1_SITUA (GravaBatch, LjGrvBatch, Integração ERP)?

• DocumentTraceAbilityOrder - O Rastreio do Pedido de Vendas é enviado do sistema Protheus, e será integrado com o sistema VTEX no momento do faturamento do pedido de venda, gerando o documento de saida. Link da MP - Rastreio de Pedido de Venda
• Importante: Existe uma validação padrão dentro do módulo do Faturamento para não permitir alterar Pedido quando a origem é do Loja, o motivo é para evitar divergência de valores entre as tabelas do controle de loja e faturamento, porém, caso o cliente deseja realizar a alteração do pedido mesmo sabendo que pode ocorrer divergência de valores caso o valor total do pedido seja alterado, deve-se utilizar o ponto de entrada LJI701O2 (DVARLOJ1-5249 DT Criação de Ponto de Entrada (rotina Pedidos de venda)) para realizar a liberação da alteração.
• Estrutura de gravação: A gravação do pedido segue o padrão utilizado pelo Venda Assistida, onde o registro recebido de orçamento, após o processamento do Job Gravabatch, irá gerar um orçamento filho para a geração do Pedido. Para mais informações sobre essa estrutura, acessar o link: Como é gravado uma venda com itens do tipo ENTREGA (pedido) e RETIRA ?

6.2 - RetailSales - Item Retira

Apos ter realizado as configurações acima a integração de Venda - OrderRetail seguirá os seguintes fluxos:

• ItemReserve - Com a venda realizada na plataforma do E-Commerce será disparado uma Mensagem Padronizada de Reserva de itens - Produtos no Protheus, essa reserva por sua vez ira percorrer o processo configurado pelo modulo estoque, podendo retirar do estoque o que foi enviado na MP - ItemReserve.
• CustomerVendor - Apos a confirmação de Reserva de Itens é disparado uma Mensagem Padronizada de Clientes para o Protheus. A MP de Clientes pode ser de inclusão ou de alteração.
• RetailSales - Apos a confirmação de inclusão ou alteração de Cliente é disparado uma Mensagem Padronizada de Vendas para o Protheus. O processo de inclusão do orçamento das tabelas SL1, SL2 e SL4 passa por toda a validação de registros do modulo SIGALOJA. O registro totalmente validado é incluído para próxima etapa, quaisquer informações invalidas identificado nesse processo ira retornar uma critica a integração E-Commerce
• Serviço Gravabatch - Esse serviço é responsável pelo processamento do orçamento das tabelas incluídas pela MP - RetailSales. Para as vendas que estejam campo L1_SITUA = RX, este serviço tem como objetivo: Gerar as tabelas SL1,SL2 e SL4. Caso seja encontrado alguma inconsistência no processamento deste serviço o campo L1_SITUA é atualizado para ER. Caso o processamento da venda seja finalizado com sucesso o campo L1_SITUA é atualizado para FR.

Importante: Apos explodir o orçamento SL1 o registro Pai é atualizado o campo L1_SITUA = FR e criará o registro filho com o campo L1_SITUA em branco. Qualquer mudança desses registros falhará no envio da tag RetailSalesInternalId na próxima MP - DocumentTraceAbilityOrderRetail.

Para auxiliar na analise de erros ou criticas é possível habilitar o log do loja, abaixo segue a documentação do log:

SIGALOJA 0290 Quais são os logs auxiliares Protheus Varejo?

• Após a geração das tabelas SL1,SL2 e SL4, acessando a rotina de Venda Assistida (LOJA701):
  • No menu "Outras Ações/Confirmar Pedido Pendente", efetue a liberação do pedido - que estará com o status na cor roxa - com isso será gerada a mensagem padronizada DocumentTraceAbilityOrderRetail com o Status "Empacotado". 
  • Finalizando esse orçamento com item de pedido do tipo retira, será gerada a mensagem padronizada DocumentTraceAbilityOrderRetail com o Status "Entregue".
  • Efetuando o cancelamento do orçamento pai ( o filho não pode ser excluído pois é um pedido retira )  será gerada a mensagem padronizada DocumentTraceAbilityOrderRetail com o status "Cancelado".
  • Para maiores informações da mensagem DocumentTraceAbilityOrderRetail, acesse: DocumentTraceAbilityOrderRetail - Pedido Retira

7 - Utilizando Tes no Produto ou Tes Inteligente 

Para gravação de dados do Orçamento (Tabela SL1), é necessário a amarração da TES no produto ou configuração da TES Inteligente.

 Para a utilização da TES no produto deve ser incluído no campo TS Padrao (Campo B1_TS) como mostra o exemplo abaixo:

Agora para utilização da TES Inteligente por default da Mensagem Padronizada utilizamos a informação existente na tag "OperationCode": "01" dentro do bloco "SaleItem", assim procuramos na tabela SFM - TES Inteligente se existe uma regra com a operação 01, caso não exista a configuração infomara a seguinte mensagem: "Inconsistência no item numero do item TES não informada, verifique o Cadastro de Produto no Protheus campo B1_TS e/ou De-Para de TES(XXF) e/ou as configurações para TES Inteligente(DHJ e SFM) e/ou parâmetros MV_TESSERV e MV_TESVEND."

Seguir orientações do ERP para TES Inteligente, exemplo abaixo:

7.1 - Cenário onde pode ser usado a Tes Inteligente no orçamento SL1, SL2 e/ou SC5, SC6

• Orçamento SL1 e SL2: a tes inteligente configurada com Tp. de Operação 01 e o parâmetro MV_LJTESPE configurado com a tes para não gerar financeiro. Usado dessa forma o pedido de venda somente será gerado com a tes fixa do parâmetro.
• Pedido de Venda SC5 e SC6: Para uso da tes inteligente no pedido de venda não configurar o parâmetro MV_LJTESPE (deixando em branco), configurar regra de tes inteligente deixando o campo Gera Dupl. = Não. Dessa forma o fluxo de faturamento do pedido de venda não emitirá o financeiro duplicado.

8- Geração do Contas a Receber (SE1)

A geração dos dados do Contas a Receber (SE1), ocorre após a execução do Job de Integração de Vendas (LJGRVBATCH) e depende da

TES-Tipo de Entrada e Saída configurada e segue a sequência:

• Pesquisa da TES Inteligente rotina MaTesInt, caso não encontre, segue;
• Pesquisa da TES na tabela SBZ-Indicadores de Produtos, caso não encontre, segue;
• Pesquisa da TES no campo Tipo de Saída do Produto (B1_TS) de acordo com o produto encontrado, caso não encontre, segue;
• Valida se a venda é um RPS, se sim, busca a TES no parâmetro MV_TESSERV, caso contrário;
• Caso não ache seja RPS, busca a TES para o produto no parâmetro MV_TESVEND;
• Ao final, se nenhuma TES for encontrada haverá retorno com mensagem de inconsistência e o processo de integração não ocorrerá;

Importante:

A TES - Tipo de Entrada e Saída configurada deve ter basicamente esses campos preenchidos:

• Do tipo 'Saída': F4_CODIGO maior ou igual a 500;
• Gera Duplicata (F4_DUPLIC) igual a S;
• Gera Estoque (F4_ESTOQUE) igual a S;

Nos pedidos que contem itens do tipo "1-Retira Posterior" (Campo L2_ENTREGA igual a 1) os orçamentos filhos terão

o Contas a Receber gerado após a finalização do orçamento como venda.

9- Relacionamento entre Orçamento, Pedido de Venda, Pedidos Liberados e Contas a Receber

Relacionamento entre tabelas de Orçamento(Venda Assistida), Pedido de Venda, Pedidos Liberados (Faturamento) e Contas a Receber(Financeiro)

Colocar motivo de não permitir alteração de pedido no Faturamento.

Para encontrar os Pedido de Venda (SC5) e Contas a Receber (SE1) a partir do Orçamento (SL1) pode ser realizado dos campos:

SL1 - L1_FILIAL,  L1_ECPEDEC, L1_DOCPED, L1_SERPED 

SC5 - C5_FILIAL, C5_PEDECOM

SE1 - E1_FILIAL, E1_PREFIXO, E1_NUM

Para encontrar os Pedidos Liberados (SC9) a partir do Pedido de Venda (SC5) pode ser realizado dos campos:

SC9 - C9_FILIAL, C9_PEDIDO

Relacionamento entre as tabelas e campos:

L1_ECPEDEC = C5_PEDECOM
L1_DOCPED = E1_NUM
L1_SERPED = E1_PREFIXO
C9_PEDIDO = C5_NUM

A tabela de cabeçalho da Nota (SF2) é gerada após o Faturar o Pedido pelo módulo do Faturamento, onde:

F2_DOC = C5_NOTA

Para identificar o registro de Orçamento (SL1) que gerou o título financeiro (SE1), relaciona-se:

E1_NUM + E1_PREFIXO = L1_DOCPED + L1_SERPED

10- Exemplo das mensagens

10.1 - RetailSales - com item do tipo "Entrega"

{
	"Header": {
		"GeneratedOn": "Thu, 23 Apr 2020 17:02:20 GMT",
		"BranchId": "D MG 01",
		"DeliveryType": "async",
		"ProductName": "ECOMMERCE",
		"Type": "BusinessMessage",
		"Transaction": "RetailSales",
		"Version": "2.000",
		"UUID": "61e91b9e-e030-40d6-b0fd-dcf63e81c966",
		"SubType": "Event",
		"Event": "upsert",
		"CompanyId": "T1",
		"SourceApplication": "ECOMMERCE",
		"ProductVersion": "1.0.0"
	},
	"Content": {
		"items": null,
		"OperatorCode": "AUTOMATICO",
		"ECommerceOrder": "1027293590055-01",
		"Event": "upsert",
		"NetPrice": 203,
		"InternalId": "15da928b-9e88-4947-a508-8cdd56beabd9",
		"CarrierInternalId": "01",
		"ListOfSaleItem": {
			"SaleItem": [
				{
					"ItemOrder": 1,
					"ItemCode": "d077bf8a-bbbb-4549-9b00-1a203cfe4428",
					"UnitPrice": 18.6,
					"ItemDeliveryType": "3",
					"ItemReserveInternalId": "15da928b-9e88-4947-a508-8cdd56beabd9",
					"ItemInternalId": "d077bf8a-bbbb-4549-9b00-1a203cfe4428",
					"ItemPrice": 93,
					"InternalId": "C14B0CB7AE00430C86475D908AAB843A",
					"FreightValueProrated": 5,
					"OperationCode": "01",
					"Quantity": 5
				},
				{
					"ItemOrder": 2,
					"ItemCode": "69dbb151-bbe6-4547-853a-0342ace00eab",
					"UnitPrice": 55,
					"ItemDeliveryType": "3",
					"ItemReserveInternalId": "15da928b-9e88-4947-a508-8cdd56beabd9",
					"ItemInternalId": "69dbb151-bbe6-4547-853a-0342ace00eab",
					"ItemPrice": 55,
					"InternalId": "77B3D9FC812B47148AF774F44F9C6EF7",
					"FreightValueProrated": 5
					"OperationCode": "01",
					"Quantity": 1
				},
				{
					"ItemOrder": 3,
					"ItemCode": "79f93baf-39ac-40de-ae73-007a256dda31",
					"UnitPrice": 55,
					"ItemDeliveryType": "3",
					"ItemReserveInternalId": "15da928b-9e88-4947-a508-8cdd56beabd9",
					"ItemInternalId": "79f93baf-39ac-40de-ae73-007a256dda31",
					"ItemPrice": 55,
					"InternalId": "F4A61206DEF543E0A613EB63D1141E1D",
					"FreightValueProrated": 5,
					"OperationCode": "01",
					"Quantity": 1
				}
			]
		},
		"StationSalePointInternalId": "AUTOMATICO",
		"ListOfSaleCondition": {
			"SaleCondition": [
				{
					"UniqueSerialNumber": "004112",
					"DateOfPayment": null,
					"PaymentValue": 203,
					"PaymentMethodCode": "CC",
					"FinancialManagerCode": "CAR"
				}
			]
		},
		"DocumentCode": "1027293590055-01",
		"IntermediaryCode": "000001",
		"PresencialIndicator": "1",
		"FreightValue": 15,
		"CarrierCode": "01",
		"IssueDateDocument": "2020-04-23T17:01:06.625349+00:00",
		"CustomerVendorInternalId": "44dca035-dbbe-4aef-8c1e-c2a4acb4f88a",
		"SaleType": "V",
		"GrossPrice": 203,
		"TotalPrice": 203,
		"PersonalIdentification": "1027293590055-01",
		"DiscountValue": 0
	}
}

10.2 - RetailSales - com item do Tipo "Retira" 

{
	"Header": {
		"GeneratedOn": "Thu, 23 Apr 2020 17:02:20 GMT",
		"BranchId": "D MG 01",
		"DeliveryType": "async",
		"ProductName": "ECOMMERCE",
		"Type": "BusinessMessage",
		"Transaction": "RetailSales",
		"Version": "2.000",
		"UUID": "61e91b9e-e030-40d6-b0fd-dcf63e81c966",
		"SubType": "Event",
		"Event": "upsert",
		"CompanyId": "T1",
		"SourceApplication": "ECOMMERCE",
		"ProductVersion": "1.0.0"
	},
	"Content": {
		"items": null,
		"OperatorCode": "AUTOMATICO",
		"ECommerceOrder": "1027293590055-01",
		"Event": "upsert",
		"NetPrice": 203,
		"InternalId": "15da928b-9e88-4947-a508-8cdd56beabd9",
		"CarrierInternalId": "01",
		"ListOfSaleItem": {
			"SaleItem": [
				{
					"ItemOrder": 1,
					"ItemCode": "d077bf8a-bbbb-4549-9b00-1a203cfe4428",
					"UnitPrice": 18.6,
					"ItemDeliveryType": "1",
					"ItemReserveInternalId": "15da928b-9e88-4947-a508-8cdd56beabd9",
					"ItemInternalId": "d077bf8a-bbbb-4549-9b00-1a203cfe4428",
					"ItemPrice": 93,
					"InternalId": "C14B0CB7AE00430C86475D908AAB843A",
					"FreightValueProrated": 5,
					"DiscountAmount": 5,
					"OperationCode": "01",
					"Quantity": 5
				},
				{
					"ItemOrder": 2,
					"ItemCode": "69dbb151-bbe6-4547-853a-0342ace00eab",
					"UnitPrice": 55,
					"ItemDeliveryType": "1",
					"ItemReserveInternalId": "15da928b-9e88-4947-a508-8cdd56beabd9",
					"ItemInternalId": "69dbb151-bbe6-4547-853a-0342ace00eab",
					"ItemPrice": 55,
					"InternalId": "77B3D9FC812B47148AF774F44F9C6EF7",
					"FreightValueProrated": 5,
					"DiscountAmount": 5,
					"OperationCode": "01",
					"Quantity": 1
				},
				{
					"ItemOrder": 3,
					"ItemCode": "79f93baf-39ac-40de-ae73-007a256dda31",
					"UnitPrice": 55,
					"ItemDeliveryType": "1",
					"ItemReserveInternalId": "15da928b-9e88-4947-a508-8cdd56beabd9",
					"ItemInternalId": "79f93baf-39ac-40de-ae73-007a256dda31",
					"ItemPrice": 55,
					"InternalId": "F4A61206DEF543E0A613EB63D1141E1D",
					"FreightValueProrated": 5,
					"DiscountAmount": 5,
					"OperationCode": "01",
					"Quantity": 1
				}
			]
		},
		"StationSalePointInternalId": "AUTOMATICO",
		"ListOfSaleCondition": {
			"SaleCondition": [
				{
					"UniqueSerialNumber": "004112",
					"DateOfPayment": null,
					"PaymentValue": 203,
					"PaymentMethodCode": "CC",
					"FinancialManagerCode": "CAR"
				}
			]
		},
		"DocumentCode": "1027293590055-01",
		"FreightValue": 15,
		"CarrierCode": "01",
		"IssueDateDocument": "2020-04-23T17:01:06.625349+00:00",
		"CustomerVendorInternalId": "44dca035-dbbe-4aef-8c1e-c2a4acb4f88a",
		"SaleType": "V",
		"GrossPrice": 203,
		"TotalPrice": 203,
		"PersonalIdentification": "1027293590055-01",
		"DiscountValue": 15
	}
}

10.3 - RetailSales - recorte do JSON com demonstrativo das Formas de Pagamento e suas variações de utilização

Tags do JSON:

ListOfSaleCondition - tag que define que existem formas de pagamento na venda, é uma tag obrigatória.

SalesCondition - é a lista com as formas de pagamentos, o seu conteúdo definem as formas de pagamento que foram utilizadas

• _PAYMENTMETHODINTERNALID: Código da forma de pagamento utilizada, que pode ser padrão como CC/R$/CD/BOL ou uma forma que exista no De/Para de forma de pagamento;
  
  
• _PAYMENTMETHODCODE:  Caso conteúdo da tag _PAYMENTMETHODINTERNALID esteja em branco ou sua forma não tenha sido encontrada no Protheus, segue a busca com esse código.
  Descrição: Código da forma de pagamento utilizada, que pode ser padrão como CC/R$/CD/BOL ou uma forma que exista no De/Para de forma de pagamento;
  
  
• _FINANCIALMANAGERCODE: Código da Administradora Financeira, deve existir no De/Para do Protheus correspondendo a
  uma Administradora Financeira cadastrada ( tabela SAE ) ;
• _PAYMENTVALUE: Valor da forma de pagamento que deve ser usado como separador, o caracter ponto final ".". Exemplo: 152.52;
  
  
• _ACCOUNTRECEIVABLEDOCUMENTINTERNALID: Caso seja Integração Hotelaria e a forma de pagamento recebida seja "RA",
  será pesquisado o conteúdo de SE1-Contas à Pagar associado à forma, esse código deve estar cadastrado no De/Para (tabela XXF);
  
  
• _DATEOFPAYMENT: Data do pagamento, no padrão YYYY-MM-DD (ano - mês - dia);
  
  
• _EFTCANCELLATIONDATE: Usado para identificar a Data do cancelamento do TEF, no padrão YYYY-MM-DD (ano - mês - dia);
  
  
• _EFTDATE: Usado para identificar Data do pagamento TEF, no padrão YYYY-MM-DD (ano - mês - dia)
  caso esteja completo será capturado a hora da transação, no padrão HH:MM:SS (horas : minutos : segundos);
  Exemplo: 2020-11-26T13:45:02 ;
  
  
• _EFTDOCUMENT: Número do documento do TEF;
  
  
• _EFTAUTORIZATION: Número da autorização do TEF;
  
  
• _EFTCANCELLATIONDOCUMENT: Número do documento de cancelamento do TEF;
  
  
• _EFTCANCELLATIONDATE:  Usado para identificar Data do cancelamento do TEF, no padrão YYYY-MM-DD (ano - mês - dia)
  caso esteja completo será capturado a hora da transação, no padrão HH:MM:SS (horas : minutos : segundos);
  Exemplo: 2020-03-11T08:03:13 ;
  
  
• _EFTINSTITUTE: Instituto do TEF;
  
  
• _UNIQUESERIALNUMBER: NSU proveniente do TEF;
  
  
• _CARDNUMBER: Número do cartão;
  
  
• _BANKCHECK: Código Banco do Cheque, deve existir no De/Para do Protheus correspondendo a um banco cadastrado na tabela SX5;
• _SERIECHECK: Série do Cheque;
  
  
• _AGENCYCHECK: Agência do Cheque;
  
  
• _ACCOUNTCHECK: Conta do Cheque;
  
  
• _DOCUMENTOFIDENTIFICATION: Documento, RG, do Cheque;
  
  
• _PHONENUMBER: Número do Telefone para o cheque;
  
  
• _EFTPARCEL: Parcela do TEF;

Exemplo com 1 (uma) forma de pagamento:

		"ListOfSaleCondition": {
            "SaleCondition": [{
                    "DateOfPayment": "2020-11-26T00:00:00",
                    "PaymentValue": 50,
                    "PaymentMethodCode": "CC",
                    "FinancialManagerCode": "",
                    "UniqueSerialNumber": "145236",
                    "EftDate": "2020-11-26T13:45:02",
                    "EftAutorization": "123456789",
                    "EftInstitute": "VISA",
                    "EftDocument": "9985",
                    "EftParcel": "1"
                }
            ]
        }

Exemplo com 2 (duas) parcelas de 1 (uma) forma de pagamento:

"ListOfSaleCondition": {
            "SaleCondition": [{
                    "DateOfPayment": "2020-11-26T00:00:00",
                    "PaymentValue": 25,
                    "PaymentMethodCode": "CC",
                    "FinancialManagerCode": "",
                    "UniqueSerialNumber": "145236",
                    "EftDate": "2020-11-26T13:45:02",
                    "EftAutorization": "123456789",
                    "EftInstitute": "VISA",
                    "EftDocument": "9985",
                    "EftParcel": "1"
                },
                {
                    "DateOfPayment": "2020-11-26T00:00:00",
                    "PaymentValue": 25,
                    "PaymentMethodCode": "CC",
                    "FinancialManagerCode": "",
                    "UniqueSerialNumber": "145236",
                    "EftDate": "2020-11-26T13:45:02",
                    "EftAutorization": "123456789",
                    "EftInstitute": "VISA",
                    "EftDocument": "9985",
                    "EftParcel": "2"                    
                }
            ]
        }

Exemplo com formas de pagamento diversas:

"ListOfSaleCondition": {
            "SaleCondition": [{
                    "DateOfPayment": "2020-11-26T00:00:00",
                    "PaymentValue": 20,
                    "PaymentMethodCode": "CC",
                    "FinancialManagerCode": "",
                    "UniqueSerialNumber": "145236",
                    "EftDate": "2020-11-26T13:45:02",
                    "EftAutorization": "123456789",
                    "EftInstitute": "VISA",
                    "EftDocument": "9985",
                    "EftParcel": "1"
                },
                {
                    "DateOfPayment": "2020-11-26T00:00:00",
                    "PaymentValue": 20,
                    "PaymentMethodCode": "CC",
                    "FinancialManagerCode": "",
                    "UniqueSerialNumber": "145236",
                    "EftDate": "2020-11-26T13:45:02",
                    "EftAutorization": "123456789",
                    "EftInstitute": "VISA",
                    "EftDocument": "9985",
                    "EftParcel": "2"
                },
				{
                    "DateOfPayment": "2020-11-26T00:00:00",
                    "PaymentValue": 10,
                    "PaymentMethodCode": "R$"
                }
            ]
        }

10.4 - RetailSales - explicativo de tags do JSON com demonstrativo de como devem ser enviadas em determinados cenários

Tags do JSON - Cabeçalho:

• GrossPrice - tag que define o valor bruto, gravado no campo L1_VALBRUT, tag obrigatória.

Composição da Tag: Soma dos itens, subtraindo os descontos(item/total) e sem considerar/somar os acréscimos(frete,seguro,despesa)

• CommodityPrice - tag que define o valor da mercadoria, gravado no campo L1_VALMERC, tag obrigatória.

Composição da Tag: Soma dos itens (ItemTablePrice * Quantity), sem considerar descontos e/ou acréscimos.

• TotalPrice - tag que define o valor total da venda, gravado no campo L1_VLRTOT, tag obrigatória.

Composição da Tag: Soma dos itens, subtraindo os descontos(item/total) e sem considerar/somar os acréscimos(frete,seguro,despesa)

• NetPrice - tag que define o valor líquido, gravado no campo L1_VLRLIQ, tag obrigatória.

Composição da Tag: Soma dos itens, subtraindo os descontos(item/total) e considera/soma os acréscimos(frete,seguro,despesa)

• DiscountValue - tag que define o valor do desconto no total, gravado no campo L1_DESCONT, tag facultativa - tem tratamento caso receba valor negativo, será considerado o valor absoluto positivo.

Composição da Tag: Valor do desconto no cabeçalho da venda

• DiscountPercent - tag que define o percentual do desconto no total, gravado no campo L1_DESCNF, tag facultativa.
• FreightValue - tag que define o valor do frete no total, gravado no campo L1_FRETE, tag facultativa.

Composição da Tag: Valor do frete total (soma FreightValueProrated)

Tags do JSON - Itens:

ItemTablePrice - tag que define o preço de tabela do produto, gravado no campo L2_PRCTAB, tag facultativa - caso não seja enviada ou zerada recebe o conteúdo da tag UnitPrice.

Quantity - tag que define a quantidade, gravado no campo L2_QUANT, tag obrigatória.

UnitPrice - tag que define o preço unitário do item, gravado no campo L2_VRUNIT, tag obrigatória.

ItemPrice - tag que define o valor do item, gravado no campo L2_VLRITEM, tag obrigatória - caso não seja enviada ou zerada é efetuada o cálculo da tags: Quantity * UnitPrice.

DiscountPercentage - tag que define o percentual do desconto do item, gravado no campo L2_DESC, tag facultativa.

DiscountAmount - tag que define o valor de desconto do item, gravado no campo L2_VALDESC, tag facultativa.

FreightValueProrated - tag que define o valor rateado de frete do total, nos itens, gravado no campo L2_VALFRE, tag facultativa.

Tags do JSON - Pagamento:

PaymentValue - tag que define o valor do pagamento, gravado no campo L4_VALOR, tag obrigatória.

PERGUNTAS 

1- Os valores de Frete são validados?

Sim, os valores das tags <FreightValue > (Cabeçalho) e a soma das tags <FreightValueProrated> (Itens), devem dar o mesmo valor, senão haverá rejeição da venda enviada.

2- Os valores finais da venda são validados ?

Sim, deve haver compatibilidade dos valores enviados, a soma: itens - descontos no itens + frete do item, deve ser igual a soma: valor venda - desconto no total + frete total, sendo ainda igual 

ao total em valor das formas de pagamento.

3- a tag <NetPrice> em uma venda SEM frete e tendo desconto no total, como devo enviar ?

Ela deve ser enviada com o valor líquido, ou seja subtraindo o desconto. 
Exe.: 
Produto no valor de $100
<FreightValue> = 0
<DiscontValue> = 10
<NetPrice> = 90

4- a tag <NetPrice> em uma venda COM frete e tendo desconto no total, como devo enviar ?

Ela deve ser enviada com o valor do produto somando o frete e subtraindo o desconto. 
Exe.: 
Produto no valor de $100 / Frete de $5
<FreightValue> = 0
<DiscontValue> = 10
<NetPrice> = 95
<FreightValue> = 5

5- Quando preencho a tag <DiscountValue> ?

Somente quando houver desconto no total

6- Quando preencho a tag <FreightValueProrated> ?

Somente quando a tag <FreightValue> for maior do que zero.

7- Como funciona quando tenho um do tipo IPI ?

A partir da TES - Tipo de Entrada e Saída enviada na tag <OperatorCode>, deve estar configurada para calcular o IPI tanto Bruto quanto Líquido.

8- Como funciona a tag <ItemPrice>, presente nos itens ?

No desconto total, deve ser enviado normalmente com o preço de tabela;

No desconto do item, deve ser enviado com o desconto do item dividido pela quantidade;

No frete, deve ser enviado normalmente com o preço de tabela.

9- Como funciona a tag <TotalPrice>, presente no cabeçalho ?

No desconto total, deve ser enviado normalmente com o preço de tabela subtraído do valor do desconto;

No desconto do item, deve ser enviado com o preço de tabela;

No frete, deve ser enviado normalmente com o preço de tabela com a adição do frete.

10.4.1 - Exemplo de envio - VENDA COM DESCONTO NO TOTAL (JSON recortado somente com a tags importantes para entendimento):

Preço Unitário = $10 / Desconto no Total = $5 / Quantidade = 2

"Content": {        
        "TotalPrice": 15,
        "DiscountValue": 5,
        "NetPrice": 15,
        "GrossPrice": 15,
        "CommodityPrice": 20,
        "FreightValue": 0,
		"ListOfSaleItem": {
            "SaleItem": [{
                    "Quantity": 2,
                    "ItemTablePrice": 10,
                    "UnitPrice": 10,
                    "ItemPrice": 20,
                    "FreightValueProrated": 0,
                    "DiscountAmount": 0,
                }
            ]
        },
		"ListOfSaleCondition": {
        "SaleCondition": [
            {
                "PaymentValue": 15,
                "PaymentMethodCode": "R$",
                "FinancialManagerCode": "",
                "DateOfPayment": "2021-06-18",
                "UniqueSerialNumber": null
            }
        ]
    }
}

10.4.2 - Exemplo de envio - VENDA COM DESCONTO NO ITEM (JSON recortado somente com a tags importantes para entendimento):

Preço Unitário = $10 / Desconto no Item = $5 / Quantidade = 2

- a tag <UnitPrice> : deve ser enviada, considerando: Preço de Tabela do Produto - (Valor de Desconto do Item / Quantidade)

- a tag <ItemPrice> : deve ser enviada considerando: (Preço Unitário * Quantidade) - Valor de Desconto do Item

"Content": {        
        "TotalPrice": 15,
        "DiscountValue": 0,
        "NetPrice": 15,
        "GrossPrice": 15,
        "CommodityPrice": 20,
        "FreightValue": 0,
		"ListOfSaleItem": {
            "SaleItem": [{
                    "Quantity": 2,
                    "ItemTablePrice": 10,
                    "UnitPrice": 7.5,
                    "ItemPrice": 15,
                    "FreightValueProrated": 0,
                    "DiscountAmount": 0,
                }
            ]
        },
		"ListOfSaleCondition": {
        "SaleCondition": [
            {
                "PaymentValue": 15,
                "PaymentMethodCode": "R$",
                "FinancialManagerCode": "",
                "DateOfPayment": "2021-06-18",
                "UniqueSerialNumber": null
            }
        ]
    }
}

10.4.3 - Exemplo de envio - VENDA COM FRETE (JSON recortado somente com a tags importantes para entendimento):

Preço Unitário = $10 / Desconto no Total = $0 / Frete = $15 / Quantidade = 2

"Content": {        
        "TotalPrice": 35,
        "DiscountValue": 0,
        "NetPrice": 35,
        "GrossPrice": 35,
        "CommodityPrice": 35,
        "FreightValue": 15,
		"ListOfSaleItem": {
            "SaleItem": [{
                    "Quantity": 2,
                    "ItemTablePrice": 10,
                    "UnitPrice": 10,
                    "ItemPrice": 20,
                    "FreightValueProrated": 15,
                    "DiscountAmount": 0,
                }
            ]
        },
		"ListOfSaleCondition": {
        "SaleCondition": [
            {
                "PaymentValue": 35,
                "PaymentMethodCode": "R$",
                "FinancialManagerCode": "",
                "DateOfPayment": "2021-06-18",
                "UniqueSerialNumber": null
            }
        ]
    }
}

10.4.4 - Exemplo de envio - VENDA COM FRETE  e desconto no TOTAL (JSON recortado somente com a tags importantes para entendimento):

Preço Unitário = $10 / Desconto no Total = $5 / Frete = $15 / Quantidade = 2

"Content": {        
        "TotalPrice": 30,
        "DiscountValue": 5,
        "NetPrice": 30,
        "GrossPrice": 30,
        "CommodityPrice": 35,
        "FreightValue": 15,
		"ListOfSaleItem": {
            "SaleItem": [{
                    "Quantity": 2,
                    "ItemTablePrice": 10,
                    "UnitPrice": 10,
                    "ItemPrice": 20,
                    "FreightValueProrated": 15,
                    "DiscountAmount": 0,
                }
            ]
        },
		"ListOfSaleCondition": {
        "SaleCondition": [
            {
                "PaymentValue": 35,
                "PaymentMethodCode": "R$",
                "FinancialManagerCode": "",
                "DateOfPayment": "2021-06-18",
                "UniqueSerialNumber": null
            }
        ]
    }
}

10.4.5 - Exemplo de envio - VENDA COM FRETE  e desconto no ITEM (JSON recortado somente com a tags importantes para entendimento):

Preço Unitário = $10 / Desconto no Item= $5 / Frete = $15 / Quantidade = 2

- a tag <UnitPrice> : deve ser enviada, considerando: Preço de Tabela do Produto - (Valor de Desconto do Item / Quantidade)

- a tag <ItemPrice> : deve ser enviada considerando: (Preço Unitário * Quantidade) - Valor de Desconto do Item

"Content": {        
        "TotalPrice": 30,
        "DiscountValue": 0,
        "NetPrice": 30,
        "GrossPrice": 30,
        "CommodityPrice": 35,
        "FreightValue": 15,
		"ListOfSaleItem": {
            "SaleItem": [{
                    "Quantity": 2,
                    "ItemTablePrice": 10,
                    "UnitPrice": 7.5,
                    "ItemPrice": 15,
                    "FreightValueProrated": 15,
                    "DiscountAmount": 5,
                }
            ]
        },
		"ListOfSaleCondition": {
        "SaleCondition": [
            {
                "PaymentValue": 30,
                "PaymentMethodCode": "R$",
                "FinancialManagerCode": "",
                "DateOfPayment": "2021-06-18",
                "UniqueSerialNumber": null
            }
        ]
    }
}

11- Configuração de Administradora Financeira - Geração de Contas a Receber calculo de Data de Vencimento 

Para Formas de pagamento CC - Cartão de Credito o Protheus trabalha a partir do cadastro da Administradora Financeira.

Com a regra configurada na Administradora Financeira o calculo do vencimento será da seguinte forma: Data de Pagamento + Regra da administradora

Abaixo um exemplo de como ficará a data de vencimento:

Venda realizada no dia 05/12, primeira parcela 05/01, porém na Administradora Financeira o campo "Virar em"(AE_DIAS) está preenchido com número 30 e o vencimento do titulo será 05/01 + 30 dias (repetindo para todas as parcelas Ex: 05/02 + 30, 05/03 + 30.)

Links para melhor entendimento das configurações na Administradora Financeira:

Como configurar uma administradora financeira:

https://centraldeatendimento.totvs.com/hc/pt-br/articles/115012459768-MP-SIGALOJA-Como-cadastrar-uma-administradora-Financeira

----------

Como é definido o vencimento do titulo financeiro para formas com administradora financeira ?
https://tdn.totvs.com/pages/releaseview.action?pageId=525033971

----------
Como fixo o dia de vencimento das parcelas conforme o vencimento da primeira parcela?
https://tdn.totvs.com/pages/releaseview.action?pageId=225264318

----------
Gerar taxa da administradora financeira no contas a pagar?
https://tdn.totvs.com/pages/releaseview.action?pageId=224442986

11.1 - Configuração de campos para armazenar o NSU da transação TEF

Caso a numeração de NSU do TEF seja maior que o padrão do Protheus ( Tag UniqueSerialNumber da mensagem padronizada), os campos abaixo devem ser ajustados e possuir o mesmo tamanho:

Campos de tabelas do Varejo: L1_NSUTEF, L4_NSUTEF, LQ_NSUTEF

Campos de tabelas do Financeiro: E1_NSUTEF, MDK_NSUTEF, FIF_NSUTEF

Link com documentação sobre o conciliador do financeiro que utiliza esses campos: https://tdn.totvs.com/display/public/PROT/Conciliador+TEF+-+Financeiro+-+P12

Em caso de dúvidas sobre conciliação de pagamentos, deverá ser acionado o time de suporte do Financeiro. 

12- Tabela de Ocorrências na geração de Pedido de Venda: RetailSales

13- Cancelamentos

Cancelamento de reserva (Pagamento da venda não confirmado no E-Commerce)

• Neste cenário ainda não temos o pedido integrado no Protheus, somente a reserva integrada.
• Após o cancelamento do pedido no E-commerce, é enviado ao Protheus a mensagem ItemReserve com o evento DELETE, visando realizar o cancelamento desta reserva no Protheus.
• Ao recepcionar a mensagem, é realizado todo o fluxo de cancelamento da reserva e após sua finalização é enviado um response da mensagem ItemReserve  ao E-Commerce com o status ok, caso a reserva tenha sido cancelada corretamente.

Cancelamento de Venda não faturada

• Deve ser realizado no módulo Controle de Lojas (SIGALOJA), na rotina Venda Assistida (LOJA701), onde o orçamento pai deverá ser cancelado para que o orçamento filho (reserva) também seja deletado.

Cancelamento de Venda Faturada

• Será necessário realizar manualmente a devolução do pedido, através da rotina LOJA720 Rotina de Troca. Após realizar a devolução da venda integrada, será gerada e enviada ao E-Commerce a mensagem DocummentTraceAbilityOrder, com o status Devolvido.
• No E-Commerce deverá ser atualizado o status da venda.

14- Onde consultar demais informações sobre configurações do módulo Venda Assistida?

Abaixo link com a FAQ do Varejo:

https://tdn.totvs.com/display/public/PROT/SIGALOJA

6.1.2. Parâmetros Gerais

15- Como é fluxo de geração de Pedido x Financeiro?

Importante: Realizar o checklist abaixo para validar se todas as etapas obrigatórias foram realizadas

•  1 - Configurações iniciais
•  1.1 - Versão SmartClient
  1.2 - Serviço REST
  1.3 - String > 30mb
  1.4 - Schedule para Mensagem Padronizada
  1.5 - Expedição Varejo
•   
•  2 - Validação da lista de parâmetros
•  3 - Cadastro de Adapter
•  4 - Identificação de Lojas
•  5 - Cadastro de "De/Para"
•  6 - Entendimento sobre o fluxo de integração de Pedido Entrega e Retira
•  7 - Tes no Produto ou Tes Inteligente 
•  8 - Gravabatch
•  9 - Entendimento sobre os relacionamentos de tabelas (Loja,Financeiro e Faturamento)
•  10 - Exemplo de mensagem padronizada
•  11 - Administradora Financeira
•  12 - Tabela de possíveis ocorrências de rejeição da mensagem padronizada