Dataset: Utility Billing Records

Dataset name: ds_utility_billing

Description

Utility billing

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Utility Billing ID	id	The primary identifier for this record.	number	5
Utility Billing Instance	instance	The instance this transaction relates to.	number	8
Utility Billing Source	source	The source of the data - user or connection.	text
Utility Transactions Billing Period End	utility_billing_end	The end of the billing period	date
Utility Transactions Billing Period Start	utility_billing_start	The start of the billing period	date
Utility Transactions Cost	utility_billing_total	The cost of the transaction/ call	currency	122.22
Currency Code	utility_billing_total_currency_code	Currency code for the transaction	text	GBP

---

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/transaction/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_utility_billing
  &instance=N

Replace the following with your own details: UID KEY, API_KEY, CON_ID and instance N.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows.

{
  "5": {
    "id": "5",
    "ds_id": "5",
    "utility_billing_end": null,
    "utility_billing_start": null,
    "utility_billing_total": "122.22",
    "utility_billing_total_currency_code": "GBP"
  }
}