API de Demander: condiciones de pago

Este artículo es parte de la documentación API de integración REST.

Documentación para consultar, insertar, actualizar y eliminar condiciones de pago.

Consulta

Enumere las condiciones de pago de la empresa. Sin filtro, considera dataAlteracao de los últimos 6 meses.

Rota: {host}/public/v1/condicoes-de-pagamento?pagina={pagina}&limite={limite}&filtroDataAlteracao={data}&operadorFiltro={operador}
Método: GET

Precaución

Paginación

• pagina — base 1 (predeterminado 1)
• limite — predeterminado 100, máximo 500

Filtros

• Formato filtroDataAlteracao — Y-m-d
• operadorFiltro (opcional) — <, >, =, <=, >= (predeterminado >=)

Retorno:

{
  "condicoesDePagamento": [
    {
      "codigo": "30/60/90",
      "descricao": "30/60/90 DIAS",
      "percentualAcrescimo": 1.5,
      "percentualDesconto": 2.0,
      "ativo": 1,
      "valorMinimoPedido": 2000,
      "percJurosDesconto": 5.5,
      "bloqueiaUsoDemander": 0,
      "bloqueiaUsoPedidoLa": 0,
      "bloqueiaUsoPedidoWeb": 0,
      "prazoMedioPagamento": 60,
      "consideraLimiteCredito": 1,
      "prazos": "30,60,90",
      "dataAlteracao": "2026-07-15 10:00:00"
    }
  ]
}

Insertar o actualizar

POST inserción mediante la tecla codigo.

Rota: {host}/public/v1/condicoes-de-pagamento
Método: POST
Body: json

Propiedad	Tipo	Tamaño	Obligatorio	Descripción
código	cadena	20	✓	Código de condición. Identificador único utilizado para insertar o actualizar (upsert).
descripción	cadena	255	✓	Nombre del plazo de pago.
percentualAcrescimo	numérico			Aumentar porcentaje.
percentualDesconto	numérico			Porcentaje de descuento.
activo	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 1.
valorMinimoPedido	numérico			Valor mínimo de pedido para utilizar esta condición.
percJurosDesconto	numérico			Porcentaje de interés o descuento.
bloqueiaUsoDemander	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 0.
bloqueiaUsoPedidoLa	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 0.
bloqueiaUsoPedidoWeb	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 0.
prazoMedioPagamento	numérico			Plazo medio de pago.
consideraLimiteCredito	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 0.
plazos	cadena	255		Plazos en días, separados por comas (por ejemplo: 30,60,90).

Precaución

Inclusión

• Es necesario enviar todos los atributos que sean obligatorios. Devolver 201.

Actualización

• Sólo el atributo codigo es obligatorio.
• Devolución 200.

Cuerpo:

{
  "codigo": "30/60/90",
  "descricao": "30/60/90 DIAS",
  "percentualAcrescimo": 1.5,
  "percentualDesconto": 2.0,
  "ativo": 1,
  "valorMinimoPedido": 2000,
  "percJurosDesconto": 5.5,
  "bloqueiaUsoDemander": 0,
  "bloqueiaUsoPedidoLa": 0,
  "bloqueiaUsoPedidoWeb": 0,
  "prazoMedioPagamento": 60,
  "consideraLimiteCredito": 1,
  "prazos": "30,60,90"
}

Retorno:

{
  "codigo": "30/60/90",
  "descricao": "30/60/90 DIAS",
  "percentualAcrescimo": 1.5,
  "percentualDesconto": 2.0,
  "ativo": 1,
  "valorMinimoPedido": 2000,
  "percJurosDesconto": 5.5,
  "bloqueiaUsoDemander": 0,
  "bloqueiaUsoPedidoLa": 0,
  "bloqueiaUsoPedidoWeb": 0,
  "prazoMedioPagamento": 60,
  "consideraLimiteCredito": 1,
  "prazos": "30,60,90",
  "dataAlteracao": "2026-07-15 10:00:00"
}

Eliminar

Elimina la condición de pago.

Rota: {host}/public/v1/condicoes-de-pagamento?codigo={codigo}
Método: DELETE

Retorno:

{
  "mensagem": "Registro excluído com sucesso."
}