The API contract, asset specification, permissions and data shapes behind Roof Vision.
This page is the technical contract behind Roof Vision. It is written for integrators and AI agents that need to operate or reason about the feature precisely. Contract version: 1.You don’t need this page to use Roof Vision. It is technical detail for integrators and AI tools. To learn Roof Vision, read Use Roof Vision.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ArcSolar Docs","description":"Learn ArcSolar. Work with customers, create quotes and take the installation through to handover.","colors":{"primary":"#626A78","light":"#626A78","dark":"#A5ACBA"},"logo":{"light":"https://mintcdn.com/arc-solar/rORb2_IX6bMXscj_/images/ArcSolar-Wordmark.png?fit=max\u0026auto=format\u0026n=rORb2_IX6bMXscj_\u0026q=85\u0026s=a203a91291a1cc71ffa5d984b4ec26e6","dark":"https://mintcdn.com/arc-solar/rORb2_IX6bMXscj_/images/ArcSolar-Wordmark-1.png?fit=max\u0026auto=format\u0026n=rORb2_IX6bMXscj_\u0026q=85\u0026s=8b9742ffa9e05ad4f5fba3ff72ba0754","href":"/"},"favicon":{"light":"https://mintcdn.com/arc-solar/0LEGQt3LamqO6mxa/images/ArgonixConnectIcon.svg?fit=max\u0026auto=format\u0026n=0LEGQt3LamqO6mxa\u0026q=85\u0026s=644a2b9c94c3276205720c5bf497425c","dark":"https://mintcdn.com/arc-solar/0LEGQt3LamqO6mxa/images/arcsolar-icon.svg?fit=max\u0026auto=format\u0026n=0LEGQt3LamqO6mxa\u0026q=85\u0026s=6204c472628beb3005ffe005b59ed0d9"},"appearance":{"default":"dark","strict":false},"background":{"color":{"light":"#FFFFFF","dark":"#08090A"}},"navbar":{"links":[],"primary":{"type":"button","label":"Open app","href":"https://app.arcsolar.com.au"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/argonix-digital","website":"https://www.argonix.net"},"links":[{"header":"ArcSolar support","items":[{"label":"support@arcsolar.com.au","href":"mailto:support@arcsolar.com.au"}]}]},"search":{"prompt":"Search ArcSolar docs…"},"seo":{"metatags":{"og:locale":"en_AU"},"organization":{"id":"https://www.arcsolar.com.au/#organization","name":"ArcSolar","legalName":"Argonix Digital","url":"https://www.arcsolar.com.au","sameAs":["https://www.linkedin.com/company/argonix-digital"]},"indexing":"navigable"},"fonts":{"family":"Inter"},"integrations":{"telemetry":{"enabled":true}},"contextual":{"options":["copy","view","chatgpt"],"display":"header"},"thumbnails":{"background":"https://mintcdn.com/arc-solar/8ukhjNGSSGIv64v4/images/og-background.jpg?fit=max\u0026auto=format\u0026n=8ukhjNGSSGIv64v4\u0026q=85\u0026s=e4774bad6e88edbbca90d0d6b1dfd4e0","fonts":{"family":"Inter"}},"markdown":{"instructions":["## What this documentation covers","This is the documentation for ArcSolar, the solar-retailer operating system: the web app a solar retailer uses to run quoting, sales, installation, rebates, inventory and reporting. ArcSolar is a hosted web application at https://app.arcsolar.com.au. There is no public API for most workflows, so agentic operation of ArcSolar is UI-driven. Navigate the app, read the labels and controls, and act through the interface, unless a page explicitly documents an API, contract or integration endpoint.","","## How to read these pages","- Pages are split by audience using Mintlify's Visibility component, and this split is deliberate. Sections marked 'for agents' are hidden on the website and appear only in the Markdown you are reading. They are the authoritative behavioural specification for the page. Where the remaining human-facing prose and an agent section disagree, the agent section is correct.","- Sections outside any Visibility block appear in both outputs. They are the shared spine of the page: what the feature is and why it matters.","- Treat every bold label, field name, route, status string and error message quoted in an agent section as canonical. They are copied verbatim from the product. Use that exact wording when telling a user where to click, or when matching an error message to its cause.","- Australian solar vocabulary is used precisely and not interchangeably: STC (Small-scale Technology Certificate), PRC (Peak Reduction Certificate), REPS, NMI, CEC accreditation, VPP. Do not substitute an overseas equivalent.","- Money is Australian dollars. Dates shown to users are day-first (DD/MM/YYYY).","","## Behaviour rules for operating or advising on ArcSolar","- Respect prerequisites and ordering. Agent sections state which inputs block progress and which steps must happen first. Do not skip a step, and do not assume a default that the product itself does not supply.","- Never invent a value the product requires but the user has not supplied. Ask for mandatory fields rather than guessing. Several features reject a request outright when one is missing, and submissions to external authorities are effectively irreversible.","- Respect permissions and scoping. Features name the roles, capabilities and access rules that may act. Do not attempt an action the operator's role cannot perform, and do not describe a restricted feature as available to them.","- Features that are gated, pending release, or blocked on a vendor are documented as exactly that. Never present a gated or unmerged behaviour as live. When availability is unclear for a given workspace, direct the user to support rather than asserting that the feature works.","- Where a page states something is genuinely undetermined, treat it as unknown. Do not fill the gap with a plausible guess.","- ArcSolar's supported intelligence tools appear where they help with the task, including bill analysis, call summaries and reporting. Check the underlying evidence. Intelligence does not replace provider approval, verified records or the customer's own confirmation.","","## Getting help","Support is support@arcsolar.com.au. The customer-facing website is https://www.arcsolar.com.au."]},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"},{"anchor":"Get support","icon":"comment","href":"mailto:support@arcsolar.com.au"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"arc-solar","hasAudioNarration":false,"actualSubdomain":"arc-solar","customDomains":["docs.arcsolar.com.au"],"gitSource":{"type":"github","owner":"argonix-digital","repo":"arcsolar-documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"issues":false,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6afef2c45735af7f41cfb2ba","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Documentation","count":91},{"language":"default","tag":"Workspace setup","count":16},{"language":"default","tag":"Projects and delivery","count":12},{"language":"default","tag":"Quoting","count":11},{"language":"default","tag":"Customers and conversations","count":10},{"language":"default","tag":"Help and reference","count":8},{"language":"default","tag":"Sales onboarding","count":8},{"language":"default","tag":"Integrations","count":7},{"language":"default","tag":"Reporting","count":7},{"language":"default","tag":"Getting started","count":5}],"searchSettings":{"showContentSnippets":true,"isFiltersEnabled":true,"maxResults":8}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@argonix.net"}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":":root{--docs-canvas:#fff;--docs-surface:#fafafa;--docs-panel:#fff;--docs-ink:#282a30;--docs-body:#3c4149;--docs-muted:#6f6e77;--docs-line:#e9e8ea;--docs-stage:#f0f1f4;--docs-wash:#e5e9f2;--docs-accent:#65718b}.dark{--docs-canvas:#08090a;--docs-surface:#141516;--docs-panel:#0f1011;--docs-ink:#f7f8f8;--docs-body:#d0d6e0;--docs-muted:#8a8f98;--docs-line:#23252a;--docs-stage:#101318;--docs-wash:#242d42;--docs-accent:#a0abc2}html{scroll-behavior:smooth;scroll-padding-top:100px}body{font-feature-settings:'cv01' 1,'ss03' 1;-webkit-font-smoothing:antialiased;background:var(--docs-canvas)}#navbar,#sidebar,#sidebar-content{background:var(--docs-canvas)}#navbar{border-color:var(--docs-line)}#topbar-cta-button>a{padding:8px 16px;border-radius:999px}#topbar-cta-button>a>span{background:#e5e5e6;border-radius:inherit;opacity:1}#topbar-cta-button>a>div,#topbar-cta-button>a>div>span{color:#08090a}#topbar-cta-button svg{display:none}#sidebar{border-right:1px solid var(--docs-line)}#sidebar a{font-size:14px;font-weight:400}#sidebar a[aria-current=\"page\"]{color:var(--docs-ink);font-weight:500}#header #page-title,#page-title{font-size:32px;font-weight:590;line-height:36px;letter-spacing:-.022em;color:var(--docs-ink)}#header{margin-bottom:32px}#header>div:last-child{color:var(--docs-muted)}.prose{--tw-prose-body:var(--docs-body);--tw-prose-headings:var(--docs-ink);font-size:15px;line-height:24px;letter-spacing:-.011em}.prose h2{margin-top:56px;margin-bottom:12px;font-size:24px;line-height:31.92px;letter-spacing:-.012em;font-weight:590}.prose h3{font-size:20px;line-height:32px;letter-spacing:0;font-weight:590}.prose p{margin-top:12px;margin-bottom:12px}.prose li{margin-top:8px;margin-bottom:8px}.prose strong{font-weight:550}.prose table{font-size:14px;line-height:1.6}.prose th{font-weight:500}#table-of-contents{font-size:13px}a:focus-visible,button:focus-visible,summary:focus-visible{outline:2px solid var(--docs-accent);outline-offset:4px}.docs-home{max-width:1080px;margin:0 auto;padding:8px 0 20px}.docs-home h2{font-size:20px;margin:48px 0 22px;font-weight:500;letter-spacing:-.02em}.docs-home-intro{max-width:650px;color:var(--docs-muted);font-size:18px;line-height:1.65}.docs-topic-grid{display:grid;grid-template-columns:repeat(3,minmax(0,1fr));gap:16px}.docs-topic{--docs-card-border:var(--docs-line);display:flex;flex-direction:column;color:var(--docs-ink)!important;text-decoration:none!important;background:var(--docs-surface);border:0!important;padding:1px;box-shadow:inset 0 0 0 1px var(--docs-card-border)!important;font-weight:400;border-radius:8px;overflow:hidden;transition:background .15s,box-shadow .15s}.docs-topic:hover{--docs-card-border:var(--docs-muted);background:var(--docs-stage)}.docs-topic-art{min-height:142px;display:flex;align-items:flex-start;padding:24px;color:var(--docs-ink)}.docs-topic-copy{border-top:1px solid var(--docs-line);padding:20px 24px 24px;flex:1}.docs-topic-copy h3{margin:0!important;font-size:15px!important;font-weight:510;line-height:24px;letter-spacing:-.011em}.docs-topic-copy p{margin:4px 0 0!important;font-size:14px;font-weight:400;line-height:21px;letter-spacing:-.013em;color:var(--docs-muted)}.docs-home-links{display:grid;grid-template-columns:repeat(2,minmax(0,1fr));gap:0 32px}.docs-home-links a{display:flex;align-items:center;gap:12px;padding:17px 0;border-bottom:1px solid var(--docs-line);text-decoration:none!important;font-size:15px;color:var(--docs-ink)}.docs-home-links a svg:last-child{margin-left:auto;color:var(--docs-muted)}.docs-home-support{margin-top:44px;color:var(--docs-muted);font-size:14px}.docs-next{display:flex;justify-content:space-between;align-items:center;gap:24px;padding:22px 24px;margin-top:42px;border:1px solid var(--docs-line)!important;box-shadow:none!important;border-radius:8px;text-decoration:none!important;color:var(--docs-ink)!important}.docs-next>span{display:flex;flex-direction:column;gap:4px}.docs-next-label{color:var(--docs-muted);font-size:12px}.docs-next strong{font-size:16px;font-weight:500}.docs-next>span>span:last-child:not(.docs-next-label){color:var(--docs-muted);font-size:14px}.docs-next:hover{background:var(--docs-surface)}.docs-figure{margin:30px 0 38px!important}.docs-backdrop{background:radial-gradient(ellipse at 92% 8%,var(--docs-wash),transparent 65%),var(--docs-stage);padding:36px 32px 0;border-radius:12px;overflow:hidden;border:1px solid var(--docs-line)}.product-preview{background:var(--docs-panel);border:1px solid var(--docs-line);border-bottom:0;border-radius:9px 9px 0 0;box-shadow:0 12px 50px #0000000a;color:var(--docs-ink);font-family:Inter,system-ui,sans-serif;font-size:13px;line-height:1.5;overflow:hidden;text-align:left}.product-preview *{box-sizing:border-box}.product-preview p{font-size:13px;line-height:1.6;margin:8px 0 14px!important}.product-preview h3{font-size:21px!important;margin:8px 0 10px!important;font-weight:500!important;letter-spacing:-.025em}.product-preview strong{font-weight:500}.product-preview small{display:block;font-size:11px;line-height:1.6;color:var(--docs-muted)}.preview-toolbar{padding:16px 20px;display:flex;gap:12px;align-items:center;justify-content:space-between;border-bottom:1px solid var(--docs-line);font-weight:500}.preview-toolbar>span:last-child:not(:first-child){font-size:11px;font-weight:400;color:var(--docs-muted)}.preview-control{display:inline-flex;align-items:center;justify-content:center;padding:5px 9px;border:1px solid var(--docs-line);border-radius:5px;color:var(--docs-ink);font-size:11px;white-space:nowrap}.preview-tabs{display:flex;gap:22px;padding:0 20px;border-bottom:1px solid var(--docs-line);color:var(--docs-muted);font-size:11px;overflow:auto}.preview-tabs>span{white-space:nowrap;padding:12px 0}.preview-tabs .selected{color:var(--docs-ink);border-bottom:1px solid var(--docs-ink)}.preview-row{display:flex;gap:12px;align-items:center;justify-content:space-between;padding:15px 20px;border-bottom:1px solid var(--docs-line)}.preview-row strong{font-size:12px}.preview-row small{margin-top:3px}.preview-pill{display:inline-flex;align-items:center;font-size:10px;border:1px solid var(--docs-line);border-radius:5px;padding:3px 7px;color:var(--docs-muted);white-space:nowrap;background:var(--docs-surface)}.preview-pill.success{color:#39805c}.dark .preview-pill.success{color:#8cc8a2}.preview-table-head{display:flex;justify-content:space-between;font-size:10px;color:var(--docs-muted);padding:10px 20px;border-bottom:1px solid var(--docs-line)}.preview-note{display:flex;align-items:center;gap:9px;padding:16px 20px;font-size:11px;color:var(--docs-muted);line-height:1.6}.preview-note>.preview-control{margin-left:auto}.preview-document{padding:26px 28px 20px}.preview-field{display:flex;justify-content:space-between;gap:16px;padding:11px 0;border-bottom:1px solid var(--docs-line);font-size:12px}.preview-field>span{color:var(--docs-muted)}.preview-stats{display:grid;grid-template-columns:repeat(3,1fr);padding:24px 20px;gap:12px;border-bottom:1px solid var(--docs-line)}.preview-stats strong{font-size:25px;display:block;margin-top:8px;letter-spacing:-.04em}.preview-section-label{padding:16px 20px 0}.preview-board{display:grid;grid-template-columns:repeat(3,1fr);gap:12px;padding:22px 18px 32px}.preview-column-title{display:flex;justify-content:space-between;font-size:11px;color:var(--docs-muted)}.preview-kanban{border:1px solid var(--docs-line);border-radius:6px;padding:14px 12px;margin-top:14px}.preview-kanban strong{font-size:12px}.preview-kanban p{font-size:11px}.preview-messages{display:flex;flex-direction:column;align-items:flex-start;padding:28px 24px 32px;gap:16px}.preview-messages p{background:var(--docs-surface);border:1px solid var(--docs-line);padding:12px 16px;border-radius:10px 10px 10px 2px;max-width:80%;margin:0!important;font-size:12px}.preview-messages p:last-child{align-self:flex-end;border-radius:10px 10px 2px 10px}.preview-message-input{display:flex;justify-content:space-between;align-items:center;color:var(--docs-muted);margin:0 20px 24px;padding:12px;border:1px solid var(--docs-line);border-radius:7px;font-size:11px}.preview-split{display:grid;grid-template-columns:1fr 1fr;padding:24px;gap:24px}.preview-paper{padding:18px;background:var(--docs-surface);border:1px solid var(--docs-line);border-radius:5px}.preview-paper small{font-size:9px}.preview-paper h3{font-size:17px!important}.preview-paper-lines{margin:18px 0 22px}.preview-paper-lines i{display:block;height:3px;margin:8px 0;width:90%;background:var(--docs-line)}.preview-paper-lines i:last-child{width:55%}.preview-assessment{padding-top:8px}.preview-assessment p{font-size:11px;color:var(--docs-muted)}.preview-integration-grid{display:grid;grid-template-columns:1fr 1fr;gap:12px;padding:22px}.preview-integration-grid>div{border:1px solid var(--docs-line);border-radius:7px;padding:18px}.preview-integration-grid strong{display:block;margin:12px 0 3px;font-size:13px}.preview-calendar{display:grid;grid-template-columns:repeat(5,1fr);padding:0 14px;min-height:210px}.preview-calendar>div{padding:14px 8px;border-right:1px solid var(--docs-line)}.preview-calendar>div:last-child{border:0}.preview-calendar p{padding:10px 8px;margin-top:34px!important;background:var(--docs-surface);border:1px solid var(--docs-line);border-radius:5px;font-size:10px}.preview-comparison{display:grid;grid-template-columns:1fr 1fr;gap:0}.preview-comparison>div{padding:24px;border-right:1px solid var(--docs-line)}.preview-comparison>div:last-child{border:0}.preview-comparison .preview-price{display:block;font-size:28px;margin:20px 0;letter-spacing:-.035em}.docs-figure figcaption{font-size:11px!important;line-height:1.6!important;text-align:left;margin:10px 2px 0!important;color:var(--docs-muted)}.docs-roof-figure{padding:24px;background:var(--docs-stage);border:1px solid var(--docs-line);border-radius:12px;margin:28px 0}.docs-roof-figure img{border-radius:7px;margin:0!important;width:100%}.docs-roof-figure figcaption{color:var(--docs-muted);font-size:12px;margin-top:12px}@media (min-width:1280px){#content-area{max-width:900px}}@media (max-width:767px){#page-title{font-size:32px!important}.docs-topic-grid{grid-template-columns:repeat(2,minmax(0,1fr))}.docs-topic-art{min-height:74px;padding:20px}.docs-topic-copy{padding:16px 20px 20px}.docs-backdrop{padding:24px 16px 0}.docs-home-links{gap:0 20px}}@media (max-width:480px){.docs-topic-grid{grid-template-columns:1fr;gap:12px}.docs-topic{flex-direction:row;align-items:stretch}.docs-topic-art{padding:22px 18px;min-height:0;align-items:flex-start}.docs-topic-copy{border-top:0;padding:18px 16px 18px 0}.docs-home-links{grid-template-columns:1fr}.docs-backdrop{padding:18px 10px 0;border-radius:9px}.product-preview{font-size:12px}.preview-toolbar{padding:13px 12px;flex-wrap:wrap}.preview-row{padding:13px 12px;gap:8px}.preview-row strong{font-size:11px}.preview-pill{font-size:9px;padding:3px 5px}.preview-tabs{gap:16px;padding:0 12px}.preview-document{padding:22px 18px 16px}.preview-board{grid-template-columns:1fr;gap:18px}.preview-kanban{margin-top:7px}.preview-split{grid-template-columns:1fr;padding:18px;gap:16px}.preview-stats{padding:20px 12px;gap:6px}.preview-stats strong{font-size:22px}.preview-note{padding:14px 12px}.preview-integration-grid{padding:16px;gap:8px}.preview-integration-grid>div{padding:14px}.preview-calendar{grid-template-columns:repeat(3,1fr)}.preview-calendar>div:nth-child(n+4){display:none}.preview-comparison{grid-template-columns:1fr}.preview-comparison>div{border-right:0;border-bottom:1px solid var(--docs-line)}.docs-next{padding:18px}}@media (prefers-reduced-motion:reduce){html{scroll-behavior:auto}*{transition:none!important;animation:none!important}}#navigation-items>div>.sidebar-group-header{display:none}#sidebar .nav-anchor>div{background:transparent;box-shadow:none;border:0}#sidebar a[aria-current=\"page\"]{background:var(--docs-surface);border-radius:6px;text-shadow:none}#sidebar .sidebar-group-header{font-weight:500}.docs-roof-crop{position:relative;aspect-ratio:1.60;overflow:hidden}.docs-roof-crop img{position:absolute;width:151.16%;max-width:none!important;height:auto;left:-15.12%;bottom:0;margin:0!important;border:0;border-radius:0}.roof-backdrop{padding:26px 24px 0}@media (max-width:480px){.roof-backdrop{padding:18px 10px 0}}#header .eyebrow{display:none}#header #page-title{font-size:32px;line-height:36px;font-weight:590;letter-spacing:-.022em}#content-area:has(.docs-home) #page-title{font-size:40px!important;line-height:44px}#header .mt-0\\.5{margin-top:0}#header .mt-0\\.5>div{margin-top:0}#header>div:last-child:not(:first-child){font-size:15px;line-height:24px;letter-spacing:-.011em;color:var(--docs-body)}.docs-topic{height:280px}.docs-topic-art{flex:1;min-height:0;padding:24px 20px}.docs-topic-copy{flex:none;padding:20px;min-height:132px}.dark .docs-topic{--docs-card-border:rgba(255,255,255,.05);background:rgba(255,255,255,.05)}.dark .docs-topic:hover{--docs-card-border:rgba(255,255,255,.09);background:rgba(255,255,255,.075)}.dark .docs-topic-copy{border-color:rgba(255,255,255,.05)}.docs-home h2{font-size:20px;line-height:26.6px;font-weight:590;letter-spacing:-.012em}.docs-home-links a{font-weight:400}#sidebar button[aria-expanded]{font-size:14px;line-height:21px;font-weight:510;letter-spacing:-.013em}#sidebar a{line-height:21px;letter-spacing:-.013em}#table-of-contents{font-size:13px;line-height:19.5px}@media (min-width:1200px){.docs-topic-grid{grid-template-columns:repeat(4,minmax(0,1fr))}}@media (min-width:1024px){div:has(>#sidebar){max-width:none!important;padding-left:0!important;padding-right:0!important}#sidebar{width:280px!important}#content-container{max-width:none!important}#content-container>div{max-width:1024px;margin:0 auto;padding:48px 24px 48px;gap:76px}#content-area{max-width:650px;min-width:0;width:100%;padding:0;margin:0}#content-area:has(.docs-home){max-width:none}}@media (min-width:480px) and (max-width:1199px){.docs-topic-grid{grid-template-columns:repeat(2,minmax(0,1fr))}}@media (max-width:767px){.prose h2{font-size:20px;line-height:26.6px}}@media (max-width:480px){.docs-topic{flex-direction:column;height:280px}.docs-topic-art{padding:24px 20px}.docs-topic-copy{padding:20px;border-top:1px solid var(--docs-line);min-height:112px}}#header{margin-bottom:0}#header>.prose{margin-top:24px!important}#header>.prose p{margin:0!important;font-size:15px;line-height:24px;color:var(--docs-body)}#content-area:has(.docs-home) #header>.prose{margin-top:12px!important}#content{margin-top:20px}#content:has(.docs-home){margin-top:48px}.docs-home{padding-top:0}.docs-home h2{margin:48px 0 32px}.docs-home h2:first-child{margin-top:0}#content>.docs-figure:first-child{margin-top:0!important}@media (min-width:1024px){#sidebar-content [data-component-part=\"scroll-area-viewport\"]{padding:0 20px 150px}#sidebar-content [data-component-part=\"scroll-area-content\"]>div>.sticky{height:20px}#navigation-items>div{margin-top:0!important}#sidebar #navigation-items button[aria-expanded]{min-height:36px;padding-left:2px!important;padding-right:5px}#sidebar #navigation-items button[aria-expanded]>svg{order:2;margin-left:auto}#sidebar #navigation-items li>a{padding-left:2px!important;min-height:32px}#sidebar .nav-anchor{margin-left:0}#navigation-items>ul{position:fixed;bottom:16px;left:20px;width:240px;padding-top:16px;border-top:1px solid var(--docs-line);background:var(--docs-canvas);z-index:12}#navbar>div{max-width:none!important}#page-context-menu:not([class*=\"mt-3\"]){position:fixed;top:15px;right:208px;z-index:60}#search-bar-entry{position:fixed;left:228px;top:14px;width:36px;height:36px;padding:9px;border-radius:50%;box-shadow:none}#search-bar-entry>div>div,#search-bar-entry>span{display:none}}@media (min-width:1200px){.docs-topic-grid{margin-left:-20px;margin-right:-20px}}@media (min-width:1280px){#content-side-layout{flex:0 0 250px;width:250px;max-width:250px}#table-of-contents-layout{width:250px;padding-left:0}#table-of-contents{width:242px}#table-of-contents h2{position:absolute;width:1px;height:1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap}#table-of-contents-content{border-left:1px solid var(--docs-line);padding-left:13px;margin:0}#table-of-contents-content a{font-size:13px;line-height:19.5px;font-weight:400;text-shadow:none}#table-of-contents-content li[data-active-deepest]::before{content:'';position:absolute;left:-15px;top:4px;bottom:4px;width:2px;background:var(--docs-ink)}}@media (max-width:1023px){div:has(>#sidebar){padding-left:24px!important;padding-right:24px!important}#content-area{padding-left:0;padding-right:0}#content-container>div{padding-top:176px}#content{margin-top:16px}}"}]}
{"page":{"pagePath":"reference/roof-design-contract","slug":"/reference/roof-design-contract","pageMetadata":{"title":"Roof Vision integration contract","sidebarTitle":"Roof Vision contract","description":"The API contract, asset specification, permissions and data shapes behind Roof Vision.","icon":"file-shield","keywords":["Roof Vision","roof design","contract","api","assets","error codes","permissions","agents","single line diagram","SLD","stringing","installer","electrical"],"href":"/reference/roof-design-contract"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"The API contract, asset specification, permissions and data shapes behind Roof Vision.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,em:`em`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Table,Visibility}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Visibility)_missingMdxReference(`Visibility`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`This page is the technical contract behind `,_jsx(_components.a,{href:`/quoting/roof-design`,children:`Roof Vision`}),`. It is written for integrators and AI agents that need to operate or reason about the feature precisely. Contract version: `,_jsx(_components.strong,{children:`1`}),`.`]}),`\n`,_jsx(Visibility,{for:`humans`,children:_jsxs(_components.p,{children:[`You don’t need this page to use Roof Vision. It is technical detail for integrators and AI tools. To learn Roof Vision, read `,_jsx(_components.a,{href:`/quoting/roof-design`,children:`Use Roof Vision`}),`.`]})}),`\n`,_jsxs(Visibility,{for:`agents`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Posture.`}),` The editor is a separate first-party application embedded in an iframe, launched from inside a quote. It is not a public API and it is not documented for third-party integration. Treat every path below as internal.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`API base.`}),` `,_jsx(_components.code,{children:`/api/roof-design/v1`}),`, served by a catch-all route on the Node.js runtime. Responses set `,_jsx(_components.code,{children:`Cache-Control: no-store`}),`, `,_jsx(_components.code,{children:`Referrer-Policy: no-referrer`}),` and `,_jsx(_components.code,{children:`Vary: Origin`}),`. CORS echoes the configured roof design origin only, with credentials allowed and headers `,_jsx(_components.code,{children:`Authorization, Content-Type`}),`.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Request size limit.`}),` Any request body over roughly 5 MB is refused with `,_jsx(_components.code,{children:`422 VALIDATION`}),` — `,_jsx(_components.code,{children:`Request too large.`}),` A design document over 5 MB is refused with `,_jsx(_components.code,{children:`Design document exceeds 5 MB.`})]}),_jsx(Heading,{level:`3`,id:`authentication-modes`,children:`Authentication modes`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Mode`}),_jsx(_components.th,{children:`How`}),_jsx(_components.th,{children:`Used by`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Cookie session`}),_jsx(_components.td,{children:`The signed-in ArcSolar session`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`launch`}),`, `,_jsx(_components.code,{children:`attach`}),`, and cookie-authorised writes`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Bearer capability`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`Authorization: Bearer \u003caccessToken>`}),`, a project-scoped opaque token`]}),_jsx(_components.td,{children:`Embedded-app reads and writes`})]})]})]}),_jsx(_components.p,{children:`Rules that matter:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`launch`}),` and `,_jsx(_components.code,{children:`attach`}),` require cookie identity and `,_jsx(_components.strong,{children:`reject`}),` a bearer token: `,_jsx(_components.code,{children:`403 Launch from ArcSolar.`}),` and `,_jsx(_components.code,{children:`403 Review in ArcSolar.`})]}),`\n`,_jsxs(_components.li,{children:[`Cookie-authorised writes are accepted only when the request origin equals the app origin or the configured roof design origin, otherwise `,_jsx(_components.code,{children:`403 Request origin denied.`})]}),`\n`,_jsxs(_components.li,{children:[`Cookie writes additionally require the `,_jsx(_components.code,{children:`quote.revise`}),` capability. A denied capability surfaces as `,_jsx(_components.code,{children:`403 You do not have permission to edit quote designs.`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`sign-out`}),` is origin-gated and returns `,_jsx(_components.code,{children:`204`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`The bearer capability is workspace- and project-scoped. Every project, revision, asset and command query filters on the workspace, and a request naming any other project returns `,_jsx(_components.code,{children:`403 This launch is restricted to its project.`}),` A capability can never create a project: `,_jsx(_components.code,{children:`403 Open a new project from ArcSolar.`})]}),`\n`]}),_jsx(Heading,{level:`3`,id:`launch-and-exchange`,children:`Launch and exchange`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Step`}),_jsx(_components.th,{children:`Route`}),_jsx(_components.th,{children:`Detail`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Launch`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`POST /api/roof-design/v1/launch`})}),_jsx(_components.td,{children:`Accepts an address, optional coordinates, and optional project, customer, site, opportunity, quote draft id and draft key. Creates a project when none is given, then loads it to enforce access before issuing a code.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Exchange`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`POST /api/roof-design/v1/exchange`})}),_jsxs(_components.td,{children:[`Body is a single `,_jsx(_components.code,{children:`launchCode`}),`, 40 to 100 characters. Returns an access token, its expiry, the project id, the organisation id, the quote draft id.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Sign out`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`POST /api/roof-design/v1/sign-out`})}),_jsx(_components.td,{children:`Origin-gated; ends the embedded session locally.`})]})]})]}),_jsxs(_components.p,{children:[`The launch code is bound to the exact origin, expires in `,_jsx(_components.strong,{children:`60 seconds`}),`, and is consumed once atomically. A second exchange of the same code fails with `,_jsx(_components.code,{children:`401 LAUNCH_EXPIRED`}),` — `,_jsx(_components.code,{children:`This launch expired or was already used. Reopen from ArcSolar.`}),` The access token is the opaque capability itself, not a signed token, and it is valid for at most `,_jsx(_components.strong,{children:`10 minutes`}),`, capped by the remaining ArcSolar session. If the session has under a minute left, launch is refused with `,_jsx(_components.code,{children:`401 UNAUTHENTICATED`}),` — `,_jsx(_components.code,{children:`Refresh your ArcSolar session before opening the panel.`})]}),_jsx(_components.p,{children:`The launch response omits extracted credentials from any URL. Nothing in this flow puts a credential in a query string, a fragment, or a referrer.`}),_jsx(Heading,{level:`3`,id:`design-revisions-and-assets`,children:`Design revisions and assets`}),_jsxs(_components.p,{children:[`A revision is an immutable checkpoint. Creating one copies the authoritative project context and selected equipment — never a snapshot supplied by the embedded app. Revising a saved revision means creating a new one; updating or deleting one is refused with `,_jsx(_components.code,{children:`IMMUTABLE: create a new design revision`}),`.`]}),_jsx(_components.p,{children:`Two image assets are required per revision.`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Requirement`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`type`})}),_jsxs(_components.td,{children:[`Exactly `,_jsx(_components.code,{children:`panel-layout`}),` or `,_jsx(_components.code,{children:`stringing-components`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Format`}),_jsx(_components.td,{children:`PNG only`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Long edge`}),_jsxs(_components.td,{children:[`At least `,_jsx(_components.strong,{children:`2400 px`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`revisionId`})}),_jsx(_components.td,{children:`The revision the image belongs to`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sha256`})}),_jsx(_components.td,{children:`Lowercase hex checksum of the exact bytes`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`width`}),`, `,_jsx(_components.code,{children:`height`})]}),_jsx(_components.td,{children:`Must match the uploaded image exactly`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`attribution`})}),_jsx(_components.td,{children:`Non-empty imagery attribution, preserved and shown to the customer`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`address`})}),_jsx(_components.td,{children:`Must equal the revision’s context address`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`framingId`})}),_jsxs(_components.td,{children:[`Non-empty; `,_jsx(_components.strong,{children:`both images in a bundle must share it`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`northIndicator`})}),_jsxs(_components.td,{children:[`Must be literally `,_jsx(_components.code,{children:`true`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`complete`})}),_jsxs(_components.td,{children:[`Must be literally `,_jsx(_components.code,{children:`true`})]})]})]})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Upload shape.`}),` Upload uses a signed upload URL with upsert disabled, then a separate completion call. Completion re-reads the stored object and verifies byte length within the 20 MiB bucket limit, checksum, PNG format, and exact width and height. Any mismatch fails with `,_jsx(_components.code,{children:`422 VALIDATION`}),` — `,_jsx(_components.code,{children:`Image bytes, dimensions or checksum do not match.`}),` Completing before uploading fails with `,_jsx(_components.code,{children:`409 ASSETS_NOT_READY`}),` — `,_jsx(_components.code,{children:`Upload the image before completing it.`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Storage.`}),` Bucket `,_jsx(_components.code,{children:`roof-design-private`}),`; private; 20 MiB file size limit; allowed MIME type `,_jsx(_components.code,{children:`image/png`}),` only. Object paths are generated server-side as `,_jsx(_components.code,{children:`workspace/project/revision/type.png`}),` and are unique per revision and type. There is exactly one row per revision and type: a second upload attempt is refused with `,_jsx(_components.code,{children:`VALIDATION: immutable asset metadata`}),`. Once an asset is `,_jsx(_components.code,{children:`ready`}),` it is immutable — trigger-level guards reject deletion and any change other than status and completion time.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Bundle completeness.`}),` A bundle exists only when `,_jsx(_components.strong,{children:`both`}),` assets for the same revision are `,_jsx(_components.code,{children:`ready`}),`, ordered `,_jsx(_components.code,{children:`panel-layout`}),` then `,_jsx(_components.code,{children:`stringing-components`}),`, with equal revision, equal address to the site address, a long edge of at least 2400, and the same `,_jsx(_components.code,{children:`framingId`}),`. Reading an asset re-verifies that its path belongs to the requested bundle and re-hashes the bytes, failing with `,_jsx(_components.code,{children:`409 Design image integrity check failed.`}),` on mismatch. A bundle cannot be completed from a revision whose customer is unset.`]}),_jsxs(_components.p,{children:[`An incomplete attempt never replaces a prior complete bundle. The refusal is `,_jsx(_components.code,{children:`409 ASSETS_NOT_READY`}),` — `,_jsx(_components.code,{children:`Both completed design images are required. The previous bundle is retained.`})]}),_jsx(Heading,{level:`3`,id:`design-artefacts-and-electrical-scope`,children:`Design artefacts and electrical scope`}),_jsx(_components.p,{children:`The integration transmits and stores design artefacts. It does not interpret them.`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Artefact`}),_jsx(_components.th,{children:`Producer`}),_jsx(_components.th,{children:`ArcSolar’s role`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Panel layout`}),_jsxs(_components.td,{children:[`External editor (`,_jsx(_components.code,{children:`engine: \"simple-designer\"`}),`)`]}),_jsxs(_components.td,{children:[`Stores the editor document; stores the rendered `,_jsx(_components.code,{children:`panel-layout`}),` PNG; labels and places it`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Stringing and component layout`}),_jsx(_components.td,{children:`External editor`}),_jsxs(_components.td,{children:[`Stores the rendered `,_jsx(_components.code,{children:`stringing-components`}),` PNG; labels and places it`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Single line diagram (SLD)`}),_jsxs(_components.td,{children:[`External editor. SLD `,_jsx(_components.em,{children:`state`}),` lives inside the document payload`]}),_jsxs(_components.td,{children:[`Persists the payload losslessly and never reads it back. `,_jsx(_components.strong,{children:`ArcSolar has no SLD surface.`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Measurements and annotations`}),_jsx(_components.td,{children:`External editor`}),_jsxs(_components.td,{children:[`Persisted inside the opaque payload, for example a `,_jsx(_components.code,{children:`measurement`}),` object with `,_jsx(_components.code,{children:`class: \"cable\"`}),` and points. Never parsed, never surfaced.`]})]})]})]}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`payload`}),` is `,_jsx(_components.code,{children:`z.record(z.string(), z.unknown())`}),`, annotated in `,_jsx(_components.code,{children:`contract.ts`}),` as “Opaque, lossless editor state: the integration never reconstructs geometry.” A payload key may hold any shape. Nothing in ArcSolar enumerates or validates the document’s internal keys beyond `,_jsx(_components.code,{children:`version`}),` and `,_jsx(_components.code,{children:`engine`}),`, and unknown keys are retained — which is what makes the persistence lossless.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`No electrical calculation exists anywhere in this integration.`}),` There is no code path that sizes a string, sums a string voltage, checks an MPPT window, computes a cable run or a voltage drop, or validates a design against `,_jsx(_components.code,{children:`max_system_voltage_v`}),` or the inverter MPPT limits. The only electrical data ArcSolar touches is the read-only reference catalogue it serves at `,_jsx(_components.code,{children:`GET /api/roof-design/v1/catalogue`}),` from the shared `,_jsx(_components.code,{children:`solar_catalogue_*`}),` rows: panel `,_jsx(_components.code,{children:`voc_v`}),`, `,_jsx(_components.code,{children:`isc_a`}),`, `,_jsx(_components.code,{children:`impp_a`}),`, `,_jsx(_components.code,{children:`vmpp_v`}),`, `,_jsx(_components.code,{children:`temp_coeff_voc_pct_per_c`}),`, `,_jsx(_components.code,{children:`temp_coeff_isc_pct_per_c`}),`, `,_jsx(_components.code,{children:`max_system_voltage_v`}),` and `,_jsx(_components.code,{children:`max_series_fuse_a`}),`, plus inverter and per-tracker MPPT rows (`,_jsx(_components.code,{children:`mppt_voltage_min_v`}),`, `,_jsx(_components.code,{children:`mppt_voltage_max_v`}),`, `,_jsx(_components.code,{children:`max_input_current_per_mppt_max_a`}),`, `,_jsx(_components.code,{children:`max_isc_per_mppt_max_a`}),`, `,_jsx(_components.code,{children:`strings_per_mppt_max`}),`, and per-tracker `,_jsx(_components.code,{children:`strings`}),`). Those rows are shared reference data carrying no `,_jsx(_components.code,{children:`workspace_id`}),`, returned as stored, and every measurement is text that the editor normalises. `,_jsx(_components.strong,{children:`Serving a specification is not evaluating it.`})]}),_jsx(_components.p,{children:`An integrator should therefore treat the document as write-only from ArcSolar’s perspective: send it, have it stored, get it back unaltered. Do not expect ArcSolar to reject an electrically invalid design, and do not ask ArcSolar for a derived electrical figure. If a stringing or SLD value is not inside the payload or drawn on an image, ArcSolar does not have it.`}),_jsx(Heading,{level:`3`,id:`error-codes`,children:`Error codes`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`UNAUTHENTICATED`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`401`}),_jsx(_components.td,{children:`No valid session or capability`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`LAUNCH_EXPIRED`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`401`}),_jsx(_components.td,{children:`Launch code reused or past its 60-second life`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`FORBIDDEN`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:`Wrong origin, wrong project scope, or missing capability`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`NOT_FOUND`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:`Missing project, revision, asset, image, or draft`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`DISABLED`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:`Host origin or launch encryption is not configured`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`VERSION_CONFLICT`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`expectedVersion`}),` did not match the stored version`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ASSETS_NOT_READY`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:`A required image is missing, incomplete, or inconsistent`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`REVIEW_REQUIRED`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:`The design does not match the saved commercial draft`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`VALIDATION`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`422`}),_jsx(_components.td,{children:`Invalid payload, document, or image bytes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`UNAVAILABLE`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`503`}),_jsx(_components.td,{children:`Temporary failure or an unresolvable draft`})]})]})]}),_jsxs(_components.p,{children:[`Underlying database errors are mapped deterministically: `,_jsx(_components.code,{children:`42501`}),` becomes `,_jsx(_components.code,{children:`403 You do not have access to this design.`}),`, `,_jsx(_components.code,{children:`40001`}),` or `,_jsx(_components.code,{children:`PT409`}),` become `,_jsx(_components.code,{children:`409 VERSION_CONFLICT The design changed. Reload before saving.`}),`, and anything else becomes `,_jsx(_components.code,{children:`422 VALIDATION`}),`, with a message already prefixed `,_jsx(_components.code,{children:`VALIDATION:`}),` passed through verbatim.`]}),_jsx(Heading,{level:`3`,id:`permissions`,children:`Permissions`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Surface`}),_jsx(_components.th,{children:`Who`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Read a design`}),_jsx(_components.td,{children:`Active workspace member with access to the linked customer, plus an explicit grant for address-only projects`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Mutate a design`}),_jsxs(_components.td,{children:[`Roles `,_jsx(_components.code,{children:`administrator`}),`, `,_jsx(_components.code,{children:`developer`}),`, `,_jsx(_components.code,{children:`operations`}),`, `,_jsx(_components.code,{children:`sales`}),`, and `,_jsx(_components.code,{children:`team_leader`}),` within its approved-rep scope, with an active auth session`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Grant or share`}),_jsxs(_components.td,{children:[`Workspace owner, `,_jsx(_components.code,{children:`administrator`}),`, or `,_jsx(_components.code,{children:`developer`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Organisation-level defaults`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`administrator`}),` or `,_jsx(_components.code,{children:`developer`})]})]})]})]}),_jsxs(_components.p,{children:[`Row-level security is enabled on every table. Browser roles are granted `,_jsx(_components.code,{children:`select`}),` only, except the launch-exchange table, which has no browser grant and no policy at all — its contents are server-only. Command execution requires a current auth session and one of the mutating roles.`]}),_jsx(Heading,{level:`3`,id:`availability`,children:`Availability`}),_jsxs(_components.p,{children:[`Roof Vision is included with the `,_jsx(_components.strong,{children:`Arc`}),` plan. The plan gate is evaluated where the feature is opened, and the design APIs stay gated per request.`]}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Gate`}),_jsx(_components.th,{children:`Applies to`}),_jsx(_components.th,{children:`Failure`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Arc `,_jsx(_components.code,{children:`roof_vision`}),` entitlement`]}),_jsx(_components.td,{children:`The Roof Vision page and its design library`}),_jsxs(_components.td,{children:[`Not an error: the page renders the upgrade state — `,_jsx(_components.strong,{children:`Roof Vision is not enabled`}),` / `,_jsx(_components.code,{children:`Roof Vision is included with the Arc plan. Upgrade to design roof layouts from satellite imagery and attach them to a quote.`})]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`page.roof-vision`}),` capability`]}),_jsx(_components.td,{children:`Reaching the Roof Vision page`}),_jsxs(_components.td,{children:[`Administrator, developer, operations, sales manager (`,_jsx(_components.code,{children:`team_leader`}),`, limited to approved reps’ customers) and sales representative hold it; finance, technician and external marketing do not`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`quote.revise`}),` capability`]}),_jsxs(_components.td,{children:[`Cookie-authorised writes — `,_jsx(_components.code,{children:`launch`}),`, `,_jsx(_components.code,{children:`attach`}),`, and cookie writes`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`403 You do not have permission to edit quote designs.`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Origin validation`}),_jsx(_components.td,{children:`Every cookie-authorised write, and CORS`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`403 Request origin denied.`})})]})]})]}),_jsxs(_components.p,{children:[`A long-standing workspace can be covered `,_jsx(_components.strong,{children:`by arrangement`}),` rather than by a subscription feature, which is why the plan row may be absent for it. That is a per-workspace decision; never promise it to another workspace.`]}),_jsx(_components.p,{children:`Reads require active workspace membership plus access to the linked customer, with an explicit grant for address-only projects.`}),_jsxs(_components.p,{children:[`The permitted embedded host resolves from `,_jsx(_components.code,{children:`ROOF_DESIGN_ORIGIN`}),`, which defaults to `,_jsx(_components.code,{children:`https://design.arcsolar.com.au`}),`. The value must be a bare https origin with no path; `,_jsx(_components.code,{children:`localhost`}),` and `,_jsx(_components.code,{children:`127.0.0.1`}),` are accepted for local development, and any other host is rejected at resolution time.`]}),_jsx(Heading,{level:`3`,id:`configuration-accuracy`,children:`Configuration accuracy`}),_jsxs(_components.p,{children:[`Four `,_jsx(_components.code,{children:`ROOF_DESIGN_QA_*`}),` names — `,_jsx(_components.code,{children:`ROOF_DESIGN_QA_ENABLED`}),`, `,_jsx(_components.code,{children:`NEXT_PUBLIC_ROOF_DESIGN_QA_ENABLED`}),`, `,_jsx(_components.code,{children:`ROOF_DESIGN_QA_ORIGIN`}),` and `,_jsx(_components.code,{children:`ROOF_DESIGN_QA_PROJECT_REF`}),` — appear in `,_jsx(_components.code,{children:`.env.example`}),` and earlier contract text but are read by `,_jsx(_components.strong,{children:`no application code`}),`. Runtime configuration is `,_jsx(_components.code,{children:`ROOF_DESIGN_ORIGIN`}),` (default `,_jsx(_components.code,{children:`https://design.arcsolar.com.au`}),`) and `,_jsx(_components.code,{children:`ROOF_DESIGN_EXCHANGE_KEY`}),`, the latter falling back to a key derived from `,_jsx(_components.code,{children:`SUPABASE_SECRET_KEY`}),` / `,_jsx(_components.code,{children:`SUPABASE_SERVICE_ROLE_KEY`}),`. Do not rely on the `,_jsx(_components.code,{children:`ROOF_DESIGN_QA_*`}),` names for gating: setting them has no effect, and omitting them does not disable the feature.`]}),_jsx(Heading,{level:`3`,id:`data-shapes`,children:`Data shapes`}),_jsx(_components.p,{children:`The integration keeps nine tables, all workspace-scoped and all registered in the tenant purge manifest.`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Table`}),_jsx(_components.th,{children:`Holds`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`roof_design_projects`})}),_jsxs(_components.td,{children:[`One design project: address, coordinates, optional customer, site and opportunity, the design document, selected equipment, and a positive integer `,_jsx(_components.code,{children:`version`}),` used for optimistic concurrency`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`roof_design_grants`})}),_jsx(_components.td,{children:`Per-member edit grants for address-only projects`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`roof_design_revisions`})}),_jsx(_components.td,{children:`Immutable checkpoints with document, context snapshot and equipment snapshot`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`roof_design_assets`})}),_jsxs(_components.td,{children:[`One row per revision and image type, with checksum, dimensions, metadata and `,_jsx(_components.code,{children:`pending`}),` or `,_jsx(_components.code,{children:`ready`}),` status`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`roof_design_quote_links`})}),_jsx(_components.td,{children:`The reviewed attachment: revision, quote draft, bundle, commercial fingerprint, reviewer, and the issued estimate if any`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`roof_design_equipment`})}),_jsx(_components.td,{children:`The equipment catalogue and its mapping to commercial products`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`roof_design_preferences`})}),_jsx(_components.td,{children:`Organisation- or member-scoped defaults`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`roof_design_events`})}),_jsx(_components.td,{children:`Append-only audit events`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`roof_design_launch_exchanges`})}),_jsx(_components.td,{children:`Server-only launch codes and session capabilities`})]})]})]}),_jsxs(_components.p,{children:[`Key interfaces available to the embedded app include a command entry point (`,_jsx(_components.code,{children:`roof_design_command`}),`), a context reader (`,_jsx(_components.code,{children:`roof_design_context`}),`), a defaults writer (`,_jsx(_components.code,{children:`roof_design_defaults`}),`), and a member-scoped quote draft reader (`,_jsx(_components.code,{children:`get_quote_builder_draft`}),`). The draft reader returns only the caller’s own draft, and settlement requires the returned id to equal the id the caller named.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Context shape returned to the editor.`}),` Version 1, with the organisation id, read/edit/attach permissions, optional customer, site and opportunity ids, address, coordinates, optional NMI evidence (value, evidence id, site id), and up to 200 selected equipment lines. Note that the draft id in this context is not the live quote draft id; the live id comes from the launch exchange.`]}),_jsx(Heading,{level:`3`,id:`one-roof-design-per-estimate`,children:`One roof design per estimate`}),_jsxs(_components.p,{children:[`The provider-based rooftop analysis that older quotes could carry has been retired. A solar estimate now carries a single `,_jsx(_components.code,{children:`roofDesign`}),` bundle (`,_jsx(_components.code,{children:`proposalDesignBundleSchema`}),`, provider literal `,_jsx(_components.code,{children:`roof-design`}),`) produced by the Roof Vision editor over the iframe handshake. The bundle holds the two rendered PNGs — `,_jsx(_components.code,{children:`panel-layout`}),` and `,_jsx(_components.code,{children:`stringing-components`}),` — plus the selected equipment lines, and nothing else.`]}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The quote builder’s solar step requires the bundle. Without it the step reports `,_jsx(_components.code,{children:`Open Roof Vision in the Solar step and attach the roof design to this quote.`}),`, and sending is refused with `,_jsx(_components.code,{children:`Open Roof Vision in the Solar step and attach the roof design before sending this estimate.`})]}),`\n`,_jsxs(_components.li,{children:[`The estimate portal renders exactly one roof block, `,_jsx(_components.code,{children:`#portal-roof`}),`, whose navigation label is `,_jsx(_components.strong,{children:`Roof design`}),`, headed `,_jsx(_components.strong,{children:`Solar panel layout`}),` and `,_jsx(_components.strong,{children:`Stringing and component layout`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.strong,{children:`estimate PDF`}),` (`,_jsx(_components.code,{children:`src/lib/quotes/estimate-pdf.ts`}),`) draws the section heading `,_jsx(_components.strong,{children:`PROPOSED ROOFTOP DESIGN`}),` with the captions `,_jsx(_components.strong,{children:`PROPOSED PANEL LAYOUT`}),` and `,_jsx(_components.strong,{children:`PANEL STRINGS \u0026 COMPONENT MARKINGS`}),`. The `,_jsx(_components.strong,{children:`contract PDF`}),` (`,_jsx(_components.code,{children:`src/lib/quotes/contract-pdf.ts`}),`) and the `,_jsx(_components.strong,{children:`tenant-document PDF`}),` (`,_jsx(_components.code,{children:`src/lib/quotes/tenant-document-pdf.ts`}),`) `,_jsx(_components.strong,{children:`append`}),` one A4 landscape page per drawing through `,_jsx(_components.code,{children:`appendRoofDesignPages`}),`.`]}),`\n`,_jsx(_components.li,{children:`Customer surfaces carry no electrical metrics from this bundle: no capacity, annual energy, exposure or provider badge. Those figures belonged to the retired provider analysis and are no longer produced. Do not attribute them to Roof Vision.`}),`\n`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`The approval layer.`}),` With `,_jsx(_components.code,{children:`ROOF_VISION_APPROVAL_LAYER`}),` unset or `,_jsx(_components.code,{children:`no`}),`, attaching records a commercial fingerprint of the draft rather than comparing every line, and the rep’s flow has no review step. With `,_jsx(_components.code,{children:`ROOF_VISION_APPROVAL_LAYER=yes`}),`, attaching and issuing reconcile the design’s customer, supply address, panel model and quantity, and other equipment against the saved draft, and a mismatch returns `,_jsx(_components.code,{children:`409 REVIEW_REQUIRED`}),` — `,_jsx(_components.code,{children:`Reconcile \u003cmismatched dimensions, comma separated> using the quote's commercial package controls, then review again.`})]}),_jsx(Heading,{level:`3`,id:`the-editor-document-is-opaque`,children:`The editor document is opaque`}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`payload`}),` is `,_jsx(_components.code,{children:`z.record(z.string(), z.unknown())`}),`, annotated in `,_jsx(_components.code,{children:`contract.ts`}),` as “Opaque, lossless editor state: the integration never reconstructs geometry.” Only `,_jsx(_components.code,{children:`version`}),` and `,_jsx(_components.code,{children:`engine`}),` are validated, and unknown keys are retained — which is what makes the persistence lossless. The document’s internal shape is `,_jsx(_components.strong,{children:`not`}),` a contract: do not depend on any particular key, and do not describe string architecture, per-string module counts, string voltages or MPPT allocation as ArcSolar behaviour. ArcSolar’s own verifiable description of the stringing drawing is its label, `,_jsx(_components.strong,{children:`Stringing and component layout`}),`, and the portal alt text `,_jsx(_components.code,{children:`Roof imagery showing string assignments, connection order and components`}),`.`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`related`,children:`Related`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/quoting/roof-design`,children:`Use Roof Vision`}),` — the working guide.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/reference/availability`,children:`Feature availability`}),` — how gated features are presented.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/reference/support`,children:`Get help from ArcSolar`}),` — how to get help.`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Roof Vision integration contract","sidebarTitle":"Roof Vision contract","description":"The API contract, asset specification, permissions and data shapes behind Roof Vision.","icon":"file-shield","keywords":["Roof Vision","roof design","contract","api","assets","error codes","permissions","agents","single line diagram","SLD","stringing","installer","electrical"],"href":"/reference/roof-design-contract"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Related","slug":"related","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"arc-solar","siteName":"ArcSolar Docs","title":"Roof Vision integration contract - ArcSolar Docs","contextualStarterQuestions":[{"_id":"6afa8eba1f9d07a715bb1275","deploymentId":"6aa411065dbe90ba9fa02a90","questionText":"How do CORS headers work?","status":"active","generatedBy":"contextual","path":"reference/roof-design-contract","createdAt":"2026-11-16T05:03:54.529Z","updatedAt":"2026-11-16T05:03:54.529Z","__v":0},{"_id":"6afa8eba1f9d07a715bb1273","deploymentId":"6aa411065dbe90ba9fa02a90","questionText":"What authentication modes are supported?","status":"active","generatedBy":"contextual","path":"reference/roof-design-contract","createdAt":"2026-11-16T05:03:54.529Z","updatedAt":"2026-11-16T05:03:54.529Z","__v":0},{"_id":"6afa8eba1f9d07a715bb1274","deploymentId":"6aa411065dbe90ba9fa02a90","questionText":"What's the request size limit?","status":"active","generatedBy":"contextual","path":"reference/roof-design-contract","createdAt":"2026-11-16T05:03:54.529Z","updatedAt":"2026-11-16T05:03:54.529Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{},"searchTabScopes":[]},"lastModified":"2026-11-16T05:03:47.340Z","originalFileLocation":"reference/roof-design-contract.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The API contract, asset specification, permissions and data shapes behind Roof Vision.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ArcSolar Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/arc-solar/cXeK4KSjQKr6gwOm/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/arc-solar/cXeK4KSjQKr6gwOm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/arc-solar/cXeK4KSjQKr6gwOm/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/arc-solar/cXeK4KSjQKr6gwOm/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/arc-solar/cXeK4KSjQKr6gwOm/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/arc-solar/cXeK4KSjQKr6gwOm/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/arc-solar/cXeK4KSjQKr6gwOm/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/arc-solar/cXeK4KSjQKr6gwOm/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/arc-solar/cXeK4KSjQKr6gwOm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Roof Vision integration contract - ArcSolar Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"The API contract, asset specification, permissions and data shapes behind Roof Vision.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ArcSolar Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.arcsolar.com.au/reference/roof-design-contract\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://arc-solar.mintlify.site/_mintlify/api/og/v2?division=Help+and+reference\u0026amp;title=Roof+Vision+integration+contract\u0026amp;description=The+API+contract%2C+asset+specification%2C+permissions+and+data+shapes+behind+Roof+Vision.\u0026amp;theme=1185473f3d1d2c2c4b33bbcb\u0026amp;signature=90f2d6bc26fbc986c067c75f73585de70346e9e4928f0400e21709443958bb8c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Roof Vision integration contract - ArcSolar Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The API contract, asset specification, permissions and data shapes behind Roof Vision.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://arc-solar.mintlify.site/_mintlify/api/og/v2?division=Help+and+reference\u0026amp;title=Roof+Vision+integration+contract\u0026amp;description=The+API+contract%2C+asset+specification%2C+permissions+and+data+shapes+behind+Roof+Vision.\u0026amp;theme=1185473f3d1d2c2c4b33bbcb\u0026amp;signature=90f2d6bc26fbc986c067c75f73585de70346e9e4928f0400e21709443958bb8c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/arc-solar/cXeK4KSjQKr6gwOm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ArcSolar Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#626A78\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_AU\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.arcsolar.com.au/reference/roof-design-contract\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/roof-design-contract.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.arcsolar.com.au/#organization\",\"name\":\"ArcSolar\",\"legalName\":\"Argonix Digital\",\"url\":\"https://www.arcsolar.com.au\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/arc-solar/rORb2_IX6bMXscj_/images/ArcSolar-Wordmark.png?fit=max\u0026auto=format\u0026n=rORb2_IX6bMXscj_\u0026q=85\u0026s=a203a91291a1cc71ffa5d984b4ec26e6\"},\"sameAs\":[\"https://www.linkedin.com/company/argonix-digital\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.arcsolar.com.au#website\",\"name\":\"ArcSolar Docs\",\"url\":\"https://docs.arcsolar.com.au\",\"publisher\":{\"@id\":\"https://www.arcsolar.com.au/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.arcsolar.com.au/reference/roof-design-contract#webpage\",\"url\":\"https://docs.arcsolar.com.au/reference/roof-design-contract\",\"name\":\"Roof Vision integration contract\",\"description\":\"The API contract, asset specification, permissions and data shapes behind Roof Vision.\",\"dateModified\":\"2026-11-16T05:03:47.340Z\",\"isPartOf\":{\"@id\":\"https://docs.arcsolar.com.au#website\"},\"breadcrumb\":{\"@id\":\"https://docs.arcsolar.com.au/reference/roof-design-contract#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.arcsolar.com.au/reference/roof-design-contract#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Documentation\",\"item\":\"https://docs.arcsolar.com.au\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Help and reference\",\"item\":\"https://docs.arcsolar.com.au/reference/support\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Roof Vision integration contract\",\"item\":\"https://docs.arcsolar.com.au/reference/roof-design-contract\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.arcsolar.com.au/reference/roof-design-contract#article\",\"headline\":\"Roof Vision integration contract\",\"name\":\"Roof Vision integration contract\",\"description\":\"The API contract, asset specification, permissions and data shapes behind Roof Vision.\",\"url\":\"https://docs.arcsolar.com.au/reference/roof-design-contract\",\"mainEntityOfPage\":{\"@id\":\"https://docs.arcsolar.com.au/reference/roof-design-contract#webpage\"},\"dateModified\":\"2026-11-16T05:03:47.340Z\",\"keywords\":\"Roof Vision, roof design, contract, api, assets, error codes, permissions, agents, single line diagram, SLD, stringing, installer, electrical\",\"publisher\":{\"@id\":\"https://www.arcsolar.com.au/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.arcsolar.com.au#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ArcSolar Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ArcSolar\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/roof-design-contract.md","siteName":"ArcSolar Docs","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"},{"anchor":"Get support","icon":"comment","href":"mailto:support@arcsolar.com.au"}]},"groups":[{"group":"Documentation","pages":[{"group":"Getting started","expanded":true,"pages":[{"title":"ArcSolar Docs","sidebarTitle":"Overview","icon":"book-open","mode":"wide","href":"/index"},{"title":"Start guide","sidebarTitle":"Start guide","icon":"graduation-cap","href":"/start-guide"},{"icon":"route","sidebarTitle":"The customer journey","title":"The customer journey","href":"/quickstart"},{"icon":"sparkles","sidebarTitle":"Agent","title":"Agent","href":"/agent"},{"icon":"compass","sidebarTitle":"Find your way around","title":"Find your way around","href":"/reference/workspace"}]},{"group":"Customers and conversations","expanded":false,"pages":[{"icon":"address-book","sidebarTitle":"Customer records","title":"Customer records","href":"/customers/records"},{"icon":"file-csv","sidebarTitle":"Import leads from a CSV","title":"Import leads from a CSV","href":"/customers/import-leads"},{"icon":"link","sidebarTitle":"Lead intake form","title":"Lead intake form","href":"/customers/intake-form"},{"icon":"filter","sidebarTitle":"Pipeline","title":"Pipeline","href":"/customers/pipeline"},{"icon":"inbox","sidebarTitle":"Inbox","title":"Inbox","href":"/customers/inbox"},{"icon":"messages","sidebarTitle":"Comms","title":"Comms","href":"/customers/comms"},{"icon":"phone","sidebarTitle":"Calls and SMS","title":"Calls and SMS","href":"/customers/calls-sms"},{"icon":"microphone","sidebarTitle":"CallIntelligence","title":"CallIntelligence","href":"/customers/call-intelligence"},{"icon":"circle-check","sidebarTitle":"Tasks","title":"Tasks","href":"/customers/tasks"},{"icon":"sun","sidebarTitle":"Your sales day","title":"Your sales day","href":"/customers/daily-routine"}]},{"group":"Quoting","expanded":false,"pages":[{"icon":"file-invoice-dollar","sidebarTitle":"Create a quote","title":"Create a quote","href":"/quoting/walkthrough"},{"icon":"location-dot","sidebarTitle":"Site information","title":"Site information","href":"/quoting/site-information"},{"icon":"magnifying-glass","sidebarTitle":"Bill analysis","title":"Bill analysis","href":"/quoting/bill-analysis"},{"icon":"calculator","sidebarTitle":"Savings estimates","title":"Savings estimates","href":"/quoting/savings"},{"icon":"certificate","sidebarTitle":"Incentives and STCs","title":"Incentives and STCs","href":"/quoting/incentives-stcs"},{"icon":"wallet","sidebarTitle":"Payment options","title":"Payment options","href":"/quoting/payment-options"},{"icon":"eye","sidebarTitle":"Customer quote view","title":"Customer quote view","href":"/quoting/customer-view"},{"title":"Compare estimates","sidebarTitle":"Compare estimates","href":"/quoting/compare-estimates"},{"icon":"file-pen","sidebarTitle":"Quote revisions","title":"Quote revisions","href":"/quoting/revisions"},{"icon":"clock","sidebarTitle":"Follow-up messages","title":"Follow-up messages","href":"/quoting/follow-ups"},{"icon":"bolt","sidebarTitle":"Rebate settings","title":"Rebate settings","href":"/quoting/energy-data"}]},{"group":"Roof Vision","expanded":false,"pages":[{"title":"Roof Vision","icon":"solar-panel","sidebarTitle":"Roof Vision","href":"/quoting/roof-design"},{"title":"The design editor","sidebarTitle":"The design editor","href":"/roof-design/editor"},{"title":"Stringing","sidebarTitle":"Stringing","href":"/roof-design/stringing"},{"title":"Single line diagram","sidebarTitle":"Single line diagram","href":"/roof-design/sld"}]},{"group":"Projects and delivery","expanded":false,"pages":[{"icon":"folder-open","sidebarTitle":"Projects and jobs","title":"Projects and jobs","href":"/delivery/projects"},{"icon":"user-gear","sidebarTitle":"Installers","title":"Installers","href":"/delivery/installers"},{"icon":"calendar-days","sidebarTitle":"Calendar","title":"Calendar","href":"/delivery/calendar"},{"icon":"helmet-safety","sidebarTitle":"Field operations","title":"Field operations","href":"/delivery/field-operations"},{"title":"Work app for installers","sidebarTitle":"Work app","icon":"mobile-screen","href":"/delivery/job-portal"},{"icon":"plug-circle-bolt","sidebarTitle":"Grid connections","title":"Grid connections","href":"/delivery/grid-connections"},{"icon":"house-user","sidebarTitle":"Customer portal","title":"Customer portal after signing","href":"/delivery/customer-portal"},{"icon":"boxes-stacked","sidebarTitle":"Product catalogue","title":"Product catalogue","href":"/delivery/catalogue"},{"icon":"gift","sidebarTitle":"Promo bundles","title":"Promo bundles","href":"/delivery/promo-bundles"},{"icon":"warehouse","sidebarTitle":"Inventory","title":"Inventory","href":"/delivery/inventory"},{"icon":"stamp","sidebarTitle":"Rebate tracking","title":"Rebate tracking","href":"/delivery/rebates"},{"icon":"money-bill-transfer","sidebarTitle":"Project finances","title":"Project finances","href":"/delivery/finance"}]},{"group":"Reporting","expanded":false,"pages":[{"icon":"user","sidebarTitle":"Rep Overview","title":"Rep Overview","href":"/reporting/rep-overview"},{"icon":"bullseye","sidebarTitle":"Sales dashboard","title":"Sales dashboard","href":"/reporting/sales"},{"icon":"chart-pie","sidebarTitle":"Dashboard overview","title":"Dashboard overview","href":"/reporting/overview"},{"icon":"chart-line","sidebarTitle":"Sales and pipeline","title":"Sales reporting and pipeline","href":"/reporting/sales-pipeline"},{"icon":"filter","sidebarTitle":"Lead management","title":"Lead management","href":"/reporting/lead-management"},{"icon":"clipboard-check","sidebarTitle":"Accountability","title":"Accountability","href":"/reporting/accountability"},{"icon":"gauge-high","sidebarTitle":"Operations and platform","title":"Operations and platform","href":"/reporting/operations-platform"}]},{"group":"Workspace setup","expanded":false,"pages":[{"icon":"building","sidebarTitle":"Set up your company","title":"Set up your company","href":"/setup/onboarding"},{"icon":"list-check","sidebarTitle":"Setup checklist","title":"Setup checklist","href":"/setup/checklist"},{"icon":"tags","sidebarTitle":"Set up your pricing","title":"Set up your pricing","href":"/setup/pricing"},{"icon":"users","sidebarTitle":"Invite your team","title":"Team and access","href":"/setup/team"},{"icon":"shield-halved","sidebarTitle":"Roles and permissions","title":"Roles and permissions","href":"/setup/roles"},{"title":"Sales availability","sidebarTitle":"Sales availability","icon":"calendar-check","href":"/setup/sales-availability"},{"icon":"building-columns","sidebarTitle":"Pay for calls and SMS","title":"Pay for calls and SMS","href":"/setup/payto"},{"icon":"credit-card","sidebarTitle":"Billing and plan","title":"Billing and your plan","href":"/setup/billing"},{"sidebarTitle":"Find the right settings","title":"Find the right settings","href":"/setup/settings-screens"},{"icon":"sliders","sidebarTitle":"Retailer Settings","title":"Retailer Settings","href":"/setup/retailer-settings"},{"sidebarTitle":"Selling brands","title":"Selling brands","href":"/setup/selling-brands"},{"sidebarTitle":"Branding","title":"Branding","href":"/setup/branding"},{"sidebarTitle":"Brand prices","title":"Brand prices","href":"/setup/price-books"},{"sidebarTitle":"Customer agreements","title":"Customer agreements","href":"/setup/selling-contract"},{"icon":"bell","sidebarTitle":"Notifications","title":"Notifications","href":"/setup/notifications"},{"icon":"user-gear","sidebarTitle":"Switch or delete your account","title":"Switch organisations or delete your account","href":"/setup/your-account"}]},{"group":"Integrations","expanded":false,"pages":[{"icon":"plug","sidebarTitle":"Integrations","title":"Integrations","href":"/integrations/overview"},{"icon":"credit-card","sidebarTitle":"Stripe payments","title":"Stripe payments","href":"/integrations/stripe"},{"icon":"table","sidebarTitle":"Google Sheets","title":"Google Sheets","href":"/integrations/google-sheets"},{"icon":"arrows-rotate","sidebarTitle":"Meta lead sync","title":"Meta lead sync","href":"/integrations/meta"},{"icon":"leaf","sidebarTitle":"GreenDeal","title":"GreenDeal","href":"/integrations/greendeal"},{"icon":"file-circle-check","sidebarTitle":"Formbay","title":"Formbay","href":"/integrations/formbay"},{"icon":"screwdriver-wrench","sidebarTitle":"ServiceM8","title":"ServiceM8","href":"/integrations/servicem8"}]},{"group":"AI apps","pages":[{"title":"Use ArcSolar in AI apps","sidebarTitle":"Overview","icon":"bot","href":"/ai-apps/overview"},{"title":"Connect an AI app","sidebarTitle":"Connect an AI app","icon":"plug","href":"/ai-apps/connect"},{"title":"AI apps: manage and troubleshoot","sidebarTitle":"Manage and get help","icon":"life-buoy","href":"/ai-apps/help"}]},{"group":"Sales onboarding","expanded":false,"pages":[{"title":"Sales onboarding","sidebarTitle":"Sales onboarding","icon":"graduation-cap","href":"/sales-onboarding"},{"title":"1. Get set up","sidebarTitle":"1 · Get set up","icon":"compass","href":"/sales-onboarding/workspace"},{"title":"2. Find your customer","sidebarTitle":"2 · Find your customer","icon":"address-book","href":"/sales-onboarding/customer"},{"title":"3. Call and follow up","sidebarTitle":"3 · Call and follow up","icon":"phone","href":"/sales-onboarding/conversation"},{"title":"4. Understand the home","sidebarTitle":"4 · Understand the home","icon":"house","href":"/sales-onboarding/assessment"},{"title":"5. Build a quote","sidebarTitle":"5 · Build a quote","icon":"file-invoice-dollar","href":"/sales-onboarding/quote"},{"title":"6. Follow through","sidebarTitle":"6 · Follow through","icon":"route","href":"/sales-onboarding/follow-through"},{"title":"7. Your first customer","sidebarTitle":"7 · Your first customer","icon":"flag-checkered","href":"/sales-onboarding/ready"}]},{"group":"Help and reference","expanded":false,"pages":[{"icon":"life-ring","sidebarTitle":"Support","title":"Get help from ArcSolar","href":"/reference/support"},{"icon":"circle-play","sidebarTitle":"Training videos (SOPs)","title":"Training videos (SOPs)","href":"/reference/training-videos"},{"icon":"circle-info","sidebarTitle":"Feature availability","title":"Feature availability","href":"/reference/availability"},{"icon":"book-open","sidebarTitle":"Glossary","title":"Glossary","href":"/reference/glossary"},{"sidebarTitle":"Selling brands FAQ","title":"Selling brands and settings: troubleshooting","description":"Answers to common questions and messages when you sell under more than one brand.","href":"/reference/selling-brands-faq"},{"title":"Roof Vision integration contract","sidebarTitle":"Roof Vision contract","icon":"file-shield","href":"/reference/roof-design-contract"},{"title":"What's new in ArcSolar","sidebarTitle":"What's new","description":"The biggest recent changes in ArcSolar, in one page. The changelog has every release.","icon":"newspaper","href":"/reference/whats-new"},{"title":"Changelog","icon":"clock-rotate-left","href":"/changelog"}]}]}]},"basePath":"","title":"Roof Vision integration contract - ArcSolar Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}