Saltar al contenido
API v1 · https://bentho.org/api
PATCH/api/mod/facturacion/{espacio}/payment-config

Cambia la configuración de cobro

Cambia solo los campos que mandes. Cada uno se reemplaza entero: cuentas es la lista completa y despacho, el objeto completo.

  • PERMISOescribe
  • CRÉDITOSno gasta
  • AUTENTICACIÓNBearer bth_…

PARÁMETROS

CAMPOTIPOREQUERIDOQUÉ ES
espaciostringSÍEl id del espacio (sale en GET /api/companies). Tiene que tener el módulo Facturación.

CUERPO · JSON

CAMPOTIPOREQUERIDOQUÉ ES
name · monedastringnoUn nombre y la moneda.
cuentas[{ metodo, etiqueta, numero, titular, activo }]noTodas tus cuentas. metodo y etiqueta son obligatorios; numero es contra el que se comprueba el comprobante; activo, por defecto true.
pasarela{ proveedor, public_key, secreto_webhook }noproveedor: wompi, bold o nequi_conecta. secreto_webhook se guarda y nunca se devuelve; si mandas pasarela sin él, el guardado se borra.
auto_aprobar_hastastringnoTotal máximo para aprobar solo. Para que tenga efecto manda también requiere_confirmacion_humana_siempre: false.
ventana_comprobante_horasintegernoMargen de la fecha del comprobante, en horas.
zona_horariastringnoUn nombre IANA: America/Bogota, America/Mexico_City…
ttl_reserva_minintegernoMinutos para pagar. Vale para las órdenes nuevas.
reservar_stockbooleannoApartar el stock en Productos al crear la orden.
emitir_factura_contablebooleannoEnviar la factura a Contabilidad al pagarse.
despacho{ activo, bloquea_fulfillment, campos }noVer despacho. Sin campos, vuelven los de fábrica.

RESPUESTA 200

La configuración completa, ya cambiada.

CAMPOTIPOQUÉ ES
name · monedastringUn nombre y la moneda (COP).
cuentas[]{ metodo, etiqueta, numero, titular, activo }Dónde te pagan: metodo (nequi, daviplata, bancolombia, efectivo…), etiqueta para el cliente, numero de cuenta o celular y titular. Las activas salen en cada orden.
pasarela{ proveedor, public_key } | nullTu pasarela de pago, si tienes: wompi, bold o nequi_conecta.
auto_aprobar_hastastringHasta qué total se aprueba solo un comprobante que pasa las cinco comprobaciones, y solo si requiere_confirmacion_humana_siempre (boolean) es false. De fábrica: "0" y true, es decir, nunca.
ventana_comprobante_horasintegerMargen, en horas, para la fecha del comprobante alrededor de la orden. Por defecto 24.
zona_horariastringCon qué hora local se lee el comprobante. Por defecto America/Bogota.
ttl_reserva_minintegerMinutos para pagar una orden y tiempo que se aparta su stock. Por defecto 45.
reservar_stockbooleanApartar el stock en Productos al crear la orden. Por defecto true.
emitir_factura_contablebooleanEnviar la factura a Contabilidad cuando una orden se paga. Por defecto false.
despacho{ activo, bloquea_fulfillment, campos }Qué datos de despacho se piden: ver despacho.

ERRORES DE ESTA RUTA · SIEMPRE {"detail": …}

STATUSCUÁNDODETAIL LITERAL
403El espacio no tiene el módulo Facturaciónmódulo no habilitado para este espacio.
403La clave es de solo lecturaTu cuenta es de solo lectura en este espacio.
422Un campo de despacho con nombre inválido o repetido, o un proveedor que no existe—
422Falta un campo obligatorio o uno no es de su tipo (detail es una lista)—

Y los de cualquier ruta —clave inválida, cuenta no al día, IP, límites—, en Errores, límites y créditos.

CONVIENE SABER

  • Para añadir una cuenta, lee la configuración, añade la tuya a cuentas y manda la lista entera.
  • Activa la aprobación automática solo si confías en tus cuentas: un comprobante falso y uno real pueden verse iguales.