User Tools

Site Tools


api:customer:billing-customer-list

API : Billing Customer List

Introduction

This request will list the billing customers for a given customer

Request

URL https://api.telecomx.dk/customer/CUSTOMER_ID/billingcustomer
Method GET
Access level VIEWER, MANAGER or OWNER if user belongs to the customer.
RESELLER if customer belongs to the reseller or a sub reseller.
RESELLER_ADMIN.
ADMIN.
Param CUSTOMER_ID Id of the customer (24 hex-char string)

Query examples

https://api.telecomx.dk/customer/1234567890ABCDEF12345678/billingcustomer

Response

An array of objects each as described below. If the customer does not exist or has no billing customers, an empty array is returned.

Billing customer object (JSON)
_id Id Customer id of billing customer
name String Customer name
phoneNumber String Primary customer phone number
faxNumber String primary customer fax number
emailAddress String Primary e-mail address
isReseller Boolean True if customer is a reseller who can create and manage other customers
address String Primary address including street name, postal code, and city.
Financial settings
finance.vatNumber String VAT number

Note that properties holding no value may be omitted from the object.

[
  {
    "_id": "650000000000000000000801",
    "name": "Example Company East",
    "phoneNumber": "+4540804080",
    "faxNumber": "",
    "emailAddress": "east@example.dk",
    "finance": { "vatNumber": "12345678" },
    "isReseller": false,
    "address": "Eksempelvej 4, 2770 Kastrup, DK"
  },
  {
    "_id": "650000000000000000000802",
    "name": "Example Company North",
    "phoneNumber": "+4540804081",
    "faxNumber": "",
    "emailAddress": "north@example.dk",
    "finance": { "vatNumber": "12345678" },
    "isReseller": false,
    "address": "Eksempelvej 291, 9000 Aalborg, DK"
  }
]

Errors

Error code Message Description
422 customer Customer id is invalid
403 access_denied Insufficient access level
500 internal_error <Unspecified>
api/customer/billing-customer-list.txt · Last modified: by Mikkel Meerwaldt Jørgensen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki