Sales API
4 PracBill API endpoints for sales. Base URL https://billing.pracbill.com.au/api.
Process external sales from e-commerce platforms (creates customer, invoice, items, and payments)
POST /{api_key}/externalsales/add
Request body
| Field | Type | Description |
|---|---|---|
id | string | External system sale/order ID |
order_number | string | Order number |
cid | integer | Existing customer ID (if known) |
company | string | Company name (for customer matching/creation) |
name | string | Customer first name |
surname | string | Customer last name |
email | string | Customer email |
phone | string | Customer phone |
timestamp | integer | Unix timestamp of sale |
date | string | Sale date/time |
shipping_address | object | Shipping address details |
billing_address | object | Billing address details |
inc_tax_shipping | number | Shipping amount including tax |
ex_tax_shipping | number | Shipping amount excluding tax |
discount | number | Discount percentage |
products | array of object | Array of products/items sold |
payments | object | Payment details keyed by payment method |
vouchers | array of object | Vouchers applied to sale |
void | boolean | Whether sale is void |
Responses
200— Sale processed successfully
POST /{api_key}/orders/add
POST /{api_key}/orders/add
Request body
| Field | Type | Description |
|---|---|---|
id | integer | |
cid | integer | |
company | string | |
order_type | string | |
service_type | string | |
date_ordered | string | |
date_expected | string | |
status | string |
Responses
200— Successful request
POST /{api_key}/services/qualify
POST /{api_key}/services/qualify
Parameters
| Name | In | Type | Description |
|---|---|---|---|
address required | query | string | |
avcid | query | string | AVC ID for transfer verification. When provided, the response will include avc_match, avc_target, and avc_current_epid fields. |
service_type | query | string | Service type for qualification (e.g. FTTP, HFC, FTTC). Used with avcid to qualify for Primary or Original Technology. |
Responses
200— The qualification response
POST /{api_key}/services/qualify/ndf
POST /{api_key}/services/qualify/ndf
Parameters
| Name | In | Type | Description |
|---|---|---|---|
address required | query | string |
Responses
200— The qualification response