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

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.


{
    "cpfCnpj" : "45802428000196",
    "idRetaguardaLojaConsulta" : "05",
    "idRetaguardaLojaBaixa" : "05",
    "tipo" : ["NCC","RA"],
    "valorBaixa" : 50,
    "serieNota" : "802",
    "ccf" : "000000086",
    "idRetaguardaUsuario" : "000140"
}
{
    "data": [
        {
            "Saldo": 218.04
        }
    ],
    "message": "",
    "success": true,
    "hasNext": false
}


04. DEMAIS INFORMAÇÕES

Parâmetros de entrada (Request):

ParâmetroTipoObrigatórioObjetivo
cpfCnpjStringSPesquisar 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
idRetaguardaLojaConsultaStringNQuando 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.
idRetaguardaLojaBaixaStringSDefine qual filial será realizada a geração do título CR e a compensação do crédito disponível ao Cliente.
valorBaixaFloatSValor que deverá ser baixado do saldo
tipoArray NNCC, RA - Quando não informado, irá considerar todos os tipos previstos no Enum
serieNotaStringSSérie da nota que irá utilizar o crédito a ser consumido.
ccfStringSNúmero do documento que utilizará o crédito a ser consumido.
idRetaguardaUsuarioStringSCadastro do usuário caixa que está realizando a venda. 

05. ASSUNTOS RELACIONADOS


<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;
}

.aui-tabs.horizontal-tabs>.tabs-menu>.menu-item.active-tab a::after { 
	background: #FF9900; !important 
}

.menu-item.active-tab { 
	border-bottom: none !important; 
}

</style>