Billing API

Auspace provides a billing REST API to access the individual Device and Tenant charges on an invoice. The API allows customers to integrate their own corporate billing applications for consuming the various charges. The API is hosted on the secure GAP platform. Access to the API is limited to specified GAP administrators and dedicated billing accounts.

It is envisaged that the API will be accessed via a customer billing application, allowing fully automated consumption of the charges. However, the API can be accessed via a web browser if manual consumption is required.

The billing endpoint URL follows the template below:

https://services-gap-<platform>-1.globalalerting.com/auspace/v1/<tenant code>/billing/get/<purchase order number>/<billing date YYYY_MM>

where:

• <platform> is either us or au, depending on your GAP platform.
• <tenant code> is your 4-digit customer tenant code, found in GAP "Options" > "Tenants".
• <purchase order number> is your customer PO number found on your invoice (e.g. P123456789).
• <billing date YYYY_MM> is the date of the billing cycle (e.g. 2017_07).

Example

For a manual example, follow the instructions below. The billing data has been anonymised and is for demonstration purposes only.

1. Open a web browser (Auspace suggests FireFox) and navigate to: https://services-gap-au-1.globalalerting.com/auspace/v1/4837/billing/get/P123456789/2017_07
2. Login using the credentials:
   Username: example@auspace.com.au
   Password: AXL5adkm

By default, the billing data is displayed in json format. The csv format is also available, by appending ?format=csv to the URL template above.