API : Compras > Pagos

https://www.obuma.cl/ayuda/articulo/596/api--compras--pagos


API Endpoint: Compras Pagos

 

Listar Pagos

  • URL: /comprasPagos.list.json
  • Método: GET
  • Descripción: Obtiene una lista de todos los pagos realizados en el contexto de compras. Este endpoint permite aplicar filtros y paginación para limitar la cantidad de resultados.
  • Parámetros (opcional):
    • mes: Filtra los pagos por el mes de registro (cp_mes).
    • ano: Filtra los pagos por el año de registro (cp_ano).
    • fecha_ingreso_desde: Filtra los pagos por fecha ingreso >= .
    • fecha_ingreso_hasta: Filtra los pagos por fecha ingreso <= .
    • origen: Filtra los pagos por el origen (cp_origen).
    • compra_id: Filtra los pagos para una compra en especifico.
  • Límites:
    • Limit: El límite máximo de resultados es de 500 registros por solicitud.
  • Paginación:
    • La consulta original cuenta con paginación aplicada a través de los parámetros LIMIT y OFFSET.
  • Respuesta:
    • El endpoint devuelve un array de objetos que representan cada pago realizado. Dentro de estos objetos, se incluye el nombre del origen del pago, basado en los siguientes códigos:
      • 0: compras
      • 1: boletas-honorarios
      • 2: pago-iva
      • 3: remuneraciones
      • 4: anticipos-proveedores
      • 5: pago-imposiciones

Ejemplo de un objeto en la respuesta:

 {
    "cp_id": 123,
    "cp_fecha_ingreso": "2024-08-20",
    "cp_mes": "08",
    "cp_ano": "2024",
    "cp_origen": 0,
    "cp_origen_nombre": "compras",
    "cp_monto": 100000,
    ...
}