Organisation
Organisations are hierarchically organized via parent/child relation with a relation type.
The API provides:
- CRUD operations via
POST
,GET
,PATCH
andDELETE
actions - services for managing organisation hierarchy
- services for managing contacts
- access points for lookup values:
- organisation status
- organisation type
- organisation relation type
- organisation verification type
- contact type
Below is a sample organisation in its JSON representation.
{
"id": 12,
"name": "Tele17",
"ext_reference": "",
"class":{
"id": 0,
"description": "Commercial"
},
"type": {
"id": 1,
"description": "Provider"
},
"country": {
"id": 74,
"name": "Germany",
"mcc": "262",
"country_code": "49",
"isocode": "de"
},
"status": {
"id": 1,
"description": "Suspended"
},
"relation": {
"id": 17,
"type": {
"id": 0,
"description": "Customer of"
}
},
"monthly_cost_limit": 1000,
"currency": {
"id": 1,
"code": "EUR",
"symbol": "€"
},
"created": "2015-02-03T00:00:00.000+0000",
"verification_type": {
"id": 1,
"description": "Business registration number"
},
"verification": "123456789"
}
Organisation Object
The organisation object has the following properties:
Name | Type | Description |
---|---|---|
id | Integer | Unique ID of this organisation |
name | String | Name of organisation |
class | Object | id (Integer) - ID of the class of this organisationdescription (String) - Description of the class |
type | Object | id (Integer) - ID of the type of this organisationdescription (String) - Description of meaning of the type |
country | Object | id (Integer) - ID of the country of this organisationname (String) - Country namemcc (String) - mobile country codecountry_code (String) - isocode (String) - ISO 3166-1 alpha-2 |
status | Object | id (Integer) - ID of status this organisationdescription (String) - Description of meaning of the status |
relation | Object | id (Integer) - ID of the relationtype (Object) type of the relation description (String) - Description of meaning of the type idid (integer) ID of the relation type |
ext_reference | String | Additional information (e.g. customer id) |
monthly_cost_limit | Integer | Amount of spend money when organisation will be blocked |
currency | Object | id (Integer) - ID of the currencycode (String) - Name of the currencysymbol (String) - Symbol of the currency |
created | Timestamp | Timestamp when this organisation was created - Type: ISO 8601 timestamp format |
verification_type | Object | id (Integer) - ID of this verification typedescription (String) - Description of the verification type |
verification | String | verification data |