Este documento tem como objetivo explicar o funcionamento da api de consulta de planos de pagamentos (Rotina 523). | Totvs custom tabs box items |
|---|
| default | yes |
|---|
| referencia | passo1 |
|---|
| Os dados integrados são: pcplpag, PCPRODFILIAL |
|---|
API | Referência Winthor | Obs |
|---|
codigo | pcplpag.codplpag |
| descricao | pcplpag.descricao |
| numColunaPreco | pcplpag.numpr |
| formaParcelamento | pcplpag.formaparcelamento |
| prazos[0] | pcplpag.prazo1 |
| prazos[1] | pcplpag.prazo2 |
| | prazos[2] | pcplpag.prazo3 |
| prazos[3] | pcplpag.prazo4 |
| prazos[4] | pcplpag.prazo5 |
| prazos[5] | pcplpag.prazo6 |
| prazos[6] | pcplpag.prazo7 |
| prazos[7] | pcplpag.prazo8 |
| prazos[8] | pcplpag.prazo9 |
| | prazos[9] | pcplpag.prazo10 |
| | prazos[10] | pcplpag.prazo11 |
| prazos[11] | pcplpag.prazo12 |
| | codigoFilial | pcplpag.codfilial | NVL(codfilial,'99') | | tipoPrazo.sigla | pcplpag.tipoprazo | RESTRITO("G", "Restrito"),
BONIFICACAO("B", "Bonificação"),
NORMAL("N", "Normal"),
INATIVO("I", "Inativo"),
ATIVO("A", "Ativo"); | | tipoPrazo.descricao | pcplpag.tipoprazo | RESTRITO("G", "Restrito"),
BONIFICACAO("B", "Bonificação"),
NORMAL("N", "Normal"),
INATIVO("I", "Inativo"),
ATIVO("A", "Ativo"); | | percentualAcrescim | pcplpag.pertxfim |
| | prazoMedio | pcplpag.numdias |
| | descontarEntrada | pcplpag.descentlimcredcli |
| | tipoEntrada.codigo | pcplpag.tipoentrada | IGUAL(1, "Igual"),
DIFERENTE(2, "Diferente"),
SOLICITAR_ENTRADA(3, "Solicitar Entrada"); | | tipoEntrada.descriçao | pcplpag.CONTROLANUMSERIE | IGUAL(1, "Igual"),
DIFERENTE(2, "Diferente"),
SOLICITAR_ENTRADA(3, "Solicitar Entrada"); | | vendaBk | pcplpag.vendabk |
| | tipoVenda | pcplpag.tipovenda |
| | quantidadeMinimaPedido | pcplpag.numitensminimo |
| | valorMinimoPedido | pcplpag.vlminpedido |
| | ativo | pcplpag.status | ATIVO("A", "ATIVO"),
ATIVO("I", "INATIVO"); | | numeroParcelas | pcplpag.numparcelas |
| | dataCriacao | pcplpag.dtcadastro |
| | dataUltimaAtualizacao | pcplpag.dtultalter |
|
|
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | passo2 |
|---|
| Exemplo do envio da requisição: | Bloco de código |
|---|
| method: 'GET',
url: '/winthor/venda/v0/planos-pagamentos?' |
| Bloco de código |
|---|
| 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 |
|---|
| default | no |
|---|
| referencia | passo3 |
|---|
| | Bloco de código |
|---|
| {
"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 |
|---|
| default | no |
|---|
| referencia | passo4 |
|---|
| | Expandir |
|---|
| title | Apresentou 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 |
|---|
| <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 |
|---|
| title | Instalei 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 |
|---|
| {
"code": "UNK-ERR",
"message": "Erro de Requisição",
"detailedMessage": "The current Subject is not authenticated. Access denied.",
"details": []
} |
|
| Expandir |
|---|
| title | Instalei 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 |
|---|
| {
"first": false,
"items": [],
"hasNext": false
} |
|
|
|
