API : Ventas > Cobros

https://www.obuma.cl/ayuda/articulo/333/api--ventas--cobros


API Endpoint: Ventas Cobros

 

Listar Cobros

  • URL: /ventasCobros.list.json
  • Método: GET
  • Descripción: Obtiene una lista de todos los cobros registrados para la empresa.
  • Parámetros (opcional):
    • mes: Filtra los cobros por el mes de registro (1-12).
    • ano: Filtra los cobros por el año de registro (yyyy).
    • 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.

 

 

 

Crear Cobro

  • URL: /ventasCobros.create.json
  • Método: POST
  • Descripción: Registra un nuevo cobro para un documento de venta específico.
  • Parámetros (JSON Body):
    • tipoDte: Tipo de documento electrónico al que se aplica el cobro.
    • folio: Folio del documento de venta.
    • pagado: Monto pagado.
    • formaPago: ID de la forma de pago (opcional si se proporciona formaPagoCodigo).
    • formaPagoCodigo: Código de la forma de pago (prioritario sobre formaPago).
    • referenciaFormaPago: Referencia asociada a la forma de pago (por ejemplo, número de cheque o transferencia).
    • fechaPago: Fecha en que se realizó el pago (formato yyyy-mm-dd).

 

 

Ejemplo JSON : 

{
"tipoDte" : 33,
"folio" : 10519,
"pagado" : 1000,

"formaPago" : 152,
"formaPagoCodigo" : "",

"referenciaFormaPago" : "prueba api",
"fechaPago" : "2022-02-07"

}

 

 

Por este metodo NO SE PUEDE registrar pagos con cheques.

 

Posibles retornos de error:

 
- Monto pagado<=0.
- Monto pagado>importe a pagar.


Salida resultado:
array(
'id_dte' => $id del dte,
'id_pago' => $id_pago,
'error' => $error
);

Si $id_pago > 0 ese es el pago registrado en OBUMA y se actualiza el campo venta_total_pagado y venta_total_por_pagar