Scopes

The scopes of the contract. Each one has an anchor, so you can link to it.

Read the account that made the request: its name, timezone, currency, country, add-ons, the API key with its scopes, and the usage limits. GET /api/v1/account is the first call of any integration, so this scope is the one to grant first.

• GET /api/v1/account — Get the account

Ask the Filmo assistant a question about the account's data in natural language. It never writes, but each call spends AI credits of the account, and it can search the web.

• POST /api/v1/ai/ask — Ask the AI about your data

Check item availability in a date range, and read the unavailabilities of a person, a vehicle or a space.

• POST /api/v1/availability/check — Check item availability
• GET /api/v1/availability/unavailabilities — List the unavailabilities of a resource

Declare, correct, close and delete unavailabilities of a person, a vehicle or a space. Deleting an unavailability cannot be undone.

• POST /api/v1/availability/unavailabilities — Declare an unavailability
• PATCH /api/v1/availability/unavailabilities/{unavailabilityId} — Correct or close an unavailability
• DELETE /api/v1/availability/unavailabilities/{unavailabilityId} — Delete an unavailability

Read the collections tree that the catalog is organized by.

• GET /api/v1/collections — List collections

Create and rename collections, and move them within the tree.

• POST /api/v1/collections — Create a collection
• PATCH /api/v1/collections/{collectionId} — Update a collection

Read contacts (customers and suppliers), their addresses and related contacts, and look contacts up by contact number.

• GET /api/v1/contacts — List contacts
• GET /api/v1/contacts/{contactId} — Get a contact
• GET /api/v1/contacts/{contactId}/related-contacts — List the contacts related to a contact
• POST /api/v1/contacts/lookup — Look up contacts by external reference

Create, change and delete contacts, their addresses, commercial terms and related-contact links. Deleting a contact also deletes its relationships, notes, files, tasks, payment methods and customer portal access, and cannot be undone. Removing an address cannot be undone either.

• POST /api/v1/contacts — Create a contact
• PATCH /api/v1/contacts/{contactId} — Update a contact
• DELETE /api/v1/contacts/{contactId} — Delete a contact
• PATCH /api/v1/contacts/{contactId}/preferences — Update the commercial terms of a contact
• POST /api/v1/contacts/{contactId}/addresses — Add an address to a contact
• PATCH /api/v1/contacts/{contactId}/addresses/{addressId} — Update an address of a contact
• DELETE /api/v1/contacts/{contactId}/addresses/{addressId} — Remove an address from a contact
• POST /api/v1/contacts/{contactId}/related-contacts — Relate two contacts
• PATCH /api/v1/contacts/{contactId}/related-contacts/{relatedContactId} — Change the role of a relationship
• DELETE /api/v1/contacts/{contactId}/related-contacts/{relatedContactId} — Unrelate two contacts

Read rental contracts with their document and signature status.

• GET /api/v1/contracts — List contracts
• GET /api/v1/contracts/{contractId} — Get a contract

Validate, sign, void and cancel rental contracts. Validating a contract numbers it and locks it. Voiding removes its validity. Cancelling a contract is terminal: a cancelled contract can no longer be signed. An already signed contract can only be undone by voiding the document.

• POST /api/v1/contracts/{contractId}/validate — Validate a contract
• POST /api/v1/contracts/{contractId}/sign — Record the signature of a contract
• POST /api/v1/contracts/{contractId}/void — Void a contract
• POST /api/v1/contracts/{contractId}/cancel — Cancel a contract operatively

Read CRM opportunities and the pipelines they move through.

• GET /api/v1/crm/opportunities — List opportunities
• GET /api/v1/crm/opportunities/{opportunityId} — Get an opportunity
• GET /api/v1/crm/pipelines — List pipelines
• GET /api/v1/crm/pipelines/{pipelineId} — Get a pipeline

Create and change opportunities, move them between stages, close them and link documents to them.

• POST /api/v1/crm/opportunities — Create an opportunity
• PATCH /api/v1/crm/opportunities/{opportunityId} — Update an opportunity
• PATCH /api/v1/crm/opportunities/{opportunityId}/stage — Move an opportunity to another stage
• POST /api/v1/crm/opportunities/{opportunityId}/close — Close an opportunity
• POST /api/v1/crm/opportunities/{opportunityId}/links — Link a document to an opportunity

Read the definitions of the account's custom fields (identifier, type and accepted values), not the values stored on records.

• GET /api/v1/custom-fields — List custom field definitions

Read incidents (broken, lost or damaged equipment) and the count of incidents by status.

• GET /api/v1/incidents — List incidents
• GET /api/v1/incidents/{incidentId} — Get an incident
• GET /api/v1/incidents/status-counts — Count incidents by status

Open and update incidents, and comment on them.

• POST /api/v1/incidents — Open an incident
• PATCH /api/v1/incidents/{incidentId} — Update an incident
• POST /api/v1/incidents/{incidentId}/comments — Comment on an incident

Read internal services, the planned assignments that do not hang from an order.

• GET /api/v1/internal-services — List internal services
• GET /api/v1/internal-services/{internalServiceId} — Get an internal service

Create and change internal services.

• POST /api/v1/internal-services — Create an internal service
• PATCH /api/v1/internal-services/{internalServiceId} — Update an internal service

Read invoices (with their lines), credit notes and proformas (totals and status; their lines are not published).

• GET /api/v1/invoices — List invoices
• GET /api/v1/invoices/{invoiceId} — Get an invoice
• GET /api/v1/invoices/{invoiceId}/lines — List the lines of an invoice
• GET /api/v1/credit-notes — List credit notes
• GET /api/v1/credit-notes/{creditNoteId} — Get a credit note
• GET /api/v1/proformas — List proformas
• GET /api/v1/proformas/{proformaId} — Get a proforma

Validate and void invoices and credit notes, change the commercial status of proformas, and create or update the mirror of an invoice issued by another system. Validating an invoice or a credit note numbers it, signs it and locks it, and neither can be edited afterwards; voiding keeps the number and cannot be undone. Voiding an invoice does not issue a credit note.

• POST /api/v1/invoices/{invoiceId}/validate — Validate an invoice
• POST /api/v1/invoices/{invoiceId}/void — Void an invoice
• PUT /api/v1/invoices/external/{originSystem}/{originExternalId} — Create or update the mirror of an externally issued invoice
• POST /api/v1/credit-notes/{creditNoteId}/validate — Validate a credit note
• POST /api/v1/credit-notes/{creditNoteId}/void — Void a credit note
• PATCH /api/v1/proformas/{proformaId}/status — Change the commercial status of a proforma

Read catalog items and their serialized units.

• GET /api/v1/items — List items
• GET /api/v1/items/{itemId} — Get an item
• GET /api/v1/serialized-items — List serialized items
• GET /api/v1/serialized-items/{serializedItemId} — Get a serialized item

Create, change and delete items, including their pricing, physical properties, accessories, alternatives and variants, and update serialized units. Deleting an item also deletes its serialized units, notes, files and tasks, and cannot be undone.

• POST /api/v1/items — Create an item
• PATCH /api/v1/items/{itemId} — Update an item
• DELETE /api/v1/items/{itemId} — Delete an item
• PATCH /api/v1/items/{itemId}/physical-properties — Update weight and dimensions
• PATCH /api/v1/items/{itemId}/pricing — Update the pricing of an item
• PATCH /api/v1/serialized-items/{serializedItemId} — Update a serialized item
• PUT /api/v1/items/{itemId}/accessories — Update the accessories of an item
• PUT /api/v1/items/{itemId}/alternatives — Update the alternatives of an item
• PATCH /api/v1/items/{itemId}/variants/{variantId} — Update a variant of an item

Read kits, the named groups of items that go out together.

• GET /api/v1/kits — List kits
• GET /api/v1/kits/{kitId} — Get a kit

Create and change kits.

• POST /api/v1/kits — Create a kit
• PATCH /api/v1/kits/{kitId} — Update a kit

Read the notes attached to an entity of the account.

• GET /api/v1/notes — List the notes of an entity

Write notes on entities of the account.

• POST /api/v1/notes — Write a note on an entity

Read rental orders and their lines.

• GET /api/v1/orders — List orders
• GET /api/v1/orders/{orderId} — Get an order
• GET /api/v1/orders/{orderId}/lines — List the lines of an order

Create and change orders, and run actions on them (reserve, unreserve, cancel, archive, return line items). Cancelling an order cannot be undone through the API. Returning line items puts material back into stock, so a retry without the same Idempotency-Key returns it twice. Send your own key. Reserving deducts stock and creates the delivery and return tasks.

• POST /api/v1/orders — Create an order
• PATCH /api/v1/orders/{orderId} — Update the header of an order
• POST /api/v1/orders/{orderId}/cancel — Cancel an order
• PUT /api/v1/orders/{orderId}/archive — Archive or restore an order
• POST /api/v1/orders/line-items/returns — Return order lines
• POST /api/v1/orders/{orderId}/reserve — Reserve an order
• POST /api/v1/orders/{orderId}/unreserve — Unreserve an order

Read the staff and fleet services of a date window, with who covers them, and the resources that can be assigned.

• GET /api/v1/planner/services — List the services to cover
• GET /api/v1/planner/resources — List the assignable resources

Assign resources to planner services and remove them.

• POST /api/v1/planner/assignments — Assign a resource to a service
• POST /api/v1/planner/assignments/remove — Remove a resource from a service

Read projects and the catalog of project types.

• GET /api/v1/projects — List projects
• GET /api/v1/projects/{projectId} — Get a project
• GET /api/v1/project-types — List project types

Create, change and archive projects, and link or unlink orders to them.

• POST /api/v1/projects — Create a project
• PUT /api/v1/projects/{projectId}/archive — Archive or restore a project
• PATCH /api/v1/projects/{projectId} — Update a project
• POST /api/v1/projects/{projectId}/orders/{orderId} — Link an order to a project
• DELETE /api/v1/projects/{projectId}/orders/{orderId} — Unlink an order from a project

Read purchase orders to suppliers.

• GET /api/v1/purchase-orders — List purchase orders
• GET /api/v1/purchase-orders/{purchaseOrderId} — Get a purchase order

Change, approve and receive purchase orders. Receiving a purchase order registers new inventory, so a retry without the same Idempotency-Key duplicates the stock. Send your own key.

• PATCH /api/v1/purchase-orders/{purchaseOrderId} — Update a purchase order
• POST /api/v1/purchase-orders/{purchaseOrderId}/approve — Approve a purchase order
• POST /api/v1/purchase-orders/{purchaseOrderId}/receive — Receive material from a purchase order

Read quotes (active version) and their lines.

• GET /api/v1/quotes — List quotes
• GET /api/v1/quotes/{quoteId} — Get a quote
• GET /api/v1/quotes/{quoteId}/lines — List the lines of a quote

Change the commercial status of quotes. Confirming a version of a quote moves every other version of it to superseded.

• PATCH /api/v1/quotes/{quoteId}/status — Change the commercial status of a quote

Read repair tickets.

• GET /api/v1/repair-tickets — List repair tickets
• GET /api/v1/repair-tickets/{ticketId} — Get a repair ticket

Create and change repair tickets, including their lines. Sending lines when updating a ticket replaces the whole set of lines: send all of them or none.

• POST /api/v1/repair-tickets — Create a repair ticket
• PATCH /api/v1/repair-tickets/{ticketId} — Update a repair ticket

Read the consolidated schedule of a date range: projects, orders, tasks, internal services and order services.

• GET /api/v1/schedule — Get the schedule for a range

Read services, the sellable lines that do not come from inventory.

• GET /api/v1/services — List services
• GET /api/v1/services/{serviceId} — Get a service

Create and change services, pricing included.

• POST /api/v1/services — Create a service
• PATCH /api/v1/services/{serviceId} — Update a service

Read warehouses and rentable spaces.

• GET /api/v1/spaces — List warehouses and spaces
• GET /api/v1/spaces/{spaceId} — Get a warehouse or space

Change and delete spaces, and replace their amenities and equipment and set their pricing. Deleting a space also deletes its notes, files, tasks, images and declared unavailabilities, and cannot be undone.

• PATCH /api/v1/spaces/{spaceId} — Update a warehouse or space
• DELETE /api/v1/spaces/{spaceId} — Delete a space
• PUT /api/v1/spaces/{spaceId}/amenities — Replace the amenities and equipment
• PATCH /api/v1/spaces/{spaceId}/pricing — Update the pricing of a space

Read staff members and check staff availability in a date range.

• GET /api/v1/staff — List staff
• GET /api/v1/staff/{staffId} — Get a staff member
• POST /api/v1/staff/availability — Check staff availability

Create, change and delete staff members (organizational data only). Deleting a staff member cannot be undone.

• POST /api/v1/staff — Create a staff member
• PATCH /api/v1/staff/{staffId} — Update a staff member
• DELETE /api/v1/staff/{staffId} — Delete a staff member

Read subrents, the equipment rented from other companies to cover a job.

• GET /api/v1/subrents — List subrents
• GET /api/v1/subrents/{subrentId} — Get a subrent

Change subrents.

• PATCH /api/v1/subrents/{subrentId} — Update a subrent

Read invoices received from suppliers.

• GET /api/v1/supplier-invoices — List supplier invoices
• GET /api/v1/supplier-invoices/{supplierInvoiceId} — Get a supplier invoice

Validate and void invoices received from suppliers. Validating a supplier invoice numbers it and locks it, and voiding keeps its number. Both need the purchases add-on.

• POST /api/v1/supplier-invoices/{supplierInvoiceId}/validate — Validate a supplier invoice
• POST /api/v1/supplier-invoices/{supplierInvoiceId}/void — Void a supplier invoice

Read the tag vocabulary of the account.

• GET /api/v1/tags — List tags

Create and delete tags, and assign or remove them on entities. Deleting a tag removes it from every entity that carried it, and cannot be undone.

• POST /api/v1/tags — Create a tag
• DELETE /api/v1/tags/{tagId} — Delete a tag
• POST /api/v1/tags/{tagId}/assignments — Assign a tag to an entity
• DELETE /api/v1/tags/{tagId}/assignments — Remove a tag from an entity

Read tasks, schedule events and task types.

• GET /api/v1/tasks — List tasks
• GET /api/v1/tasks/{taskId} — Get a task
• GET /api/v1/task-types — List task types

Create, change and delete tasks. Deleting a task cannot be undone.

• POST /api/v1/tasks — Create a task
• PATCH /api/v1/tasks/{taskId} — Update a task
• DELETE /api/v1/tasks/{taskId} — Delete a task

Read treasury accounts, payments and payment methods, and the payments of an invoice.

• GET /api/v1/invoices/{invoiceId}/payments — List the payments of an invoice
• GET /api/v1/treasury/accounts — List treasury accounts
• GET /api/v1/treasury/accounts/{accountId} — Get a treasury account
• GET /api/v1/treasury/payments — List treasury payments
• GET /api/v1/treasury/payments/{paymentId} — Get a payment
• GET /api/v1/payment-methods — List payment methods

Record, change and link payments. Recording a payment writes to your accounts: a retry without the same Idempotency-Key records it twice. Send your own key.

• POST /api/v1/treasury/payments — Record an incoming or outgoing payment
• PATCH /api/v1/treasury/payments/{paymentId} — Update a payment
• POST /api/v1/treasury/payments/{paymentId}/links — Link a payment to a document

Read the people with access to the account, with their role and access status. Only administrators can call it.

• GET /api/v1/users — List users

Read fleet vehicles and check fleet availability in a date range.

• GET /api/v1/vehicles — List vehicles
• GET /api/v1/vehicles/{vehicleId} — Get a vehicle
• POST /api/v1/vehicles/availability — Check fleet availability

Create, change and delete vehicles. Deleting a vehicle cannot be undone.

• POST /api/v1/vehicles — Create a vehicle
• PATCH /api/v1/vehicles/{vehicleId} — Update a vehicle
• DELETE /api/v1/vehicles/{vehicleId} — Delete a vehicle

List the workflows of the account and whether each one is active. Definitions are not published.

• GET /api/v1/workflows — List workflows

Start a run of a workflow, as the Run button does in the app. The run executes in the background and does whatever the workflow's steps say, so it can change data in Filmo and may have effects outside Filmo. This is the broadest permission in the contract: a run does whatever the workflow's steps say. Grant it only to integrations that need to start workflows, and send your own Idempotency-Key.

• POST /api/v1/workflows/{workflowId}/runs — Run a workflow