Saltar al contenido
Facturador

Editar opciones de caja

PUT /api/cash-settings

Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).

Cambia las opciones de caja. Edición parcial: envía solo lo que cambias (también acepta PATCH).

Quién puede usarlo: solo usuarios de tipo administrador (type = admin). Con el token de un vendedor responde 403.

Formato de respuesta: estándar {success, data, message?} (registro único). data trae todas las opciones ya guardadas (mismo formato que Ver opciones de caja).

Cuerpo (JSON):

Campo Tipo Obligatorio Descripción / valores permitidos
destination_sale boolean No Caja general por defecto: en los formularios de venta del sistema el primer pago aparece con destino Caja (cash) ya elegido. No cambia lo que envía una integración: en la API siempre indicas payment_destination_id.
separate_cash_transactions boolean No Valor inicial de la opción Separar ingresos y egresos del Libro de caja (separate_directions).
order_cash_income boolean No Valor inicial de Agrupar por del Libro de caja: true = por tipo de comprobante (group_by=document_type); false = sin agrupar.
available_cash_report_seller boolean No true = los vendedores pueden generar reportes de caja (solo de sus propias cajas). false = solo administradores.
disabled_cash_reports array de string o null No Tipos de reporte ocultos en el catálogo: cash_movements, cash_operations, cash_credit, cash_products. [] o null = todos visibles. El Cierre de caja (cash_close) no se puede ocultar.

Reglas:

  • Se aplica de inmediato a todos los usuarios de la empresa.
  • disabled_cash_reports reemplaza la lista completa (no agrega): para volver a mostrar todos envía []. Los repetidos se guardan una vez.
  • Ocultar un reporte solo lo quita del catálogo (Catálogo de reportes de caja); generarlo por su tipo sigue funcionando.

Errores:

  • 403 si el usuario no es administrador.
  • 422 {success: false, message: {campo: [errores]}} si falla la validación de campos. (valor no booleano, tipo de reporte no permitido o cash_close en disabled_cash_reports).
  • 422 si el cuerpo no trae ninguno de los campos.
  • 401 sin token o con un token inválido.

Cuerpo

Content-Type: application/json

{
  "available_cash_report_seller": true,
  "disabled_cash_reports": [
    "cash_products"
  ]
}

Respuestas

200 — Guardado

{
  "success": true,
  "data": {
    "destination_sale": true,
    "separate_cash_transactions": false,
    "order_cash_income": true,
    "available_cash_report_seller": true,
    "disabled_cash_reports": [
      "cash_products"
    ],
    "cash_report_types": [
      {
        "type": "cash_close",
        "label": "Cierre de caja",
        "toggleable": false,
        "enabled": true
      },
      {
        "type": "cash_movements",
        "label": "Libro de caja",
        "toggleable": true,
        "enabled": true
      },
      {
        "type": "cash_operations",
        "label": "Resumen de operaciones",
        "toggleable": true,
        "enabled": true
      },
      {
        "type": "cash_credit",
        "label": "Créditos y cobranzas",
        "toggleable": true,
        "enabled": true
      },
      {
        "type": "cash_products",
        "label": "Productos vendidos",
        "toggleable": true,
        "enabled": false
      }
    ]
  },
  "message": "Configuración actualizada"
}

422 — Tipo no permitido

{
  "success": false,
  "message": {
    "disabled_cash_reports.0": [
      "Tipo de reporte no válido. Valores permitidos: cash_movements, cash_operations, cash_credit, cash_products (el Cierre de caja no se puede ocultar)."
    ]
  }
}

403 — Usuario no administrador

{
  "success": false,
  "message": "Solo un administrador puede gestionar este recurso."
}

Pruébalo

Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.