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.
A new value would be a documented, additive change, so a client should tolerate a value it does not know. The statuses of credit notes and proformas are not closed lists at all: they are free text, so tolerate any value there. The tables below are the ones an integrator needs most; the generated table at the end lists every status enum. The app's own view of the order lifecycle is in Order lifecycle.
Order status (raw value) | List filter ?status= |
|---|---|
draft | draft |
reserved | reserved |
prepared_partiallyprepared | preparedIncludes partial preparation. |
picked_up | in_usePicked up or in use. |
returned_partiallyreturnedchecked_in_partially | returnedIncludes partial return and partial check-in. |
checked_in | completedChecked in and completed. |
cancelled | cancelled |
- The filter description places
picked_up_partiallyandarchivedin no bucket.archivedis one of the DTO's values, but an archived order can be neither listed nor read.
The status field of an order shows the raw status, one of 12 values. The status filter of GET /api uses operational buckets, the same view as the app. Do not send a raw value to the filter or expect a bucket in the field.
| Raw status (field) | Filter bucket |
|---|---|
draft | draft |
reserved | reserved |
prepared_partially, prepared | prepared (includes partial preparation) |
picked_up | in_use (delivered or in use) |
picked_up_partially | in_use. The spec's wording lists only picked up, so if you need exactly this status, read the orders and check the raw status yourself |
returned_partially, returned | returned (includes partial return) |
checked_in_partially | returned (includes partial check-in) |
checked_in | completed (checked in and completed) |
cancelled | cancelled |
archived | None. Filmo never produces this value: an archived order is no longer visible to the API, is not listed, and its GET answers 404 |
To filter by several buckets at once, use statuses, a list of up to 50 values that returns what matches any of them.
Invoices
Link to this section: InvoicesInvoice status
Document lifecycle
draft- A draft.
validated- Validated and numbered.
voided- Voided.
Invoice paymentStatus
Payment status; the same vocabulary as the ?paymentStatus= filter
unpaid- Nothing collected yet (also for invoices without a recorded collection).
partially_paid- Collected in part.
paid- Collected in full.
overpaid- Collected above the total.
overdue- Past due and unpaid.
voided- The document is voided.
Quote status
Lifecycle of the active version
draft- A draft.
validated- Validated and numbered.
Quote operativeStatus
Commercial status of the active version
pending- Awaiting an answer.
confirmed- Accepted.
cancelled- Rejected or cancelled.
superseded- Replaced by another version.
- The two statuses of each document are independent: one says where the document is in its lifecycle, the other how its payment or its commercial answer stands.
An invoice has two fields. status is the document lifecycle; paymentStatus is the payment state. The list filter paymentStatus uses the same values the paymentStatus field returns, and GET /api returns documents of type invoice only.
| Field | Value | Meaning |
|---|---|---|
status | draft | Not yet validated |
status | validated | Validated and numbered |
status | voided | Voided |
paymentStatus | unpaid | Nothing collected yet, also for invoices without a recorded collection |
paymentStatus | partially_paid | Part of the total collected |
paymentStatus | paid | Collected in full |
paymentStatus | overpaid | Collected above the total |
paymentStatus | overdue | Past due and unpaid |
paymentStatus | voided | The document is voided, whatever was collected before |
A quote also has two fields, and the detail flattens the active version of the quote. status is the document lifecycle of that version; operativeStatus is the commercial status, and PATCH /api changes it. Confirming a version leaves the others as superseded.
| Field | Value | Meaning |
|---|---|---|
status | draft | Not yet validated |
status | validated | Validated and numbered |
operativeStatus | pending | Awaiting a reply |
operativeStatus | confirmed | Accepted |
operativeStatus | cancelled | Rejected or cancelled |
operativeStatus | superseded | Replaced by another version |
All status enums
Link to this section: All status enumsThis table is generated from the spec and lists the status enums of every resource, including projects, tasks, contracts and the rest.
| Field | Values |
|---|---|
ContactDto. | active, inactive, archived |
ContactDetailDto. | active, inactive, archived |
RelatedContactDto. | active, inactive, archived |
OrderDto. | draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived, cancelled |
OrderDetailDto. | draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived, cancelled |
OrderLineDto. | draft, reserved, prepared, picked_up, sold, returned, checked_in, cancelled, lost |
InvoiceDto. | draft, validated, voided |
InvoiceDto. | unpaid, partially_paid, paid, overpaid, overdue, voided |
InvoiceDetailDto. | draft, validated, voided |
InvoiceDetailDto. | unpaid, partially_paid, paid, overpaid, overdue, voided |
QuoteDto. | draft, validated |
QuoteDto. | pending, confirmed, cancelled, superseded |
QuoteDetailDto. | draft, validated |
QuoteDetailDto. | pending, confirmed, cancelled, superseded |
ProjectDto. | draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived |
ProjectDetailDto. | draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived |
RepairTicketDto. | draft, sent, partially_converted, fully_invoiced, closed |
RepairTicketDetailDto. | draft, sent, partially_converted, fully_invoiced, closed |
VehicleDto. | active, maintenance, inactive |
SubrentDto. | pending, active, completed, cancelled |
PurchaseOrderDto. | draft, pending, completed, cancelled |
ContractDto. | draft, validated, voided |
ContractDto. | pending, signed, cancelled |
OpportunityDto. | open, won, lost |
OpportunityDetailDto. | open, won, lost |
TreasuryAccountDto. | active, needs_reauth, disconnected, archived |
CreditNoteDto. | draft, validated, voided |
OrderLineReturnResultDto. | returned, failed |
UserDto. | active, pending, inactive |
Related pages
Link to this section: Related pagesCore concepts
Data model
Orders connect a contact, an optional project and the equipment rented; documents, payments, planning and the catalog hang from them.
Guides
Filtering and sorting
Most lists accept
sortand thecreated*andupdated*time filters, many accept list-valued filters such asstatuses, and some acceptqfor free-text search. The examples use the orders list.Guides
Syncing data
Filmo v1 does not send webhooks, so you keep another system in step by polling: read what changed in half-open time windows, and run a separate sweep to find what was deleted. Do not follow the pagination cursor to decide what changed or what disappeared.
Was this page helpful?