Register customers, properties and accounts
Create the holder, the property that receives water and the account that ties them together in the dashboard, and know when to switch to the API for large loads.
Updated on
Every water contract rests on three records: the customer (the holder), the property (the place supplied) and the account, which ties a customer to one of their properties and carries the meter, readings and invoices. The Owner, Administrator and Customer service roles can create all three.
Before you start#
- A utility account in the dashboard. You can register customers before activation, but invoices are only issued once your utility account has been activated.
- If you want to set a service area on the property, the service areas must already exist.
- The holder's details: name or business name and, where available, tax number, phone and email.
Step 1: Register the customer#
- In the sidebar, open Customers and click New customer.
- Fill in Name or business name. It is the only required field.
- Pick the Category (Residential, Commercial, Industrial, Institutional or Government) and the Type (Individual or Business).
- Add the Tax number, Phone and Email if you have them. The holder will later use that phone number to link the account in the customer portal.
- Click Save.
Step 2: Register the property#
- In the sidebar, open Properties, then Properties in its submenu.
- Click New property.
- Under Holder, choose the customer from step 1, then enter the Address. These are the only two required fields.
- Add whatever else you know: Property type, Service area, Cadastral code, Neighbourhood, City, Province.
- Click Save.
Step 3: Open the account#
- In the sidebar, open Accounts and click New account.
- Under Holder, choose the customer; under Property, choose one of that customer's properties.
- Click Open account.
What happens next#
The customer is listed with the status Active and the message "Customer registered". The property is tied to its holder, and the account opens as Active with a number taken from your utility's gap-free series. On the account page, the New meter button registers the meter for that site. To load hundreds of records in one go, use the business API instead: the developer guide shows how to create customers, properties and accounts from a script and retry safely if a call fails.
Common problems#
- You do not see New customer: your role cannot create customers. Ask an Administrator to give you Customer service or another role with that permission.
- You see Could not register the customer: the request was refused, usually because the name was left empty. Check Name or business name and try again.
- New account shows This customer has no properties: an account links a customer to a property they already hold. Register the property first, with that customer as Holder.
- The Service area list is empty: your utility has no service areas yet. The field is optional, so you can save the property without one.