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 POST
Access level VIEWER
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.

Billing customer object (JSON)
id ObjectID 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":"5ad4bq6f75a18a020aaa40f7",
      "name":"Hansens Byggemarked Kastrup",
      "phoneNumber":"40804080",
      "faxNumber":"40803080",
      "emailAddress":"kastrup@hbyg.dk",
      "finance":{
         "vatNumber":"1111111111"
       },
       "isReseller":false,
       "address":"Kastrupvej 4, 2770 Kastrup, DK"
    },
    {  
       "_id":"5dc3e65c346e1b45423df488",
       "name":"Hansens Byggemarked Aalborg",
       "phoneNumber":"40804081",
       "faxNumber":"40803081",
       "emailAddress":"aalborg@hbyg.dk",
       "finance":{
          "vatNumber":"1111111111"
        },
        "isReseller":false,
        "address":"Aalborgvej 291, 2770 Kastrup, DK"
     }
]

Errors

Error code Message Description
404 customer Customer not found
api/customer/billing-customer-list.txt · Last modified: 2021/04/08 11:31 by Joakim Andersen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki