Modelo de datos

Cada recurso tiene su propia página en la referencia de la API REST (43 páginas de objeto), con sus campos y las operaciones que lo leen y lo escriben. Empieza por el Resumen de la API REST. La parte de la app del mismo modelo se describe en Resumen del modelo de datos.

• Un contacto es un cliente o un proveedor. Un proyecto agrupa pedidos y trabajo de un contacto, y un pedido puede pertenecer a un proyecto o ir por su cuenta.
• Un pedido lleva un contacto, un periodo de alquiler y líneas. Las líneas pertenecen al pedido y se leen con GET /api/v1/orders/{orderId}/lines; no existe una colección independiente de líneas.
• POST /api/v1/projects/{projectId}/orders/{orderId} y DELETE /api/v1/projects/{projectId}/orders/{orderId} asocian un pedido a un proyecto y lo desasocian.
• El ciclo de vida del pedido (reservar, anular la reserva, cancelar, archivar y devolver líneas) es un conjunto de acciones sobre el pedido. Consulta Estados.

• Un artículo es una entrada del catálogo, con variantes, accesorios y alternativas. Cada unidad física es una unidad serializada de un artículo.
• Un kit es un grupo con nombre de artículos que salen juntos.
• Las colecciones son el árbol con el que se organiza el catálogo: de una colección cuelgan artículos, espacios, vehículos, personal y servicios.
• Un espacio es un almacén que gestiona stock o un espacio alquilable, que se distinguen por isWarehouse.
• Las consultas de disponibilidad comprueban artículos, personal y vehículos en un rango de fechas, y las indisponibilidades bloquean un recurso.

• Los presupuestos, proformas, contratos, facturas y notas de crédito son los documentos. Sus ciclos de vida están en Estados.
• Los pagos de tesorería pasan por cuentas de tesorería y se vinculan a documentos con POST /api/v1/treasury/payments/{paymentId}/links.
• Las órdenes de compra, las facturas de proveedor y los subalquileres son el lado de las compras; un subalquiler puede enlazar con su orden de compra.

• El personal y los vehículos son los recursos de la empresa. Las tareas, los servicios internos y el planificador los usan.
• El planificador muestra los servicios de personal y de flota que hay que cubrir en un intervalo de fechas y las asignaciones que los cubren. GET /api/v1/schedule es una proyección de solo lectura de proyectos, pedidos, tareas, asignaciones internas y servicios de pedido.
• Los tickets de reparación y las incidencias registran qué se ha roto y cuánto se presupuesta para arreglarlo.

• Las oportunidades del CRM avanzan por las etapas de un embudo y se pueden vincular con el presupuesto, el pedido o el proyecto que salió de ellas con POST /api/v1/crm/opportunities/{opportunityId}/links. Necesitan el add-on de CRM.
• Los workflows se listan con GET /api/v1/workflows. POST /api/v1/workflows/{workflowId}/runs inicia una ejecución, no un workflow: las definiciones no se leen ni se escriben a través de la API.