POST Planos Pagamento Compras - Varejonline/api GitHub Wiki

URL

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

Parâmetros

Envie um JSON no corpo da requisição, contendo:

  • id: id do plano de pagamento (Long)
  • descricao: descrição do plano de pagamento (String)
  • acrescimo: valor do acréscimo do plano (BigDecimal)
  • valorMinimo: valor mínimo para o plano (BigDecimal)
  • padrao: indica se o plano de pagamento é o padrão (boolean)
  • ativo: indica se o plano de pagamento está ativo (boolean)
  • sugestaoVencimento: indica se o vencimento do plano de pagamento deve ser sugerido (boolean)
  • tipo: Tipo do plano de pagamento. Este parâmetro pode assumir um dos seguintes valores: AVULSO, AVISTA, FIXO e VARIAVEL (String)
  • periodo: Período do plano de pagamento. Este parâmetro pode assumir um dos seguintes valores: MENSAL, BIMESTRAL, TRIMESTRAL e ANUAL(String)
  • parcelas: lista de parcelas do plano de pagamento:
    • id: numero da parcela (long)
    • porcentagem: porcentagem (BigDecimal )
    • dia: dia (Integer)
    • quantidadeDias: quantidade de dias (Integer)

Retorno

Sucesso:

  • HTTP STATUS 201 – CREATED
  • Body: id do plano de pagamento gerado

Requisição inválida:

  • HTTP STATUS 400 – BAD REQUEST
  • Body: mensagem de erro

Exemplo

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

'Content-Type'='application/json'

{ 
	"descricao": "PLANO PAGAMENTO 001",
	"acrescimo": 10,
	"valorMinimo":10,
	"padrao": false,
	"ativo": true,
	"sugestaoVencimento": false,
	"tipo": "FIXO",
	"periodo": "MENSAL",
	"parcelas": [
		{
			"porcentagem": 10,
			"dia": 10,
			"quantidadeDias": 10
		},
		{
			"porcentagem": 11,
			"dia": 11,
			"quantidadeDias": 11
		}
	]
}
⚠️ **GitHub.com Fallback** ⚠️