Entity Nodes

Entity nodes represent the core data in your business — customers, bookings, payments, invoices, zones, and more. Each entity node can query, create, update, or display records from your database. There are 11 entity nodes in total.

All entity nodes share the same basic input/output pattern:

Inputs: data-in (optional filter or ID to look up a specific record)

Outputs: data-out (the entity record or list of records), error (if lookup failed)

Customer

Icon: User | ID Prefix: CUST

Work with customer records. Look up a customer by ID, query customers by criteria, or create new customer records.

Config:

Operation: Get (by ID), query (by filter), create, or update
Filters: Name, email, phone, zone, status
Fields: Which customer fields to include in the output

Example: Look up the customer associated with a booking and pass their email to a downstream Email node.

Booking

Icon: Calendar | ID Prefix: BOOK

Work with booking and appointment records. Look up bookings, filter by date range or status, or create new bookings.

Config:

Operation: Get, query, create, or update
Filters: Customer, date range, status, service type, zone
Fields: Which booking fields to include

Example: Query all bookings for tomorrow and send each customer a reminder SMS.

Payment

Icon: CreditCard | ID Prefix: PAY

Work with payment transaction records. Look up payments, filter by amount or status, or record new payments.

Config:

Operation: Get, query, create, or update
Filters: Customer, booking, amount range, status, date range
Fields: Which payment fields to include

Example: After a booking is completed, query the payment status and send a receipt if paid.

Invoice

Icon: FileText | ID Prefix: INV

Work with invoice records. Generate invoices, look up outstanding balances, or update invoice status.

Config:

Operation: Get, query, create, or update
Filters: Customer, status (draft, sent, paid, overdue), date range, amount
Fields: Which invoice fields to include

Example: Query all overdue invoices and send a reminder email to each customer.

Zone

Icon: MapPin | ID Prefix: ZONE

Work with service zones and geographic areas. Look up which zone an address falls in, or query zone details.

Config:

Operation: Get, query, or lookup (find zone by coordinates)
Filters: Name, status, zip codes
Fields: Which zone fields to include

Example: Look up the service zone for a new booking address to determine pricing and availability.

Laborer

Icon: HardHat | ID Prefix: LABR

Work with labor and contractor records. Look up workers by skill, availability, tier, or zone.

Config:

Operation: Get, query, or match (find best match for a job)
Filters: Skills, zone, tier, availability, status
Fields: Which laborer fields to include

Example: Find all available laborers in a zone who have the skills needed for a specific service type.

Vendor

Icon: Building2 | ID Prefix: VNDR

Work with vendor and supplier records. Look up vendors by category, location, or rating.

Config:

Operation: Get or query
Filters: Category, location, rating, status
Fields: Which vendor fields to include

Example: Query all active vendors who supply cleaning equipment in the northeast zone.

Asset

Icon: Package | ID Prefix: ASST

Work with company asset records — equipment, vehicles, tools, and other physical property.

Config:

Operation: Get, query, create, or update
Filters: Type, status, location, assigned-to
Fields: Which asset fields to include

Example: Before assigning a crew to a job, check that the required equipment assets are available.

Staff

Icon: UserCog | ID Prefix: STAF

Work with staff and employee records. Look up staff members by role, department, or status.

Config:

Operation: Get or query
Filters: Role, department, status
Fields: Which staff fields to include

Example: Find the manager responsible for a specific zone to send them a daily summary report.

Role

Icon: Shield | ID Prefix: ROLE

Work with permission roles. Look up what permissions a role has, or check if a user has a specific capability.

Config:

Operation: Get or query
Filters: Role name, permission
Fields: Which role fields to include

Example: Check if the current user's role has the "billing.approve" permission before processing a refund.

Checklist Instance

Icon: ClipboardCheck

Create a running checklist instance from a checklist template. The instance tracks completion of each item.

Config:

Operation: Create (from template), get, or update
Template: Which checklist template to use
Assignee: Who is responsible for completing the checklist

Example: When a new job is dispatched, create a pre-job checklist instance assigned to the field crew.