Further reading
Data the API leaves out
The public API leaves out business-sensitive data on purpose: costs, margins, access codes, internal tax documents and staff payroll or personal data. Treat a field that is not in the response schema as not available.
The API description states the rule: business-sensitive fields are excluded by design from the public edge. A field missing from a response is therefore not a bug or a permissions problem, and a scope will not unlock it. The response schema of the version you call is the source of truth for what is published.
What is left out, and where
Link to this section: What is left out, and whereThe description of each resource says what it does not publish. These are the cases it names:
| Area | What is not published |
|---|---|
| Spaces | The holding costs of the space. |
| Repair tickets | The cost of the repair. The unitPrice is a sale price, not a cost. |
| Vehicles | The cost per kilometer and the fixed cost. |
| Staff | Contact, identity, payroll and platform access data, when reading and when writing. |
| Subrents | The supplier price. |
| Treasury | The bank account number. Reference an account by its identifier. |
| Services | The cost and the internal name of the service. |
| Credit notes | The signed tax document, the tax breakdown and the lines. |
| Incidents | The cost of the repair and the internal resolution note. |
| Purchase orders | The lines. The amounts are costs because the object is a purchase, so the expense cannot be attributed to a specific rental item. |
| Notes | Who wrote the note. |
Treat the list as the cases documented today, not as a complete inventory. If a field you need is not in the response schema, it is not available.
What to do if you need it
Link to this section: What to do if you need it- Use the app. The people on your team who have the permission see this data there.
- Do not derive costs from other fields. For example, a sale price is not a cost.
- If your integration needs a field that is not exposed, tell support what you are trying to do rather than which field you want; see the support page.
Fields are never removed within a major version, and new fields are added without notice, so your client must ignore properties it does not know. See versioning. For other things the API does not do, see capabilities and limits.
Related pages
Link to this section: Related pagesFurther reading
Capabilities and limits of v1
The API covers most day-to-day work on orders, contacts, items, invoices and the schedule, and leaves a short list of things to the app. Check it here before you design an integration around a feature.
Guides
Versioning and deprecation
Within v1 Filmo only adds things. Anything that could break your integration is announced first, either as a new major version or as a deprecation with at least six months before the sunset.
Was this page helpful?