Core concepts
Data model
Orders connect a contact, an optional project and the equipment rented; documents, payments, planning and the catalog hang from them.
Each resource has its own page in the REST API reference (43 object pages), with its fields and the operations that read and write it. Start from the REST API overview. The app side of the same model is described in Data model overview.
| Resource | References |
|---|---|
| contract | contact · order · projectcontactId · orderId · projectId |
| credit note | contact · invoicecontactId · invoiceId |
| document line | item · orderitemId · orderId |
| incident | item · serialized item · space · vehicle · order · projectitemId · serializedItemId · spaceId · vehicleId · orderId · projectId |
| internal service | projectprojectId |
| invoice | order · projectorderId · projectId |
| item | collectioncollectionId |
| kit | collectioncollectionId |
| opportunity | pipelinepipelineId |
| order | projectprojectId |
| order line | order · item · spaceorderId · itemId · spaceId |
| payment | treasury account · contacttreasuryAccountId · contactId |
| planner service | order · project · service · staff member · vehicle · taskorderId · projectId · serviceId · staffMemberId · vehicleId · taskId |
| proforma | order · projectorderId · projectId |
| project | project type · orderprojectTypeId · orderIds |
| purchase order | order · project · repair ticketorderId · projectId · repairTicketId |
| quote | order · projectorderId · projectId |
| repair ticket | order · contactorderId · contactId |
| serialized item | item · project · contactitemId · projectId · contactId |
| space | collectioncollectionId |
| staff member | collectioncollectionId |
| subrent | item · serialized item · order · project · purchase order · spaceitemId · serializedItemId · orderId · projectId · purchaseOrderId · spaceId |
| task | projectprojectId |
| user | staff memberstaffMemberId |
| vehicle | collectioncollectionId |
- Generated from the
…Idand…Idsfields of the contract's objects: each row lists which other resources an object points to and through which fields.
- A contact is a customer or a supplier. A project groups orders and work for a contact, and an order can belong to a project or stand alone.
- An order carries a contact, a rental period and lines. Lines belong to the order and are read with
GET /api; there is no independent collection of lines./v1 /orders /{orderId} /lines POST /apiand/v1 /projects /{projectId} /orders /{orderId} DELETE /apiattach an order to a project and detach it./v1 /projects /{projectId} /orders /{orderId} - The order lifecycle (reserve, unreserve, cancel, archive and return of line items) is a set of actions on the order. See Statuses.
Catalog and stock
Link to this section: Catalog and stock- An item is a catalog entry, with variants, accessories and alternatives. Each physical unit is a serialized item of an item.
- A kit is a named group of items that go out together.
- Collections are the tree the catalog is organized by: items, spaces, vehicles, staff and services hang from a collection.
- A space is a warehouse that manages stock or a rentable space, told apart by
isWarehouse. - Availability queries check items, staff and vehicles in a date range, and unavailabilities block a resource.
Documents and money
Link to this section: Documents and money- Quotes, proformas, contracts, invoices and credit notes are the documents. Their lifecycles are in Statuses.
- Treasury payments go through treasury accounts and are linked to documents with
POST /api./v1 /treasury /payments /{paymentId} /links - Purchase orders, supplier invoices and subrents are the buying side; a subrent can link to its purchase order.
People, fleet and planning
Link to this section: People, fleet and planning- Staff and vehicles are the resources of the company. Tasks, internal services and the planner use them.
- The planner shows the staff and fleet services to cover in a date range and the assignments that fill them.
GET /apiis a read-only projection of projects, orders, tasks, internal assignments and order services./v1 /schedule - Repair tickets and incidents track what broke and what is quoted for fixing it.
Sales and automation
Link to this section: Sales and automation- CRM opportunities move through the stages of a pipeline and can be linked to the quote, order or project that came out of them with
POST /api. They need the CRM add-on./v1 /crm /opportunities /{opportunityId} /links - Workflows are listed with
GET /api./v1 /workflows POST /apistarts a run, not a workflow: definitions are neither read nor written through the API./v1 /workflows /{workflowId} /runs
Related pages
Link to this section: Related pagesCore concepts
Records and ids
Every record has an opaque id that Filmo assigns. Keep your own ids in a mapping table on your side, and use a reference field only where the API has one.
Core concepts
Statuses
Most statuses are closed lists of text values. For orders, the field shows one of 12 raw statuses while the list filter uses seven broader buckets.
Introduction
REST API overview
The Filmo REST API v1 is a JSON API over HTTPS at
https://. You authenticate with an API key, and every response uses the same envelope.app. filmo. io /api /v1
Was this page helpful?