Every feature is an API
Everything you can do in UtilityCloud, you can do through the API. Build your own apps, sales flows and integrations on the same CIS that runs your back office.
# Production
BASE="https://api.utilitycloud.app"
# Test: https://api-stag.utilitycloud.app
curl "$BASE/cm/servicetypes/v2/validationrules" \
-H "Authorization: Bearer $TOKEN"
{
"defaultRules": [
{
"fieldName": "Email",
"pattern": "^[^@\s]+@[^@\s]+$",
"examples": ["name@example.com"]
}
],
"countrySpecificRules": [
{
"countryCode": "NO",
"fieldName": "PhoneNumber",
"pattern": "^\+47[0-9]{8}$",
"examples": ["+4740000000"]
}
],
"serviceTypeSpecificRules": []
}
- Auth
- bearerAuthJWT in the Authorization header
- Spec
- OpenAPIdownload the schema from the developer portal
The whole CIS, one API away
Customers, contracts, metering, billing, payments and collection are all exposed as machine-to-machine APIs, documented in one OpenAPI specification.
Customers & sales
- Customers
- Contracts
- Offers
- Signing and Consent
Products & pricing
- Products
- Product Offerings
- Price List
- Price Information
Metering
- Metering Points
- Meter Values
- Grid Owners
- Service Types
Billing
- Invoices
- Invoice Groups
- Invoice Lines
- Reports
Payments & collection
- Payments
- Bank Transactions
- Payment Agreements
- Debt Collection
Accounting & integrations
- Accounting
- Dimensions
- Imports
- Freshsales
- Ropo
- Unimicro
Your front end. Our engine.
UtilityCloud works as a headless CIS. Keep your own website, apps, customer portal and partner channels, and let UtilityCloud handle customers, contracts, settlement, billing and collection behind them.
- Design the customer experience your brand needs
- Sell through any channel, with one source of truth
- Change the front end without touching billing
Channels
- Website
- Mobile app
- Customer portal
- Partner sales
- CRM
UtilityCloud APIs
- Customers
- Contracts
- Metering
- Billing
- Collection
- Accounting
Events & webhooks
- ERP
- Data warehouse
- Your services
- Invoice group status updateBilling run finished200
- Dunned invoice paymentPayment received on a reminded invoice200
- Dunned invoice creditCredit note applied200
React the moment something happens
Query lifecycle events and receive outbound webhooks when invoices and payments change status, so your own systems stay in sync without polling.
- Invoice group status updates
- Payments and credits on dunned invoices
- Event history per metering point
Start building with the UtilityCloud APIs
The developer portal has the full OpenAPI reference for machine-to-machine use, with every endpoint, schema and webhook model.
- Reference
- OpenAPI specification
- Authentication
- Bearer JWT
- Production
- api.utilitycloud.app
- Test
- api-stag.utilitycloud.app
- Portal
- developer.utilitycloud.app
See UtilityCloud and Wattson in action
Book a 30-minute meeting and we’ll walk you through the platform with your own processes in mind.