Projects API - Solar Proof Documentation

Overview

The Projects API allows you to interact with customer quotations and proposals in your Solar Proof account. Projects contain detailed information about solar installations, pricing, system specifications, and proposal status.

Base URL: https://solarproof.com.au/api/

Note: In the Solar Proof database, projects are stored as "quotations" (table: tblcustomerquotation). The API refers to them as "projects" for clarity.

The Project Object

A project object contains detailed information about a customer quotation/proposal in your Solar Proof account.

Project Object JSON

{
  "pkcustomerquotationid": 456,
  "fkcustomerid": 123,
  "fkuserid": 789,
  "quotenickname": "Solar Installation Q1 2025",
  "siteaddress": "123 Main Street, Sydney NSW 2000",
  "is_draft": 0,
  "proposal_status": "sent",
  "created_at": "2025-01-15",
  "updated_at": "2025-01-20",
  "total_price": 15750.00,
  "system_size": 6.6
}

Attributes

Attribute	Type	Description
`pkcustomerquotationid`	integer	Unique identifier for the project/quotation
`fkcustomerid`	integer	ID of the customer this project belongs to
`fkuserid`	integer	ID of the user who created this project
`quotenickname`	string	Display name/nickname for the project
`siteaddress`	string	Installation site address
`is_draft`	boolean	Whether the project is a draft (1) or published (0)
`proposal_status`	string	Current status: draft, sent, viewed, signed, etc.
`created_at`	datetime	Date and time the project was created
`updated_at`	datetime	Date and time of last update
`total_price`	decimal	Total price of the solar installation
`system_size`	decimal	Solar system size in kilowatts (kW)

Note: Additional fields may be returned depending on the project configuration, including panel specifications, inverter details, rebate information, and more.