Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 2

changes.mady.by.user Rene Lascano

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Alberto Jose

Gravado em

Chave

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

Ao Configurar o Servidor Rest está

...

disponível a API SalesTaxes para consulta de valores e tributos em Pedido de Venda.

Produto:Microsiga Protheus®
Ambiente:Todos 
Ocorrência:API para a consulta de valores e tributos do Pedido de venda.
Passo a Passo:

Configurando o Servidor Rest no Protheus, está disponível a API SalesTaxes

, essa

. Essa API retorna os valores e Tributos

em

do pedido de venda,

temos os

sendo disponível nos verbos GET e POST

disponível na API

.

{{host}}/index/salestaxes 

Image Modified

Verbo Get:

Retorna uma lista com os Valores e Tributos de um Pedido de Venda já gravado no Protheus, ou seja, o Pedido de

venda deve existir no Protheus

Venda existente no sistema.

{{host}}/api/fat/v1/SalesTaxes/{SalesOrderId}

Image Modified

Obs.

Observação: 

na Url

A URL é

complementado

complementada com o código do Pedido de Venda que desejamos as informações, não

é

sendo necessário montar um Json com informações para essa consulta.

Temos o Retorno

Após isto, é gerado o retorno com as informações do pedido de venda

.

:

Image Removed

Image Added

Verbo Post:

Retorna uma lista com os Valores e Tributos de uma Simulação de Pedido de Venda em Json.

{{host}}/api/fat/v1/SalesTaxes

Vamos utilizar Na barra temos

Utilizamos a Ferramenta Postman para simular o envio do verbo Post para o Servidor Rest do Protheus.

Image Removed

A imagem demonstra um box apontando o método Post eo endereço do Servidor Rest com o complemento da API

salestaxes

SalesTaxes.

No corpo temos as informações do Json

Logo abaixo, é demonstrado o conteúdo do Json com suas respectivas informações que serão enviadas para que o Protheus

realize a busca das informações.

Obs.: Abaixo temos um link onde temos um detalhamento das informações que deverão ser enviadas. Verificar se as informações passadas já estão no cadastro do Protheus, caso não o sistema vai retornar no Json a falta dos cadastros.

Retorno: Temos as informações sendo enviadas como retorno, sendo que este pedido não existe na base do Protheus, diferente do exemplo do GET.

Image Removed

inclua as informações: Image Added


Ao final, temos um Json de retorno enviado pelo Protheus. Neste arquivo, contém as informações que foram enviadas e incluídas no sistema.

Image Added

Dica
titleValidação de campos obrigatórios

O parâmetro MV_VLCPAPI estabelece a validação de campos obrigatórios para a geração de pedidos.

Quando configurado com o valor .T., o sistema realiza a verificação de campos obrigatórios durante a consulta de tributos por meio da API SalesTaxes.

Aviso
titleImportante

No envio do JSON, é fundamental que as tags de dados compostos por caracteres contenham a mesma quantidade de caracteres definida no dicionário de dados, mesmo que isto implique no envio de espaços.
Por exemplo, os campos de cliente no padrão possuem tamanho de 6 caracteres, logo para um cliente cadastrado com apenas 5 posições ("00001") a tag "CustomerIdDelivery" deve ser enviada contendo o espaço vazio, totalizando 6 caracteres ( "00001 "). Este comportamento visa evitar que o processo "manipule" o dado complementando o valor, o que poderia acarretar em assumir valores indevidos no processamento, além do tempo de processamento dos dados que seria estendido gerando risco no timming de retorno de integrações e serviços.

O Protheus retornará um Json após a execução da API SalesTaxes e, neste momento, gerará a tag "codigo_produto" com o tamanho do campo de código de produto (B1_COD) contido na tabela SB1.  Caso o código não preencha o tamanho total do campo, serão incluídos espaços em branco para completar o seu tamanho.

Exemplo:

Campo B1_COD → Tamanho 30

Código do Produto → "WFRS-12"

Tag "codigo_produto" → "WFRS-12                      "

Pode lhe interessar:

Habilitar o Serviço de APIs para o produto Protheus.

Aviso
titleImportante

Podemos observar que o campo no Retorno do Json que o Protheus enviou o campo codigo_produto que se encontra na linha 38 no exemplo de retorno da imagem acima está com o código do produto e os espaços em branco a direita, isso é envidado dessa forma pois como existiam integrações e já existentes foi mantida os tamanhos dos campos.

Para mais informações acesse o Link:

API para Consulta de Valores e Tributos (SalesTaxes) em Pedidos de Venda TOTVS

Pode lhe interessar:Habiliar o Serviço de APIs para o produto Protheus.