Description
This function gives you details and numbers of one or more profiles that you have access to.
URL
/profiles/index[/PID]
Parameters
| Key | Description |
|---|---|
| PID | Optional parameter. Profile ID (also known as customer number). |
Return
This function returns a JSON string in the form of{"return":{"code":XXX,"message":"...","data":[profile1,profile2,...]}}code is a HTTP status code and message is a descriptive text about the returned code.
If code is 200, there’ll be a key called data in the return which is a JSON encoded array of records which themselves are arrays with these keys:
| Key | Description |
|---|---|
| id | Profile ID. |
| firstname | |
| lastname | |
| company | |
| tag | A customisable tag for billing purposes. |
| The company’s billing email address. There may be more than one, they are seperated by comma or semi-colon. | |
| vatnumber | The company’s VAT number. |
| vatrate | The VAT rate in %. |
| address | The company’s billing address. |
| zip | The company’s billing postal code. |
| city | The company’s billing city. |
| country | The company’s billing country. |
| paymethod | The method with which the profile is paying. These values are possible:prepaid: the profile is making prepayments.invoice: the profile is making bank transfers.sepa: the profile has signed a direct debit mandate.credit card: the profile has registered a credit card to be charged. |
| credit | The profile’s prepaid credit balance in €. |
| status | The profile’s status. |
| closedate | The date on which the profile was or will be closed. |
| fixnumbers | A JSON encoded array of the profile’s fix phone numbers. |
| mobilenumbers | A JSON encoded array of the profile’s MIXmobile phone numbers. This array has 2 keys:number: the mobile phone number.name: a customisable name for your convenience (e.g. for identifying purposes). |