01. DADOS GERAIS
Linha de Produto: | TOTVS Varejo Lojas |
---|---|
Segmento: | Varejo |
Módulo: | SigaLoja (Controle de Loja) |
Função: | CreditoObj CreditoAPI |
Ticket: | Não há. |
Story: | DVARLOJ1-8613 |
02. SITUAÇÃO/REQUISITO
Disponibilizar API que receba um valor a ser baixado dos créditos do cliente, e que efetue a compensação no protheus.
03. SOLUÇÃO
Foi disponibilizada API no seguinte caminho: http://{urlRest}/api/retail/v1/credito/baixa/
A API utiliza o método POST, caso queria informar parâmetros para filtro os mesmos devem ser passados no corpo.
Além disso, para a geração do título identificador dos movimentos de baixa da NCC foi criado o parâmetro MV_LJPSHPR para definir o prefixo do mesmo.
Exemplo POST:
{ "cpfCnpj" : "45802428000196", "idRetaguardaLojaConsulta" : "05", "idRetaguardaLojaBaixa" : "05", "tipo" : ["NCC","RA"], "valorBaixa" : 50, "idRetaguardaUsuario" : "000140" }
Exemplo Retorno:
{ "data": [ { "Saldo": 218.04, "idRetaguardaCredito" : "01PSH00000008601CR" } ], "message": "", "success": true, "hasNext": false }
04. DEMAIS INFORMAÇÕES
Parâmetros de entrada (Request):
Parâmetro | Tipo | Obrigatório | Objetivo |
cpfCnpj | String | S | Pesquisar com base no CPF informado no Cupom ou com base no código do cliente identificado na venda que possui o CPF informado na pesquisa |
idRetaguardaLojaConsulta | String | N | Quando não informado, irá realizar a pesquisa em todas as filiais, porém, geralmente o SE1 é compartilhado entre as filiais, ou seja, mesmo informando um código de loja, se a tabela for compartilhada, irá retornar o saldo de todas as filiais. Não deve filtrar E1_FILORI, somente o campo E1_FILIAL caso a tabela seja exclusiva. |
idRetaguardaLojaBaixa | String | S | Define qual filial será realizada a geração do título CR e a compensação do crédito disponível ao Cliente. |
valorBaixa | Float | S | Valor que deverá ser baixado do saldo |
tipo | Array | N | NCC, RA - Quando não informado, irá considerar todos os tipos previstos no Enum |
idRetaguardaUsuario | String | S | Cadastro do usuário caixa que está realizando a venda. |
Valores de retorno (Response):
Campo | Tipo | Objetivo |
Sucesso | Bool | Indicador de sucesso da operação, junto com a soma dos saldos da tabela SE1 após a compensação realizada. |
idMovimento | String | Chave identificadora do movimento de baixa da(s) NCC(s) |
Configuração do parâmetro MV_LJPSHPR:
05. ASSUNTOS RELACIONADOS
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas