Product) sirve para agrupar y categorizar tus cobros (deudas, suscripciones y ligas de pago). Su uso es completamente opcional: puedes cobrar sin asociar ningún producto.
Lo usas cuando quieres reportar tus cobros por línea de producto o servicio, por ejemplo “Plan Premium”, “Cuota mensual gimnasio” o “Internet 100MB”.
Llave natural: name
El name es la llave natural del producto y es único por organización. Crear un producto con un name que ya existe no genera un duplicado ni un error: devuelve el producto existente.
Por eso
POST /products es idempotente por diseño: repetir el mismo name siempre te devuelve el mismo producto. No necesitas verificar de antemano si ya existe.Crear un producto
El
productId es el identificador en el sistema, expuesto como string sin prefijo.Creación en línea (productName)
No necesitas crear el producto por adelantado. Puedes enviarlo en línea al crear una deuda, suscripción o liga de pago con el campo productName. Si el nombre no existe, se crea; si ya existe, se reutiliza sin duplicarlo.
createdInline es true si el producto se creó en esa misma petición, y false si ya existía y se reutilizó.
Activar y desactivar
boolean
predeterminado:"true"
Estado del producto. Un producto inactivo no puede asociarse a nuevos cobros.
DELETE /products/{id} hace un soft-delete: pone active: false sin eliminar el producto, de modo que el historial se conserva. Asociar un producto inactivo a un nuevo cobro devuelve 422 BUSINESS_RULE_VIOLATION.
Endpoints
Pruébalo en el API Reference
Explora cada endpoint con su playground interactivo.