API Reference
API Reference
This is the OpenAPI specification for UtilityCloud's API methods made for machine to machine (m2m) use. You can view it in a modern UI, or in good, old Swagger UI.
Tags
Accounting
Retrieve accounting lines by item reference or as a date-range balance report.
Dimensions
Assign and remove dimension values on invoice groups, customers, and products.
Bank Transactions
Search and retrieve bank transaction records.
Debt Collection
Manage debt collection cases, fees, and invoice line imports.
Imports
Upload invoice data files for import processing.
Invoice Groups
Create, retrieve, configure, and manage invoice groups (accounts) and their contacts.
Invoice Lines
Manage invoice lines through their full lifecycle.
Invoices
Access and manage invoices, PDFs, credits, and payment risk.
Payment Agreements
Create, retrieve, update, and delete payment agreements.
PTI
Manage pass-through invoicing (PTI) supplier invoice imports and PDFs.
Grid Owners
Retrieve grid owner records and PTI invoice statistics.
Service Types
List and manage the service types available for a tenant, used to classify metering points and contracts.
Contracts
Manage contracts lifecycle, create, update, and terminate.
Customers
Create, search, retrieve, and update customer records.
Meter Values
Retrieve metered consumption and production values for metering points.
Metering Points
Create, retrieve, update, and search metering points.
Offers
Create, retrieve, replace, and cancel customer offers.
Price Information
Retrieve current and dated electricity price information for metering points, including subsidies.
Price List
Retrieve price lists and their time-indexed price entries.
Price List Entries
Create and update price list entries in bulk.
Product Offerings
Operations related to Product Offerings.
Products
List, search, and retrieve products in full or summary form.
Freshsales
Offer acceptance and opportunity handling via the Freshsales CRM integration.
Ropo
Receive inbound debt-collection callbacks from the Ropo integration.
Unimicro
Receive invoice reminder lines from the Unimicro integration.
Events
Query lifecycle events and receive external provider callbacks.
Webhooks
Reference payload models for outbound webhook events.
Reports
List and download generated report files, and retrieve detailed accounting-line data for reconciliation and ERP integration.
Signing and Consent
Create and manage sign requests, consent orders, text templates, and authorization documents.
doc-product
doc-product-price
Payments
List and monitor payment jobs by status and type.
Security Schemes
bearerAuth
JWT Authorization header using the Bearer scheme.
http