Permisos (scopes)

Los permisos del contrato. Cada uno tiene un ancla para enlazarlo.

Leer la cuenta que hizo la petición: su nombre, zona horaria, moneda, país, add-ons, la clave de API con sus permisos (scopes) y los límites de uso. GET /api/v1/account es la primera llamada de cualquier integración, así que este es el permiso (scope) que hay que conceder primero.

• GET /api/v1/account — Obtener la cuenta

Hacer una pregunta al asistente de Filmo sobre los datos de la cuenta en lenguaje natural. Nunca escribe, pero cada llamada gasta créditos de IA de la cuenta, y puede buscar en la web.

• POST /api/v1/ai/ask — Preguntar a la IA sobre tus datos

Consultar la disponibilidad de artículos en un rango de fechas, y leer las indisponibilidades de una persona, un vehículo o un espacio.

• POST /api/v1/availability/check — Comprobar la disponibilidad de artículos
• GET /api/v1/availability/unavailabilities — Listar las indisponibilidades de un recurso

Declarar, corregir, cerrar y eliminar indisponibilidades de una persona, un vehículo o un espacio. Eliminar una indisponibilidad no se puede deshacer.

• POST /api/v1/availability/unavailabilities — Declarar una indisponibilidad
• PATCH /api/v1/availability/unavailabilities/{unavailabilityId} — Corregir o cerrar una indisponibilidad
• DELETE /api/v1/availability/unavailabilities/{unavailabilityId} — Eliminar una indisponibilidad

Leer el árbol de colecciones con el que se organiza el catálogo.

• GET /api/v1/collections — Listar colecciones

Crear y renombrar colecciones, y moverlas dentro del árbol.

• POST /api/v1/collections — Crear una colección
• PATCH /api/v1/collections/{collectionId} — Actualizar una colección

Leer contactos (clientes y proveedores), sus direcciones y contactos relacionados, y buscar contactos por número de contacto.

• GET /api/v1/contacts — Listar contactos
• GET /api/v1/contacts/{contactId} — Obtener un contacto
• GET /api/v1/contacts/{contactId}/related-contacts — Listar los contactos relacionados con un contacto
• POST /api/v1/contacts/lookup — Buscar contactos por referencia externa

Crear, modificar y eliminar contactos, sus direcciones, condiciones comerciales y vínculos con contactos relacionados. Eliminar un contacto elimina también sus relaciones, notas, archivos, tareas, métodos de pago y acceso al portal de clientes, y no se puede deshacer. Quitar una dirección tampoco se puede deshacer.

• POST /api/v1/contacts — Crear un contacto
• PATCH /api/v1/contacts/{contactId} — Actualizar un contacto
• DELETE /api/v1/contacts/{contactId} — Eliminar un contacto
• PATCH /api/v1/contacts/{contactId}/preferences — Actualizar las condiciones comerciales de un contacto
• POST /api/v1/contacts/{contactId}/addresses — Añadir una dirección a un contacto
• PATCH /api/v1/contacts/{contactId}/addresses/{addressId} — Actualizar una dirección de un contacto
• DELETE /api/v1/contacts/{contactId}/addresses/{addressId} — Quitar una dirección de un contacto
• POST /api/v1/contacts/{contactId}/related-contacts — Relacionar dos contactos
• PATCH /api/v1/contacts/{contactId}/related-contacts/{relatedContactId} — Cambiar el rol de una relación
• DELETE /api/v1/contacts/{contactId}/related-contacts/{relatedContactId} — Quitar la relación entre dos contactos

Leer contratos de alquiler con el estado de su documento y de su firma.

• GET /api/v1/contracts — Listar contratos
• GET /api/v1/contracts/{contractId} — Obtener un contrato

Validar, firmar, anular y cancelar contratos de alquiler. Validar un contrato le asigna número y lo bloquea. Anularlo le quita la validez. Cancelar un contrato es terminal: un contrato cancelado ya no se puede firmar. Un contrato ya firmado solo se puede deshacer anulando el documento.

• POST /api/v1/contracts/{contractId}/validate — Validar un contrato
• POST /api/v1/contracts/{contractId}/sign — Registrar la firma de un contrato
• POST /api/v1/contracts/{contractId}/void — Anular un contrato
• POST /api/v1/contracts/{contractId}/cancel — Cancelar un contrato a efectos operativos

Leer oportunidades del CRM y los embudos por los que avanzan.

• GET /api/v1/crm/opportunities — Listar oportunidades
• GET /api/v1/crm/opportunities/{opportunityId} — Obtener una oportunidad
• GET /api/v1/crm/pipelines — Listar embudos
• GET /api/v1/crm/pipelines/{pipelineId} — Obtener un embudo

Crear y modificar oportunidades, moverlas entre etapas, cerrarlas y vincularles documentos.

• POST /api/v1/crm/opportunities — Crear una oportunidad
• PATCH /api/v1/crm/opportunities/{opportunityId} — Actualizar una oportunidad
• PATCH /api/v1/crm/opportunities/{opportunityId}/stage — Mover una oportunidad a otra etapa
• POST /api/v1/crm/opportunities/{opportunityId}/close — Cerrar una oportunidad
• POST /api/v1/crm/opportunities/{opportunityId}/links — Vincular un documento a una oportunidad

Leer las definiciones de los campos personalizados de la cuenta (identificador, tipo y valores aceptados), no los valores guardados en los registros.

• GET /api/v1/custom-fields — Listar definiciones de campos personalizados

Leer incidencias (material roto, perdido o dañado) y el recuento de incidencias por estado.

• GET /api/v1/incidents — Listar incidencias
• GET /api/v1/incidents/{incidentId} — Obtener una incidencia
• GET /api/v1/incidents/status-counts — Contar incidencias por estado

Abrir y actualizar incidencias, y comentarlas.

• POST /api/v1/incidents — Abrir una incidencia
• PATCH /api/v1/incidents/{incidentId} — Actualizar una incidencia
• POST /api/v1/incidents/{incidentId}/comments — Comentar una incidencia

Leer servicios internos, las asignaciones planificadas que no cuelgan de un pedido.

• GET /api/v1/internal-services — Listar servicios internos
• GET /api/v1/internal-services/{internalServiceId} — Obtener un servicio interno

Crear y modificar servicios internos.

• POST /api/v1/internal-services — Crear un servicio interno
• PATCH /api/v1/internal-services/{internalServiceId} — Actualizar un servicio interno

Lee facturas (con sus líneas), notas de crédito y proformas (totales y estado; sus líneas no se publican).

• GET /api/v1/invoices — Listar facturas
• GET /api/v1/invoices/{invoiceId} — Obtener una factura
• GET /api/v1/invoices/{invoiceId}/lines — Listar las líneas de una factura
• GET /api/v1/credit-notes — Listar notas de crédito
• GET /api/v1/credit-notes/{creditNoteId} — Obtener una nota de crédito
• GET /api/v1/proformas — Listar proformas
• GET /api/v1/proformas/{proformaId} — Obtener una proforma

Validar y anular facturas y notas de crédito, cambiar el estado comercial de las proformas y crear o actualizar el espejo de una factura emitida por otro sistema. Validar una factura o una nota de crédito le asigna número, la firma y la bloquea, y después ninguna de las dos se puede editar; anularla conserva el número y no se puede deshacer. Anular una factura no emite una nota de crédito.

• POST /api/v1/invoices/{invoiceId}/validate — Validar una factura
• POST /api/v1/invoices/{invoiceId}/void — Anular una factura
• PUT /api/v1/invoices/external/{originSystem}/{originExternalId} — Crear o actualizar el espejo de una factura emitida externamente
• POST /api/v1/credit-notes/{creditNoteId}/validate — Validar una nota de crédito
• POST /api/v1/credit-notes/{creditNoteId}/void — Anular una nota de crédito
• PATCH /api/v1/proformas/{proformaId}/status — Cambiar el estado comercial de una proforma

Leer artículos del catálogo y sus unidades serializadas.

• GET /api/v1/items — Listar artículos
• GET /api/v1/items/{itemId} — Obtener un artículo
• GET /api/v1/serialized-items — Listar unidades serializadas
• GET /api/v1/serialized-items/{serializedItemId} — Obtener una unidad serializada

Crear, modificar y eliminar artículos, incluidos sus precios, propiedades físicas, accesorios, alternativas y variantes, y actualizar unidades serializadas. Eliminar un artículo elimina también sus unidades serializadas, notas, archivos y tareas, y no se puede deshacer.

• POST /api/v1/items — Crear un artículo
• PATCH /api/v1/items/{itemId} — Actualizar un artículo
• DELETE /api/v1/items/{itemId} — Eliminar un artículo
• PATCH /api/v1/items/{itemId}/physical-properties — Actualizar peso y dimensiones
• PATCH /api/v1/items/{itemId}/pricing — Actualizar los precios de un artículo
• PATCH /api/v1/serialized-items/{serializedItemId} — Actualizar una unidad serializada
• PUT /api/v1/items/{itemId}/accessories — Actualizar los accesorios de un artículo
• PUT /api/v1/items/{itemId}/alternatives — Actualizar las alternativas de un artículo
• PATCH /api/v1/items/{itemId}/variants/{variantId} — Actualizar una variante de un artículo

Leer kits, los grupos con nombre de artículos que salen juntos.

• GET /api/v1/kits — Listar kits
• GET /api/v1/kits/{kitId} — Obtener un kit

Crear y modificar kits.

• POST /api/v1/kits — Crear un kit
• PATCH /api/v1/kits/{kitId} — Actualizar un kit

Leer las notas adjuntas a una entidad de la cuenta.

• GET /api/v1/notes — Listar las notas de una entidad

Escribir notas en entidades de la cuenta.

• POST /api/v1/notes — Escribe una nota en una entidad

Leer pedidos de alquiler y sus líneas.

• GET /api/v1/orders — Listar pedidos
• GET /api/v1/orders/{orderId} — Obtener un pedido
• GET /api/v1/orders/{orderId}/lines — Listar las líneas de un pedido

Crear y modificar pedidos, y ejecutar acciones sobre ellos (reservar, anular la reserva, cancelar, archivar, devolver líneas). Cancelar un pedido no se puede deshacer desde la API. Devolver líneas devuelve el material al stock, así que un reintento sin la misma Idempotency-Key lo devuelve dos veces. Envía tu propia clave. Reservar descuenta stock y crea las tareas de entrega y devolución.

• POST /api/v1/orders — Crear un pedido
• PATCH /api/v1/orders/{orderId} — Actualizar la cabecera de un pedido
• POST /api/v1/orders/{orderId}/cancel — Cancelar un pedido
• PUT /api/v1/orders/{orderId}/archive — Archivar o restaurar un pedido
• POST /api/v1/orders/line-items/returns — Devolver líneas de pedido
• POST /api/v1/orders/{orderId}/reserve — Reservar un pedido
• POST /api/v1/orders/{orderId}/unreserve — Anula la reserva de un pedido

Leer los servicios de personal y de flota de una ventana de fechas, con quién los cubre, y los recursos que se pueden asignar.

• GET /api/v1/planner/services — Listar los servicios por cubrir
• GET /api/v1/planner/resources — Listar los recursos asignables

Asignar recursos a los servicios del planificador y quitarlos.

• POST /api/v1/planner/assignments — Asignar un recurso a un servicio
• POST /api/v1/planner/assignments/remove — Quitar un recurso de un servicio

Leer proyectos y el catálogo de tipos de proyecto.

• GET /api/v1/projects — Listar proyectos
• GET /api/v1/projects/{projectId} — Obtener un proyecto
• GET /api/v1/project-types — Listar tipos de proyecto

Crear, modificar y archivar proyectos, y vincularles pedidos o desvincularlos.

• POST /api/v1/projects — Crear un proyecto
• PUT /api/v1/projects/{projectId}/archive — Archivar o restaurar un proyecto
• PATCH /api/v1/projects/{projectId} — Actualizar un proyecto
• POST /api/v1/projects/{projectId}/orders/{orderId} — Vincular un pedido a un proyecto
• DELETE /api/v1/projects/{projectId}/orders/{orderId} — Desvincular un pedido de un proyecto

Leer órdenes de compra a proveedores.

• GET /api/v1/purchase-orders — Listar pedidos de compra
• GET /api/v1/purchase-orders/{purchaseOrderId} — Obtener una orden de compra

Modificar, aprobar y recepcionar órdenes de compra. Recepcionar una orden de compra registra inventario nuevo, así que un reintento sin el mismo Idempotency-Key duplica el stock. Envía tu propia clave.

• PATCH /api/v1/purchase-orders/{purchaseOrderId} — Actualizar una orden de compra
• POST /api/v1/purchase-orders/{purchaseOrderId}/approve — Aprobar un pedido de compra
• POST /api/v1/purchase-orders/{purchaseOrderId}/receive — Recibir material de un pedido de compra

Leer presupuestos (versión activa) y sus líneas.

• GET /api/v1/quotes — Listar presupuestos
• GET /api/v1/quotes/{quoteId} — Obtener un presupuesto
• GET /api/v1/quotes/{quoteId}/lines — Listar las líneas de un presupuesto

Modificar el estado comercial de los presupuestos. Confirmar una versión de un presupuesto pasa todas las demás versiones a superseded.

• PATCH /api/v1/quotes/{quoteId}/status — Cambiar el estado comercial de un presupuesto

Leer tickets de reparación.

• GET /api/v1/repair-tickets — Listar tickets de reparación
• GET /api/v1/repair-tickets/{ticketId} — Obtener un ticket de reparación

Crear y modificar tickets de reparación, incluidas sus líneas. Enviar lines al actualizar un ticket sustituye todo el conjunto de líneas: envíalas todas o ninguna.

• POST /api/v1/repair-tickets — Crear un parte de reparación
• PATCH /api/v1/repair-tickets/{ticketId} — Actualizar un ticket de reparación

Leer la agenda consolidada de un rango de fechas: proyectos, pedidos, tareas, servicios internos y servicios de pedido.

• GET /api/v1/schedule — Obtener la agenda de un rango

Leer servicios, las líneas vendibles que no proceden del inventario.

• GET /api/v1/services — Listar servicios
• GET /api/v1/services/{serviceId} — Obtener un servicio

Crear y modificar servicios, incluidos los precios.

• POST /api/v1/services — Crear un servicio
• PATCH /api/v1/services/{serviceId} — Actualizar un servicio

Leer almacenes y espacios alquilables.

• GET /api/v1/spaces — Listar almacenes y espacios
• GET /api/v1/spaces/{spaceId} — Obtener un almacén o espacio

Modificar y eliminar espacios, y reemplazar sus servicios y equipamiento y establecer su precio. Eliminar un espacio elimina también sus notas, archivos, tareas, imágenes e indisponibilidades declaradas, y no se puede deshacer.

• PATCH /api/v1/spaces/{spaceId} — Actualizar un almacén o espacio
• DELETE /api/v1/spaces/{spaceId} — Eliminar un espacio
• PUT /api/v1/spaces/{spaceId}/amenities — Reemplazar las comodidades y el equipamiento
• PATCH /api/v1/spaces/{spaceId}/pricing — Actualizar los precios de un espacio

Leer miembros del personal y comprobar la disponibilidad del personal en un rango de fechas.

• GET /api/v1/staff — Listar personal
• GET /api/v1/staff/{staffId} — Obtener un miembro del personal
• POST /api/v1/staff/availability — Comprobar la disponibilidad del personal

Crear, modificar y eliminar miembros del personal (solo datos de organización). Eliminar a un miembro del personal no se puede deshacer.

• POST /api/v1/staff — Crear un miembro del personal
• PATCH /api/v1/staff/{staffId} — Actualizar un miembro del personal
• DELETE /api/v1/staff/{staffId} — Eliminar un miembro del personal

Leer subalquileres, el material alquilado a otras empresas para cubrir un trabajo.

• GET /api/v1/subrents — Listar subalquileres
• GET /api/v1/subrents/{subrentId} — Obtener un subalquiler

Modificar subalquileres.

• PATCH /api/v1/subrents/{subrentId} — Actualizar un subalquiler

Leer facturas recibidas de proveedores.

• GET /api/v1/supplier-invoices — Listar facturas de proveedor
• GET /api/v1/supplier-invoices/{supplierInvoiceId} — Obtener una factura de proveedor

Validar y anular facturas recibidas de proveedores. Validar una factura de proveedor le asigna número y la bloquea, y anularla conserva su número. Ambas acciones requieren el add-on de compras.

• POST /api/v1/supplier-invoices/{supplierInvoiceId}/validate — Validar una factura de proveedor
• POST /api/v1/supplier-invoices/{supplierInvoiceId}/void — Anular una factura de proveedor

Leer el vocabulario de etiquetas de la cuenta.

• GET /api/v1/tags — Listar etiquetas

Crear y eliminar etiquetas, y asignarlas o quitarlas en entidades. Eliminar una etiqueta la quita de todas las entidades que la tenían, y no se puede deshacer.

• POST /api/v1/tags — Crear una etiqueta
• DELETE /api/v1/tags/{tagId} — Eliminar una etiqueta
• POST /api/v1/tags/{tagId}/assignments — Asignar una etiqueta a una entidad
• DELETE /api/v1/tags/{tagId}/assignments — Quitar una etiqueta de una entidad

Leer tareas, eventos de la agenda y tipos de tarea.

• GET /api/v1/tasks — Listar tareas
• GET /api/v1/tasks/{taskId} — Obtener una tarea
• GET /api/v1/task-types — Listar tipos de tarea

Crear, modificar y eliminar tareas. Eliminar una tarea no se puede deshacer.

• POST /api/v1/tasks — Crear una tarea
• PATCH /api/v1/tasks/{taskId} — Actualizar una tarea
• DELETE /api/v1/tasks/{taskId} — Eliminar una tarea

Leer cuentas de tesorería, pagos y métodos de pago, y los pagos de una factura.

• GET /api/v1/invoices/{invoiceId}/payments — Listar los pagos de una factura
• GET /api/v1/treasury/accounts — Listar cuentas de tesorería
• GET /api/v1/treasury/accounts/{accountId} — Obtener una cuenta de tesorería
• GET /api/v1/treasury/payments — Listar pagos de tesorería
• GET /api/v1/treasury/payments/{paymentId} — Obtener un pago
• GET /api/v1/payment-methods — Listar métodos de pago

Registrar, modificar y vincular pagos. Registrar un pago escribe en tus cuentas: un reintento sin el mismo Idempotency-Key lo registra dos veces. Envía tu propia clave.

• POST /api/v1/treasury/payments — Registrar un pago entrante o saliente
• PATCH /api/v1/treasury/payments/{paymentId} — Actualizar un pago
• POST /api/v1/treasury/payments/{paymentId}/links — Vincular un pago a un documento

Leer las personas con acceso a la cuenta, con su rol y estado de acceso. Solo los administradores pueden llamarla.

• GET /api/v1/users — Listar usuarios

Leer vehículos de la flota y comprobar la disponibilidad de la flota en un rango de fechas.

• GET /api/v1/vehicles — Listar vehículos
• GET /api/v1/vehicles/{vehicleId} — Obtener un vehículo
• POST /api/v1/vehicles/availability — Comprobar la disponibilidad de la flota

Crear, modificar y eliminar vehículos. Eliminar un vehículo no se puede deshacer.

• POST /api/v1/vehicles — Crear un vehículo
• PATCH /api/v1/vehicles/{vehicleId} — Actualizar un vehículo
• DELETE /api/v1/vehicles/{vehicleId} — Eliminar un vehículo

Listar los workflows de la cuenta y si cada uno está activo. Las definiciones no se publican.

• GET /api/v1/workflows — Listar workflows

Iniciar una ejecución de un workflow, como hace el botón Ejecutar de la app. La ejecución se realiza en segundo plano y hace lo que digan los pasos del workflow, así que puede cambiar datos en Filmo y tener efectos fuera de Filmo. Este es el permiso más amplio del contrato: una ejecución hace lo que digan los pasos del workflow. Concédelo solo a las integraciones que necesiten iniciar workflows y envía tu propio Idempotency-Key.

• POST /api/v1/workflows/{workflowId}/runs — Ejecutar un workflow