BlueSuite

Add a maintenance task to a piece of company equipment — an oil change, an inspection, a repair to book. Use recurrence for scheduled servicing that repeats.

Create a new event. Three kinds: an APPOINTMENT is a visit for an existing job or request, a TASK is a to-do on the calendar, an EVENT is a standalone calendar entry. Recurrence (recurrence_type="recurring") applies to tasks and events only — appointments cannot repeat on their own. For repeating visits, put the job on a recurring schedule with setup_recurring_job, which also sets the job type and billing settings.

Record a unit installed at a customer's property. `property_id` is required — a unit is always installed somewhere. Leave `name` off and it is derived from make and model, then the equipment type. Setting warranty or replacement dates schedules reminders automatically.

Record work done on an installed unit — a service, a repair, an inspection result. This is the unit's history at that property and outlives any one job.

Schedule a one-off reminder about an installed unit. Do NOT create warranty or replacement reminders this way — those are generated and kept in step automatically from the unit's dates, so a hand-made one duplicates them. Use this for anything else, and note it can go to the customer, the team, or both.

Create a new invoice

Create a new job

Create a new expense for a job. Expenses track costs such as materials, subcontractor fees, permits, etc. Provide a receipt via `receipt` (a user-attached file from the chat) or `attachment` (a storage path from a prior upload_file call).

Create a brand-new lead in one call: contact + optional property + request, atomically linked. Use this for the common "new inquiry" happy path where all three records are new. For existing contacts, existing properties, or adding another request/property to an existing contact, use the per-entity tools instead (`create_contact`, `create_contact_property`, `create_request`). Property is optional — omit it if the inquiry has no specific service address; the request will be created without a property link. Returns the created contact_id, property_id (or null), request_id, plus the full created request for follow-up calls.

Record money already received against an invoice or quote. For "mark invoice paid", set object_type="invoice", category="payment", settle_remaining=true and omit amount. The server records only the outstanding balance, accounting for existing payments and deposits, and then updates the invoice status. Repeating settlement of an already covered balance creates no payment. For a specific partial payment, supply amount. Omitted method defaults to other. Supply created_at only when the user gives a payment date. This records a manual payment; it does not charge a card.

Create a new quote

Create a new draft quote from an existing quote template. The new quote inherits the template's line items, pricing, discounts, deposits, tax rate, message, and payment instructions. Requires the quotes:write scope.

Create a new quote template. Templates store line items, pricing, discounts, deposits, tax rates, and messages that can be reused when creating new quotes.

Create a new service request

Create a new saved product or service. Once created, it can be used as a line item on quotes, jobs, and invoices.

Create a recurring service plan customers can subscribe to. This defines the offer — price, how often it bills, how often visits happen — and bills nobody by itself. New plans start as drafts; publish with update_service_plan_status. Note billing cycle and visit frequency are independent: a plan can bill monthly and visit quarterly.

Create a new tag for one kind of record. Check `list_tags` first — tags are matched by ID, not name, so creating a second "Urgent" tag splits the records between them.

Create a new tax rate preset. Once created, it can be applied to quotes, jobs, and invoices.

Log time against a job, quote, request or service plan. Durations are in MINUTES — record two hours as 120, not 2. Defaults to the signed-in user; pass user_id to log time for a crew member.

Soft-delete a comment. The row is retained for audit but stops appearing in list responses. Cannot be undone via this API.

Delete a client. Their properties, follow-up tasks, notes and saved payment methods cascade away with them. Jobs, quotes and invoices remain but are left without a client. Confirm with the user first, especially when the client has live work — there is no undo.

Delete a property from a contact

Delete a follow-up task. To record that it was done rather than remove it, use complete_contact_task — deleting loses the history.

Delete a piece of company equipment, along with its tasks and service log. To take something out of service without losing its history, set status to "retired" or "sold" instead.

Delete an entry from a piece of equipment's service log.

Delete a maintenance task. To record that it was done, use complete_equipment_task instead — deleting loses the history.

Delete an event by ID

Delete an installed unit and its service history. To record that it was taken out or swapped, set status to 'removed' or 'replaced' instead — that keeps the history for the property.

Delete an entry from an installed unit's service history.

Delete a scheduled reminder on an installed unit.

Delete an invoice by ID

Delete a job and everything that hangs off it. Every appointment cascades away, including completed visits, along with expenses and change orders; invoices and time entries survive but lose their link to the job. For a recurring job this destroys the whole visit history — to stop repeating work use end_recurring_job_schedule, which keeps the past and only removes visits after a cutoff. Confirm with the user first; there is no undo.

Delete an expense from a job

Delete a payment. This will automatically recalculate the parent object status (e.g., invoice may revert from "paid" to "partially_paid" or "sent").

Delete a quote by ID

Delete a quote template by ID. Deleting a quote template will not affect existing quotes that use it.

Delete a service request by ID

Delete a product or service by ID

Delete a service plan. Archive it instead if anyone has ever subscribed — archiving stops new signups and keeps the history.

Delete a tag. This removes it from every record it is currently applied to.