Customers API - Solar Proof Documentation

Overview

The Customers API allows you to manage all aspects of your customer records. You can create new customers, retrieve customer details, update existing information, and remove customers from your account.

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

The Customer Object

A customer object contains all the information about a customer in your Solar Proof account.

Customer Object JSON

{
  "pkcustomerid": 123,
  "customerfirstname": "John",
  "customersurname": "Doe",
  "customeremail": "john.doe@example.com",
  "customerphone1": "0412345678",
  "customerphone2": "0487654321",
  "customercompanyname": "ABC Solar Solutions",
  "customercompanyphone": "0298765432",
  "customerabn": "12345678901",
  "fkcustomerstatusid": 2,
  "fkcustomertypeid": 1,
  "customergstregistered": 1,
  "created_at": "2025-01-15",
  "customer_site_address": "123 Main Street, Sydney NSW 2000",
  "best_contact_times": {
    "mornings": 1,
    "middays": 1,
    "afternoons": 0,
    "evenings": 1
  }
}

Attributes

Attribute	Type	Description
`pkcustomerid`	integer	Unique identifier for the customer
`customerfirstname`	string	Customer's first name
`customersurname`	string	Customer's last name
`customeremail`	string	Customer's email address
`customerphone1`	string	Primary phone number
`customerphone2`	string	Secondary phone number (optional)
`customercompanyname`	string	Company name (for commercial customers)
`customercompanyphone`	string	Company phone number
`customerabn`	string	Australian Business Number
`fkcustomerstatusid`	integer	Customer status: 1 (New Contacts), 2 (Signed), 3 (Mega Status)
`fkcustomertypeid`	integer	Customer type: 1 (Residential), 2 (Commercial), 3 (Large-Scale)
`customergstregistered`	boolean	Whether customer is GST registered (1 = Yes, 0 = No)
`created_at`	date	Date the customer was created (YYYY-MM-DD)
`customer_site_address`	string	Customer's site address
`best_contact_times`	object	Preferred contact times (1 = available, 0 = not available)