Páginas filhas
  • APIs Integrações - Planos de Pagamentos

Versões comparadas

Chave

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

...

Totvs custom tabs box
tabsDados integrados com Winthor, Envio Parâmetros, Resposta da Requisição, Principais dúvidas e conflitos
idspasso1,passo2,passo3,passo4

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

Totvs custom tabs box items
defaultyes
referenciapasso1

Os dados integrados são: 

PCPLPAG - Cadastro de planos de pagamento


API

Referência Winthor

ObsReferência das imagens abaixo

codigo

pcplpag.codplpag

Código do plano de pagamento (condição)1

descricao

pcplpag.descricao 

Descrição2

numColunaPreco

pcplpag.numpr

Indica qual coluna de preços do preço por região será usada5

formaParcelamento

pcplpag.formaparcelamento

C - Customizado | T - Dia fixo8

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
codigoFilialpcplpag.codfilialNVL(pcplpag.codfilial,'99') 4
tipoPrazo.siglapcplpag.tipoprazo

G - Restrito | B - Bonificação | N - Normal | I - Inativo | A - Ativo

21
tipoPrazo.descricaopcplpag.tipoprazoG - Restrito | B - Bonificação | N - Normal | I - Inativo | A - Ativo21
percentualAcrescimpcplpag.pertxfimPercentual de acréscimo ou desconto 6
prazoMediopcplpag.numdiasPrazo médio (soma dos prazos dividido pela quantidade de prazos preenchidos)3
descontarEntradapcplpag.descentlimcredcli
26
tipoEntrada.codigopcplpag.tipoentrada

1 - Igual | 2 - Diferente | 3 - Solicitar Entrada (SOLICITAR_ENTRADA)

21
tipoEntrada.descricaopcplpag.controlanumserie1 - Igual | 2 - Diferente | 3 - Solicitar Entrada (SOLICITAR_ENTRADA)21
vendaBkpcplpag.vendabkUsa o plano com boleto23
tipoVendapcplpag.tipovendaVV - Venda a vista | VP - Venda a prazo25
quantidadeMinimaPedidopcplpag.numitensminimo
28
valorMinimoPedidopcplpag.vlminpedido
22
ativopcplpag.status

A - Ativo | I - Inativo

7
numeroParcelaspcplpag.numparcelas
27
dataCriacaopcplpag.dtcadastro

dataUltimaAtualizacaopcplpag.dtultalter

numDiasCartaopcplpag.numdiascartao
29
tipoRestricaotiporestricao
30
restricoespcplpagrestricao.*Array de restrições31
diaFixopcplpag.diaFixo
32
diasCarenciapcplpag.diascarencia
33
numeroParcelasDiaFixopcplpag.numeroparcelasdiafixo
34
codigoCobrancapccobplpag.codcobPrimeira cobrança encontrada35
usaPlanoPagamentoAutoServicopcplpag.usaplpagautoservico
36


Image Added

Image Added



Totvs custom tabs box items
defaultno
referenciapasso2

Exemplo do envio da requisição:

Bloco de código
languagejs
titleURI
method: 'GET',
url: '/winthor/venda/v0/planos-pagamentos?'
Bloco de código
languagejs
titleParams
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 
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



Totvs custom tabs box items
defaultno
referenciapasso3
Bloco de código
languagejs
themeEclipse
{
    "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,
            "vendaVista": false
        }
    ],
 "hasNext": false
Totvs custom tabs box items
defaultno
referenciapasso4
Expandir
titleApresentou Status Code 404 Not Found ao enviar a requisição

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

Bloco de código
languagejava
<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>

Expandir
titleInstalei o serviço e apresentou Status Code 403 Forbidden ao enviar a requisição

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

Bloco de código
languagejava
{
    "code": "UNK-ERR",
    "message": "Erro de Requisição",
    "detailedMessage": "The current Subject is not authenticated.  Access denied.",
    "details": []
}
Expandir
titleInstalei o serviço e não está retornando informações

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 

Bloco de código
languagejava
{
    "first": false,
    "items": [],
    "hasNext": false
}

...