Utilmate API library

Utilmate has a library of API's available for you, so that you can connect Utilmate with your third-party applications.

GET methods available to return information include:

• GETACCREC to get accounts receivable history for a customer.
• GETADJUST to get all adjustments between a selected date range
• GETBUILDINGLIST to get a list of buildings
• GETCUST to get basic customer information for verification purposes
• GETCUSTDET to retrieve customer details for a single customer
• GETINVOICE to get an individual invoice PDF
• GETINVDET to get invoice details for an account or individual invoice
• GETJOURNALS to get the accounting journals for a month.
• GETMETER to get the meter details for a single site
• GETPRICES to retrieve a customers products and tariffs for a single customer
• GETREADS to get all basic or AM meter reads for a customer for a date range
• GETRECEIPT to get all receipts between a selected date range
• GETREPORT to run a report
• GETRPTLIS to retrieve the id's for each available report and the filters available. 
• GETSITELIST to get sites within a building
• GETUSAGE to get all actual or normalised usage for a customer for a date range
• GETLOSS to get loss factor
• GETRANGEINV to get all invoices of date range
• GETALLACCNTPP to get all accounts price plan and rates
• GETALLRPTLIS to list all active reports
• GETACCNTPRICE to get account price plan details
• GETCUSTOMERPRICING to get customer pricing
• GETUTILITYUSAGE to get the utility usage of a customer for the site
• GETINVOICEPDF to get the invoice PDF
• GETSITE to get the site information
• GETWORKORDER to get work order details

POST methods available to update information include:

• POSTACTIVITY to create a new activity or update an existing activity
• POSTCUST to create a new customer or update existing customer details
• POSTCHARGE to add a one-off charge
• POSTMOVEIN to complete the move-in wizard
• POSTMOVEOUT to complete the move-out wizard
• POSTPROVISION to add a Telco or ISP account and up to 5 line items
• POSTRECEIPT to create a receipt for a customer
• POSTSITE to update status of a site within a building
• POSTREAD to add a basic/deemed meter read to a meter
• POSTADJUSTMENT to create an adjustment for a customer account
• UPDATEWORKORDER to update a work order 

To get an access key and certified to connect to Utilmate, please contact the Utilmate support team.

View full technical documentation.