GET planos pagamento - Varejonline/api GitHub Wiki

URLs

GET https://integrador.varejonline.com.br/apps/api/planos-pagamento

GET https://integrador.varejonline.com.br/apps/api/planos-pagamento/:id

Parâmetros

Retorno

  • id: id do plano de pagamento (long)
  • descricao: descrição do plano de pagamento (string)
  • dataAlteracao: última data de alteração do plano de pagamento, no formato dd-mm-aaaa hh:mi:ss (string)
  • ativo: indica o se o plano de pagamento está ativo ou inativo (booleano)
  • tipoVencimento: indica o tipo de vencimento (Fixo, variável ou à faturar) (string)
  • utilizaDataCorte: indica se o plano de pagamento utiliza data de corte (booleano)
  • diaCorteMensal: indica o dia de corte mensal (int)
  • substituiCortePadrao: indica se o plano de pagamento utiliza data de corte substituta (booleano)
  • cortesPadrao: indicam as datas de cortes padrões
    • id: id da data de corte (long)
    • mesVigenciaCorteMensal: indica o mês vigente da data de corte (int)
    • novoDiaCorteMensal: indica o novo dia de corte mensal (int)
  • juros: indica a porcentagem de juros a ser cobrado pelo plano de pagamento, em caso de atraso de pagamento (decimal)
  • acrescimo: indica a porcentagem de acréscimo a ser adicionado em um pedido de venda quando o plano de pagamento é utilizado (decimal)
  • multa: indica a porcentagem de multa a ser cobrada pelo plano de pagamento, em caso de atraso de pagamento (decimal)
  • permiteEntradas: indica se o plano de pagamento permite entradas (booleano)
  • parcelas: parcelas que compõem o plano
    • id: id da parcela (long)
    • porcentagem: expressa a proporção do valor da parcela em relação ao somatório de porcentagem de todas as parcelas (100) (decimal)
    • dia: número de dias até o vencimento (int)
  • planosAcumulados: indicam as datas de corte para planos de pagamentos com tipos de vencimento 'À Faturar'
    • id: id do plano acumulado (int)
    • inicio: indica o dia de ínicio do plano acumulado (int)
    • fim: indica o último dia do plano acumulado (int)

Exemplo

GET https://integrador.varejonline.com.br/apps/api/planos-pagamento

[
   {
      "id":1,
      "descricao":"A VISTA",
      "dataAlteracao":"21-01-2013 15:28:05",
      "juros": 0.0,
      "acrescimo": 0.0,
      "multa":0.0,
      "ativo":true
   },
   {
      "id": 2,
      "acrescimo": 0,
      "multa": 0,
      "juros": 0,
      "dataAlteracao": "21-03-2012 08:55:28",
      "descricao": "AVULSO",
      "ativo": true
   },
   {
      "id":100,
      "descricao":"1 + 5x CREDIÁRIO",
      "dataAlteracao":"11-01-2013 14:44:32",
      "juros": 1.50,
      "acrescimo": 3.70,
      "multa":2.30,
      "ativo":true,
      "parcelas": [
          {
              "id": 1,
              "porcentagem": 16.7,
              "dia": 0
          },
          {
              "id": 2,
              "porcentagem": 16.66,
              "dia": 30
          },
          {
              "id": 3,
              "porcentagem": 16.66,
              "dia": 60
          },
          {
              "id": 4,
              "porcentagem": 16.66,
              "dia": 90
          },
          {
              "id": 5,
              "porcentagem": 16.66,
              "dia": 120
          },
          {
              "id": 6,
              "porcentagem": 16.66,
              "dia": 150
          }
        ]
   },
   {
        "id": 103,
        "descricao": "À FATURAR ",
        "dataAlteracao": "19-01-2026 10:34:34",
        "ativo": true,
        "tipoVencimento": "A Faturar",
        "utilizaDataCorte": false,
        "substituiCortePadrao": false,
        "cortesPadrao": [],
        "permiteEntrada": true,
        "parcelas": [
            {
                "id": 18,
                "porcentagem": 100,
                "dia": 0
            }
        ],
        "planosAcumulados": [
            {
                "id": 1,
                "inicio": 1,
                "fim": 4
            },
            {
                "id": 2,
                "inicio": 5,
                "fim": 6
            },
            {
                "id": 3,
                "inicio": 7,
                "fim": 29
            }
        ],
        "juros": 0,
        "acrescimo": 0,
        "multa": 0
    },
    {
        "id": 102,
        "descricao": "FIXO - DATA DE CORTE",
        "dataAlteracao": "19-01-2026 10:33:41",
        "ativo": true,
        "tipoVencimento": "Fixo",
        "utilizaDataCorte": true,
        "diaCorteMensal": 2,
        "substituiCortePadrao": true,
        "cortesPadrao": [
            {
                "id": 2,
                "mesVigenciaCorteMensal": 2,
                "novoDiaCorteMensal": 4
            },
            {
                "id": 1,
                "mesVigenciaCorteMensal": 3,
                "novoDiaCorteMensal": 6
            }
        ],
        "permiteEntrada": false,
        "parcelas": [
            {
                "id": 13,
                "porcentagem": 20,
                "dia": 2
            },
            {
                "id": 14,
                "porcentagem": 20,
                "dia": 2
            },
            {
                "id": 15,
                "porcentagem": 20,
                "dia": 2
            },
            {
                "id": 16,
                "porcentagem": 20,
                "dia": 2
            },
            {
                "id": 17,
                "porcentagem": 20,
                "dia": 2
            }
        ],
        "juros": 0,
        "acrescimo": 0,
        "multa": 0
    },

]