F-Register
API documentation
Overview of the F-Register API, webhooks and integrations for external CRM, quotation and invoicing systems.
API / integrations
Secure connections with external systems.
The F-Register API is designed for integrations with systems such as Teamleader, accounting software, quotation tools and future partner integrations. External systems can send or retrieve data while F-Register remains the system of record for installations, work orders, reports, audit data and documents.
Principles
Integrations are enabled per customer and module from the monitor. Inactive modules do not expose API functionality.
Work orders, refrigerant transactions, reports and documents remain linked to the correct customer, site and installation.
Only necessary data is exchanged. Public logbook pages do not expose customer or technician data.
Main API events
| Event | Purpose | Example data |
|---|---|---|
| customer.created | Create a customer from an external CRM. | Name, email, phone, billing address, contact person. |
| location.created | Add a site under a customer. | Site name, address, postcode, city, contact details. |
| installation.created | Register a cooling installation, heat pump or combustion appliance. | Brand, type, serial number, site, module/domain. |
| work_order.completed | Make completed work orders available for invoicing. | Work order number, date, status, materials, hours, report link. |
| document.created | Attach a report or document to an external file. | Document type, installation, work order, file link, created date. |
Data format
The API uses JSON objects. Each payload contains at least an external reference, tenant, event name, timestamp and the relevant data group. External IDs are stored where possible, so updates land on the same customer, site, installation or work order.
Teamleader flow
- A deal is won in Teamleader.
- Teamleader sends customer and project data to F-Register through a webhook.
- F-Register creates the customer, site and draft installation or work order.
- After completion, F-Register sends work order data back for invoicing.
Security
API access should be protected per tenant and per module with tokens, scopes, logging and rate limiting. Integrations must fail safely: no half-imported data without logs and no customer data outside the correct environment.