Exibir origem

Objetivo

Este documento tem como objetivo explicar o funcionamento da integração do crédito do cliente para integração com PDVSYNC.

Pré-Requisitos e Restrições

Necessário a instalação do serviço winthor-integracao-varejo. Para realizar a instalação desse serviço, segue link com as devidas explicações:

Comece por aqui -> Parametrizações WTA

Crédito disponível

Os créditos estão na tabela PCCRECLI e a regra para estar disponível da baixa são: DTDESCONTO = NULL, DTESTORNO = NULL e SITUACAO = NULL

API /winthor/varejo/v1/credito-cliente método GET;
Passar os query params obrigatórios idRetaguardaCredito e idRetaguardaLoja para pesquisar o crédito

A integração consiste em consultar o crédito do cliente

Os dados integrados são:

API	Referência Winthor
idRetaguardaCredito	PCCRECLI.CODIGO
idRetaguardaLoja	PCCRECLI.CODFILIAL

Exemplo do envio da requisição:

method: 'GET'
url: '/winthor/varejo/v1/credito-cliente?idRetaguardaCredito=263&idRetaguardaLoja=1'

Exemplo JSON da resposta de crédito disponível:

{
    "success": true,
    "message": "Consulta realizada com sucesso",
     "data": {
        "creditos": [
            {
                "saldo": 0.1,
                "idRetaguardaCredito": "263"
            }
        ]
    }
}

Exemplo JSON da resposta de crédito não disponível:

{
"success": false,
"message": "O crédito 262 da filial 1 não foi encontrado ou não está disponível no ERP, Verifique se informou os dados corretamente"
}

* Também é possível consultar os créditos usando a API:

API /winthor/varejo/v1/credito-cliente/list método POST;
Passar no body da requisição um objeto JSON com os atributos idRetaguardaCredito e idRetaguardaLoja para pesquisar o crédito

A integração consiste em consultar o crédito do cliente

Os dados integrados são:

API	Referência Winthor
idRetaguardaCredito	PCCRECLI.CODIGO
idRetaguardaLoja	PCCRECLI.CODFILIAL

Exemplo do envio da requisição:
method: 'POST'

url: '/winthor/varejo/v1/credito-cliente/list

body:

{
	"idRetaguardaCredito": 261,
	"idRetaguardaLoja": "1"
}

Exemplo JSON da resposta de crédito disponível :

{
    "success": true,
    "message": "Consulta realizada com sucesso",
     "data": {
        "creditos": [
            {
                "saldo": 0.1,
                "idRetaguardaCredito": "261"
            }
        ]
    }
}

Exemplo JSON da resposta de crédito não disponível :

{
"success": false,
"message": "O crédito 262 da filial 1 não foi encontrado ou não está disponível no ERP, Verifique se informou os dados corretamente"
}

Baixa de Crédito

Para baixa de crédito, passar sempre o parâmetro "tipoOperacao": "0" no request
Fazer um request usando o payload abaixo, usando um código de crédito disponível
A baixa de credito usa o valor de NUMPEDECF localizado na tabela PCPEDCECF e caso não encontre usa o campo "numeroVenda" do payload
Caso o crédito esteja disponível, o mesmo deve ser baixado e retornar um JSON contendo o valor e o novo de código de credito gerado, conforme exemplo:

Caso o crédito esteja disponível, e o valor da baixa for o valor total do crédito, o mesmo deve ser baixado retornar um JSON contendo o valor e o código do credito baixado, conforme exemplo:

A integração consiste em baixar o crédito do cliente disponível

Os dados integrados são usados na chamada via API a package PKG_CREDITOCLIENTE função FNC_BAIXADECREDITOVAREJO

API	PARÂMETRO PACKAGE
numeroVenda	pfNUMCUPOM
serieVenda	psNUMSERIEEQUIP
numeroCaixa	pfNUMCAIXA
motivo	psHISTORICO
idRetaguardaoperador	pfMATRICULAUSUARIO
creditos.idRetaguardaCredito	pfCODIGOCREDITO
creditos.idRetaguardaLojaBaixa	psCODIGOFILIALDESCONTO
creditos.valorBaixa	pfVALORBAIXAR
Consulta interna da API conforme exemplo a seguir	pfNUMPEDECF

Exemplo do envio da requisição:

method: 'POST'
url: '/winthor/varejo/v1/credito-cliente'

Payload

{
  "idInquilino": "string",
  "numeroVenda": "2020",
  "serieVenda": "1",
  "numeroCaixa": "10",
  "tipoOperacao": "0",
  "motivo": "Teste API",
  "idRetaguardaoperador": "0",
  "origemPDV": "PDVOmnishop versão 10.3.14",
  "creditos": 	[
				  {
					  "cpfCnpj": "40023658956",
					  "idRetaguardaCredito": "276",
					  "idRetaguardaLojaConsulta": "1",
					  "idRetaguardaLojaBaixa": "1",
					  "tipo": ["ncc"],
					  "valorBaixa": 0.1,
					  "dataAtualizacao": "2023-09-20T10:04:25.159Z",
					  "dataCadastro": "2023-09-20T09:00:25.159Z"
				  }
				]
}

Exemplo JSON da resposta de crédito disponível baixado :

{
    "success": true,
    "message": "Processo de baixa de crédito realizado com sucesso",
    "data": [
        {
            "saldo": 0.1,
            "idRetaguardaCredito": "263"
        }
    ]
}

Exemplo JSON da resposta de tentativa de baixa de crédito não disponível :

{
   "success": false,
   "message": "Não foi possível realizar o processo de baixa de crédito. Por favor verifique os dados informados"
}

Internamente, a API faz uma consulta de NUMPEDECF usando o select abaixo, conforme o de/para da tabela:

SELECT NUMPEDECF  FROM PCPEDCECF p WHERE p.NUMCAIXA = :NUMCAIXA AND p.NUMCAIXAFISCAL= :NUMCAIXAFISCAL AND p.CODFILIAL = :CODFILIAL AND NUMCUPOM = :NUMCUPOM  AND p.DOCEMISSAO IS NOT NULL ;

API	PARÂMETRO SELECT
numeroCaixa	NUMCAIXA
serieVenda	NUMCAIXAFISCAL
creditos.idRetaguardaLojaBaixa	CODFILIAL
numeroVenda	NUMCUPOM

Estorno Baixa de Credito disponível:

Para estorno de baixa de crédito, passar sempre o parâmetro "tipoOperacao": "1" no request
Fazer um request usando o payload abaixo, usando um código de credito baixado
O estorno de baixa de credito usa o valor de NUMPEDECF localizado na tabela PCPEDCECF e caso não encontre usa o campo "numeroVenda" do payload
Caso o credito esteja disponível, o mesmo deve ser baixado e retornar um JSON contendo o valor e o novo de código de credito gerado, conforme exemplo:
Caso o credito esteja baixado, deverá ser estornado e retornar um JSON contendo o valor e o código do credito estornado
Caso o estorno seja de um credito que foi baixado mais de uma vez, deverá retornar uma lista com todos os créditos disponíveis após o estorno:

A integração consiste em estornar um crédito baixado anteriormente

Os dados integrados são usados na chamada via API a package PKG_CREDITOCLIENTE função FNC_ESTORNARBAIXACREDITOVAREJO

API	PARÂMETRO PACKAGE
numeroVenda	pfNUMCUPOM
serieVenda	psNUMSERIEEQUIP
numeroCaixa	pfNUMCAIXA
motivo	psHISTORICO
idRetaguardaoperador	pfMATRICULAUSUARIO
Consulta interna da API conforme exemplo a seguir	pfNUMPEDECF

Exemplo do envio da requisição:

method: 'POST'
url: '/winthor/varejo/v1/credito-cliente'

Payload

{
  "idInquilino": "string",
  "numeroVenda": "2020",
  "serieVenda": "1",
  "numeroCaixa": "10",
  "tipoOperacao": "1",
  "motivo": "Teste API",
  "idRetaguardaoperador": "0",
  "origemPDV": "PDVOmnishop versão 10.3.14",
  "creditos": 	[
				  {
					  "cpfCnpj": "40023658956",
					  "idRetaguardaCredito": "282",
					  "idRetaguardaLojaConsulta": "1",
					  "idRetaguardaLojaBaixa": "1",
					  "tipo": ["ncc"],
					  "valorBaixa": 0.1,
					  "dataAtualizacao": "2023-09-20T10:04:25.159Z",
					  "dataCadastro": "2023-09-20T09:00:25.159Z"
				  }
				]
}

Exemplo JSON da resposta de crédito estornado :

{
     "success": true,
     "message": "Processo de estorno de baixa de crédito realizado com sucesso",
     "data": [
         {
             "saldo": 0.1,
             "idRetaguardaCredito": "275"
         }
     ]
}


Exemplo JSON da resposta de estorno de credito baixado mais de uma vez

{
     "success": true,
     "message": "Processo de estorno de baixa de crédito realizado com sucesso",
     "data": [
         {
             "saldo": 0.1,
             "idRetaguardaCredito": "287"
         },
         {
             "saldo": 0.1,
             "idRetaguardaCredito": "284"
         },
         {
             "saldo": 0.1,
             "idRetaguardaCredito": "263"
         }
     ]
 }

Exemplo JSON da resposta de tentativa de estorno de crédito não baixado :

{
    "success": false,
    "message": "Não foi possível realizar o processo de estorno baixa de crédito. Por favor verifique os dados informados"
}

Internamente, a API faz uma consulta de NUMPEDECF usando o select abaixo, conforme o de/para da tabela:

SELECT NUMPEDECF  FROM PCPEDCECF p WHERE p.NUMCAIXA = :NUMCAIXA AND p.NUMCAIXAFISCAL= :NUMCAIXAFISCAL AND p.CODFILIAL = :CODFILIAL AND NUMCUPOM = :NUMCUPOM  AND p.DOCEMISSAO IS NOT NULL ;

API	PARÂMETRO SELECT
numeroCaixa	NUMCAIXA
serieVenda	NUMCAIXAFISCAL
creditos.idRetaguardaLojaBaixa	CODFILIAL
numeroVenda	NUMCUPOM