Documentation
Service VIN developer & AI platformGetting startedAuthenticationPaginationIdempotencyRate limitsErrorsWebhooks & signature verificationConnecting ClaudeRecipesMCP servers & the Claude connectorREST resource referenceCapability indexCustomers capabilitiesVehicles capabilitiesLeads capabilitiesWarranties capabilitiesQuotes capabilitiesInvoices capabilitiesPayments capabilitiesServices capabilitiesJobs capabilitiesCalendar capabilitiesScheduling capabilitiesStaff capabilitiesInventory capabilitiesComms capabilitiesTasks capabilitiesShop capabilitiesDocuments capabilitiesKnowledge capabilitiesReports capabilitiesBooking capabilitiesForms capabilitiesMarketing capabilitiesReviews capabilitiesAutomations capabilitiesIntegrations capabilitiesChangelogSearch
Domain
Reports capabilities
12 capabilities, all acting on a report. A reference to one from another domain is spelled
report_id — never a bare id — and every one of those fields names the capability that produces it, so a model can chain calls without guessing.| Capability | What it does | Effect |
|---|---|---|
| reports.revenuePOST /api/v1/reports/revenue | Read the revenue, profit and margin report for a period | read-only |
| reports.by_servicePOST /api/v1/reports/by_service | Break a period's revenue and margin report down by service | read-only |
| reports.funnelsPOST /api/v1/reports/funnels | Read the lead and quote conversion report for a period | read-only |
| reports.marketingPOST /api/v1/reports/marketing | Read the report of what each lead source cost and returned | read-only |
| reports.installPOST /api/v1/reports/install | Read the installer and film-usage report for a period | read-only |
| reports.job_plPOST /api/v1/reports/job_pl | Read the per-job profit-and-loss report for completed work | read-only |
| reports.slaPOST /api/v1/reports/sla | Read the first-response speed report for the shop's leads | read-only |
| reports.taxPOST /api/v1/reports/tax | Read the sales-tax report of what was charged and collected | read-only |
| reports.dashboardPOST /api/v1/reports/dashboard | Read today's dashboard report — money in, and who is waiting | read-only |
| reports.metricsPOST /api/v1/reports/metrics | Read the whole business report card, metric by metric | read-only |
| reports.insightsPOST /api/v1/reports/insights | List the advisor's report on what to fix in this business | read-only |
| reports.recovered_revenuePOST /api/v1/reports/recovered_revenue | Read the report on money the AI front desk won back | read-only |