Service Types API

7 PracBill API endpoints for service types. Base URL https://billing.pracbill.com.au/api.

POST /{api_key}/serviceType/add

Field	Type	Description
`typeofservice` required	string	Name of the service type (required)
`active`	boolean	Whether the service type is active and offered in lists/selectors (defaults to true)
`ratecode`	string	Internal rate code
`list_price`	number	Default ex-tax list price
`cost_price`	number	Ex-tax cost price
`wholesale_price`	number	Wholesale price for resellers
`reseller_price`	number	Reseller price
`invoice_type`	string	Invoice type this service belongs to
`calls_service`	integer (0 \| 1)	Whether this is a call-based service (0 or 1)
`data_service`	integer (0 \| 1)	Whether this is a data service (0 or 1)
`data_unlimited`	integer (0 \| 1)	Whether data is unlimited (0 or 1)
`data_included_mb`	integer	Included data in MB
`helpdesk_display`	integer (0 \| 1)	Display in helpdesk module (0 or 1)
`reporting_category`	string	Category for reporting purposes
`vid`	integer	Vendor/Supplier ID
`vendor_product_id`	string	Vendor's product identifier
`allow_order`	integer (0 \| 1)	Allow ordering through Orders module (0 or 1)
`call_types`	array of integer	Array of call type IDs allowed for this service
`default_call_types`	array of integer	Array of default call type IDs for billing

DELETE /{api_key}/serviceType/delete/{esid}

POST /{api_key}/serviceType/filter/get

Field	Type	Description
`helpdesk_display`	boolean	whether this service type displays in the helpdesk module
`invoice_type`	string	The invoice type that the service type is displaye don
`calls_service`	boolean	If this is a call based service
`sms_postpaid`	boolean	If this is a sms postpaid service
`data_service`	boolean	If this is a data service
`data_unlimited`	boolean	Unlimited Data included?
`data_included_mb`	integer	Number of MB included in the service, for the filter, this is an exact match and has no ability for > or < or any wilcards
`vid`	integer	Vendor or Supplier ID
`vendor_product_id`	string	Vendor's Product ID
`ratecode`	string	The rate code for types
`data_service_technology`	string	What type of data technologies
`data_service_type`	string	what data service types are available
`allow_order`	boolean	If the service is allowed to be ordered through the orders module
`active`	boolean	Filter by active state. Defaults to true (active only) when neither this nor include_inactive is supplied
`include_inactive`	boolean	Set to true to return both active and inactive service types (ignored when `active` is supplied)
`typeofservice`	string	A wildcard search for type of service

POST /{api_key}/serviceType/filter/get/page/{page_number}

Field	Type	Description
`helpdesk_display`	boolean	whether this service type displays in the helpdesk module
`invoice_type`	string	The invoice type that the service type is displaye don
`calls_service`	boolean	If this is a call based service
`sms_postpaid`	boolean	If this is a sms postpaid service
`data_service`	boolean	If this is a data service
`data_unlimited`	boolean	Unlimited Data included?
`data_included_mb`	integer	Number of MB included in the service, for the filter, this is an exact match and has no ability for > or < or any wilcards
`vid`	integer	Vendor or Supplier ID
`vendor_product_id`	string	Vendor's Product ID
`ratecode`	string	The rate code for types
`data_service_technology`	string	What type of data technologies
`data_service_type`	string	what data service types are available
`allow_order`	boolean	If the service is allowed to be ordered through the orders module
`active`	boolean	Filter by active state. Defaults to true (active only) when neither this nor include_inactive is supplied
`include_inactive`	boolean	Set to true to return both active and inactive service types (ignored when `active` is supplied)
`typeofservice`	string	A wildcard search for type of service

GET /{api_key}/serviceType/get/page/{page_number}

GET /{api_key}/serviceType/get/{esid}

POST /{api_key}/serviceType/update/{esid}

Field	Type	Description
`typeofservice`	string	Name of the service type
`active`	boolean	Whether the service type is active and offered in lists/selectors
`ratecode`	string	Internal rate code
`list_price`	number	Default ex-tax list price
`cost_price`	number	Ex-tax cost price
`wholesale_price`	number	Wholesale price for resellers
`reseller_price`	number	Reseller price
`invoice_type`	string	Invoice type this service belongs to
`calls_service`	integer (0 \| 1)	Whether this is a call-based service (0 or 1)
`data_service`	integer (0 \| 1)	Whether this is a data service (0 or 1)
`data_unlimited`	integer (0 \| 1)	Whether data is unlimited (0 or 1)
`data_included_mb`	integer	Included data in MB
`helpdesk_display`	integer (0 \| 1)	Display in helpdesk module (0 or 1)
`reporting_category`	string	Category for reporting purposes
`vid`	integer	Vendor/Supplier ID
`vendor_product_id`	string	Vendor's product identifier
`allow_order`	integer (0 \| 1)	Allow ordering through Orders module (0 or 1)
`call_types`	array of integer	Array of call type IDs allowed for this service
`default_call_types`	array of integer	Array of default call type IDs for billing