PracBill API reference

161 endpoints across 21 areas of the platform. Create and update customers, raise invoices, run bill runs, ingest CDRs, manage services and provisioning, and drive the helpdesk — all from your own systems.

Base URL

https://billing.pracbill.com.au/api

Version

4.3.0

Authentication

Your API key, passed as the {api_key} path segment.

Availability

API access is included on the Pro and Enterprise plans. See pricing.

Endpoint groups

• Authentication 3 endpoints

  GET /get-key/{user}/{pass} · POST /password-reset/confirm · POST /password-reset/request

• Billruns 8 endpoints

  GET /{api_key}/billruns · POST /{api_key}/billruns · GET /{api_key}/billruns/{id}

• Calendar 3 endpoints

  GET /{api_key}/calendar/getCalendar/{uid} · GET /{api_key}/calendar/getEvents/{uid} · GET /{api_key}/calendar/getEventsUrl/{uid}

• Call Management 14 endpoints

  GET /{api_key}/callRates/get/page/{page_number} · GET /{api_key}/callRates/get/{id} · POST /{api_key}/callRates/post

• Cdr 9 endpoints

  GET /{api_key}/callType/get/page/{page_number} · GET /{api_key}/callType/get/{id} · POST /{api_key}/cdr/add

• Customer Bulk Email 6 endpoints

  POST /{api_key}/customer/bulk-email · GET /{api_key}/customer/bulk-email/filters · GET /{api_key}/customer/bulk-email/page/{pageNumber}

• Customer Contacts 7 endpoints

  POST /{api_key}/customer/contact/add/{cid} · GET /{api_key}/customer/contact/get/{cid} · GET /{api_key}/customer/{cid}/contact/{contact_id}

• Customers 22 endpoints

  POST /{api_key}/customer/add · POST /{api_key}/customer/authenticate/ · GET /{api_key}/customer/balance/{cid}

• Helpdesk 20 endpoints

  GET /{api_key}/helpdesk/customer/{cid}/tickets · GET /{api_key}/helpdesk/note/{noteid} · POST /{api_key}/helpdesk/note/{noteid}/delete

• Invoices 12 endpoints

  GET /{api_key}/invoice/get · POST /{api_key}/invoice/get · GET /{api_key}/invoice/get/csv/usage/{iid}

• Leads 5 endpoints

  POST /{api_key}/leads/add · POST /{api_key}/leads/filter/get/page/{page_number} · GET /{api_key}/leads/get/page/{page_number}

• Orders 5 endpoints

  GET /{api_key}/orders/get · GET /{api_key}/orders/get/page/{page_number} · GET /{api_key}/orders/get/{id}

• Payment Methods 6 endpoints

  GET /{api_key}/customer/paymentMethods/{id} · POST /{api_key}/customer/paymentMethods/{id}/nickname · POST /{api_key}/customer/paymentMethods/{id}/status

• Price Books 3 endpoints

  GET /{api_key}/priceBooks/get/page/{page_number} · GET /{api_key}/priceBooks/get/{id} · POST /{api_key}/priceBooks/post

• Products 4 endpoints

  GET /{api_key}/products/category/{catid} · GET /{api_key}/products/category/{catid}/page/{page_number} · GET /{api_key}/products/get/{pid}

• Reporting 1 endpoints

  POST /{api_key}/report

• Sales 4 endpoints

  POST /{api_key}/externalsales/add · POST /{api_key}/orders/add · POST /{api_key}/services/qualify

• Service Bundles 2 endpoints

  GET /{api_key}/serviceBundles/get/{id} · GET /{api_key}/serviceBundles/getByCustomer/{cid}

• Service Types 7 endpoints

  POST /{api_key}/serviceType/add · DELETE /{api_key}/serviceType/delete/{esid} · POST /{api_key}/serviceType/filter/get

• Services 18 endpoints

  GET /{api_key}/customer/{cid}/service-sites · POST /{api_key}/engineering/add · GET /{api_key}/engineering/get/{enid}

• Timeline 2 endpoints

  GET /{api_key}/timeline/{module}/{id} · POST /{api_key}/timeline/{module}/{id}

Prefer to try requests interactively? The Swagger console runs against the same specification, and the raw OpenAPI document is public.