Exibir origem

Objetivo

Este documento tem como objetivo explicar o funcionamento da api de consulta de planos de pagamentos (Rotina 523).

Pré-Requisitos e Restrições

Necessário instalar os serviços winthor-venda na rotina 801 do WTA, conforme indicação Parametrizações WTA.
Para a consulta de plano de pagamento com o filtro codigoCobranca informado, é necessário que contenha o código de tipo de cobrança vinculada em Relacionamento Cobrança X Plano de pagamento na rotina 522:

TOTVS Distribuição e Varejo - linha Winthor > APIs Integrações - Planos de Pagamentos > image2023-8-15_13-11-18.png

Integração

Este documento tem como objetivo explicar o funcionamento da api de consulta de planos de pagamentos (Rotina 523).

Os dados integrados são:

PCPLPAG - Cadastro de planos de pagamento
API	Referência Winthor	Obs	Referência das imagens abaixo
codigo	pcplpag.codplpag	Código do plano de pagamento (condição)	1
descricao	pcplpag.descricao	Descrição	2
numColunaPreco	pcplpag.numpr	Indica qual coluna de preços do preço por região será usada	5
formaParcelamento	pcplpag.formaparcelamento	C - Customizado \| T - Dia fixo	8
prazos[0]	pcplpag.prazo1		9
prazos[1]	pcplpag.prazo2		10
prazos[2]	pcplpag.prazo3		11
prazos[3]	pcplpag.prazo4		12
prazos[4]	pcplpag.prazo5		13
prazos[5]	pcplpag.prazo6		14
prazos[6]	pcplpag.prazo7		15
prazos[7]	pcplpag.prazo8		16
prazos[8]	pcplpag.prazo9		17
prazos[9]	pcplpag.prazo10		18
prazos[10]	pcplpag.prazo11		19
prazos[11]	pcplpag.prazo12		20
codigoFilial	pcplpag.codfilial	NVL(pcplpag.codfilial,'99')	4
tipoPrazo.sigla	pcplpag.tipoprazo	G - Restrito \| B - Bonificação \| N - Normal \| I - Inativo \| A - Ativo	21
tipoPrazo.descricao	pcplpag.tipoprazo	G - Restrito \| B - Bonificação \| N - Normal \| I - Inativo \| A - Ativo	21
percentualAcrescim	pcplpag.pertxfim	Percentual de acréscimo ou desconto	6
prazoMedio	pcplpag.numdias	Prazo médio (soma dos prazos dividido pela quantidade de prazos preenchidos)	3
descontarEntrada	pcplpag.descentlimcredcli		26
tipoEntrada.codigo	pcplpag.tipoentrada	1 - Igual \| 2 - Diferente \| 3 - Solicitar Entrada (SOLICITAR_ENTRADA)	21
tipoEntrada.descricao	pcplpag.controlanumserie	1 - Igual \| 2 - Diferente \| 3 - Solicitar Entrada (SOLICITAR_ENTRADA)	21
vendaBk	pcplpag.vendabk	Usa o plano com boleto	23
tipoVenda	pcplpag.tipovenda	VV - Venda a vista \| VP - Venda a prazo	25
quantidadeMinimaPedido	pcplpag.numitensminimo		28
valorMinimoPedido	pcplpag.vlminpedido		22
ativo	pcplpag.status	A - Ativo \| I - Inativo	7
numeroParcelas	pcplpag.numparcelas		27
dataCriacao	pcplpag.dtcadastro
dataUltimaAtualizacao	pcplpag.dtultalter
numDiasCartao	pcplpag.numdiascartao		29
tipoRestricao	tiporestricao		30
restricoes	pcplpagrestricao.*	Array de restrições	31
diaFixo	pcplpag.diaFixo		32
diasCarencia	pcplpag.diascarencia		33
numeroParcelasDiaFixo	pcplpag.numeroparcelasdiafixo		34
codigoCobranca	pccobplpag.codcob	Primeira cobrança encontrada	35
usaPlanoPagamentoAutoServico	pcplpag.usaplpagautoservico		36

TOTVS Distribuição e Varejo - linha Winthor > APIs Integrações - Planos de Pagamentos > image-2024-9-6_18-50-23.png

TOTVS Distribuição e Varejo - linha Winthor > APIs Integrações - Planos de Pagamentos > image-2024-9-6_18-50-47.png

TOTVS Distribuição e Varejo - linha Winthor > APIs Integrações - Planos de Pagamentos > image-2024-9-6_18-58-22.png

TOTVS Distribuição e Varejo - linha Winthor > APIs Integrações - Planos de Pagamentos > image-2024-9-6_18-51-50.png

TOTVS Distribuição e Varejo - linha Winthor > APIs Integrações - Planos de Pagamentos > image-2024-9-26_15-40-6.png

TOTVS Distribuição e Varejo - linha Winthor > APIs Integrações - Planos de Pagamentos > image-2024-9-26_15-47-56.png

Exemplo do envio da requisição:

method: 'GET',
url: '/winthor/venda/v0/planos-pagamentos?'

pagina : 1								   			- número da página 
tamanho : 10										- quantidade por página  
dataUltimaAlteracao  : AAAA-MM-DDTHH:MM:SS      	- data de ultima alteração 
codfilial:											- código da filial (para mais de uma usar o separador vírgula)
codigoCobranca:        						    	- código de tipo de cobrança vinculada em Relacionamento Cobrança X Plano de pagamento, na rotina 522
codigoPlanoPagamento: 							 	- código do plano de pagamento
tiposPrazo: 							 			- lista de tipos de prazos (para mais de uma usar o separador vírgula)
tiposVenda: 							 			- lista de tipos de venda (para mais de uma usar o separador vírgula)
formasParcelamento: 							 	- lista de formas de parcelamento (para mais de uma usar o separador vírgula)
status												- A - Ativo ; I - Inativo
usaPlPagAutoServico									- S - Sim ; N - Não
matCon 												- parâmetro boolean para ser utilizado na integração do Mississauga. Demais integrações não preencher.

{
    "first": true,
    "items": [
        {
            "codigo": 81,
            "descricao": "PARCELAMENTO CUSTOMIZADO-MESMO INTERVALO",
            "numColunaPreco": 1,
            "formaParcelamento": "C",
            "prazos": [
                7,
                14,
                21,
                28,
                35,
                42,
                49,
                56,
                63,
                70,
                77,
                84
            ],
            "codigoFilial": "4",
            "tipoPrazo": {
                "sigla": "S",
                "descricao": "Não informado"
            },
            "percentualAcrescimo": 0,
            "prazoMedio": 45,
            "descontarEntrada": false,
            "tipoEntrada": {
                "codigo": 1,
                "descriçao": "Igual"
            },
            "vendaBk": false,
            "tipoVenda": "VP",
            "quantidadeMinimaPedido": 0,
            "valorMinimoPedido": 0,
            "ativo": true,
            "numeroParcelas": 0,
            "dataCriacao": "2023-07-31T17:57:10",
            "dataUltimaAtualizacao": "2023-08-01T08:58:52",
            "planoPagamentoIntegracaoExterna": {
                "solicitaDataPrimeiraParcela": false,
                "solicitaDataDemaisParcela": false,
                "diasEntreParcelas": 7,
                "prazoMaximoPrimeiraParcela": 7
            },
            "numDiasCartao": 0,
            "tipoRestricao": {
                "sigla": "CL",
                "descricao": "Cliente"
            },
            "restricoes": [
                1,
                1003
            ],
            "diaFixo": 7,
            "diasCarencia": 2,
            "numeroParcelasDiaFixo": 4,
            "usaPlanoPagamentoAutoServico": true,
            "vendaVista": false
        }
    ],
 "hasNext": false

Caso obtenha o conteúdo abaixo ao enviar a requisição, verifique na rotina 812 do WTA se os serviços winthor-tributacao e winthor-produto estão instalados. Caso não esteja, acesse a rotina 801 do WTA e realize a instalação

<html>
 
<head>
    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
    <title>Error 404 Not Found</title>
</head>
 
<body>
    <h2>HTTP ERROR 404</h2>
    <p>Problem accessing /api/branch/v1/. Reason:
        <pre>    Not Found</pre>
    </p>
    <hr><a href="http://eclipse.org/jetty">Powered by Jetty:// 9.3.21.v20170918</a>
    <hr />
 
</body>
 
</html>

Caso apresente 403 Forbidden, verifique se realizou a autenticação antes do envio da requisição.

{
    "code": "UNK-ERR",
    "message": "Erro de Requisição",
    "detailedMessage": "The current Subject is not authenticated.  Access denied.",
    "details": []
}

Caso a lista retornada esteja vazia, verifique se os filtros que você informou estão coerentes com os registros de planos cadastrados, e se há vinculo entre os planos e cobranças

{
    "first": false,
    "items": [],
    "hasNext": false
}