API reference

The workspace a credential acts in, its plan, how it pays for it, usage and AI credits, the connection an assistant holds, the people, keys and apps with access, and resetting a sandbox to its demo data.

• GET/v1/business
• POST/v1/business/item-presets
• GET/v1/business/item-presets
• POST/v1/business/item-presets/{key}/archive
• POST/v1/business/item-presets/{key}/restore

and 26 more

The people and companies you bill. Contact details come back masked unless the credential holds contacts:read.

• GET/v1/clients
• POST/v1/clients
• GET/v1/clients/find
• GET/v1/clients/{clientId}
• PATCH/v1/clients/{clientId}

and 2 more

Drafts, lines, deposits, progress billing and reminders. Every write here produces or edits a draft; sending is an action, approved by a person or the owner’s capped rule.

• GET/v1/invoices
• POST/v1/invoices
• GET/v1/invoices/{invoiceId}
• PATCH/v1/invoices/{invoiceId}
• POST/v1/jobs/{jobId}/invoices

and 48 more

Quotes before the work, converted into an invoice once the client accepts.

• GET/v1/estimates
• POST/v1/estimates
• GET/v1/estimates/{estimateId}
• PATCH/v1/estimates/{estimateId}
• POST/v1/estimates/{estimateId}/convert

and 1 more

What was paid, how, and what is still owed. Recording and refunding are API-key scopes or approved actions, never a connected assistant on its own.

• GET/v1/payments
• GET/v1/payments/{paymentId}
• GET/v1/payment-links
• GET/v1/payment-links/{linkId}
• GET/v1/payment-links/{linkId}/summary

and 13 more

Schedules that raise invoices on their own, the reminder cadence, and what the scheduled jobs will do next.

• GET/v1/recurring
• GET/v1/recurring/{recurringId}
• PATCH/v1/recurring/{recurringId}
• POST/v1/recurring/{recurringId}/pause
• GET/v1/automation/upcoming

and 2 more

Work logged during the month, billed onto an invoice exactly once, and paper read from a photo or PDF into a draft a person files. A CSV of clients, items or open invoices can be dry-run here; a person runs the import in the console.

• GET/v1/time-entries
• POST/v1/time-entries
• GET/v1/expenses
• POST/v1/expenses
• GET/v1/mileage

and 20 more

The other side of the ledger: vendors, the bills they send, and what has been paid against them.

• GET/v1/recurring-bills
• POST/v1/recurring-bills
• GET/v1/recurring-bills/{recurringBillId}
• POST/v1/recurring-bills/{recurringBillId}/pause
• GET/v1/bills

and 14 more

Ageing, income, tax, settlement and reconciliation, computed from stored amounts, plus the accounting export.

• GET/v1/reports/ar-ageing
• GET/v1/reports/ap-ageing
• GET/v1/reports/income
• GET/v1/reports/tax-categories
• GET/v1/tax-categories

and 15 more

How an invoice and its pay page look. Drafts only; publishing is an approved action.

• GET/v1/templates
• POST/v1/templates
• GET/v1/templates/{templateId}
• PATCH/v1/templates/{templateId}
• GET/v1/templates/{templateId}/preview

and 6 more

The delivery log of every email and text, the audit trail of who did what, and your own notifications and their settings.

• GET/v1/messages
• GET/v1/sms/threads
• GET/v1/sms/threads/{threadId}
• GET/v1/activity
• GET/v1/activity/export

and 3 more

Anything that sends, moves money or changes the workspace is proposed here and waits for a signed-in person, or for the owner’s capped rule.

• GET/v1/actions
• POST/v1/actions
• GET/v1/actions/{actionId}
• POST/v1/actions/sendInvoice
• POST/v1/actions/sendEstimate

and 104 more

Endpoints BillingMart signs and posts events to, and the log of every attempt.

• GET/v1/admin/webhook-endpoints
• GET/v1/admin/webhook-deliveries
• GET/v1/webhooks
• POST/v1/webhooks
• PATCH/v1/webhooks/{endpointId}

and 4 more

How a business sets up its work records: its terminology, the record types it can use, the industry packs it can adopt and the setup questions a pack asks. A record type is saved here as a draft; publishing it is an approved action.

• GET/v1/work-config
• GET/v1/industry-packs
• GET/v1/business-types/{key}/setup-questions
• GET/v1/job-types
• POST/v1/job-types

and 5 more