Reference

Organization

Organizations are hierarchically organized via parent/child relation with a relation type.

The API provides:

  • CRUD operations via POST, GET, PATCH and DELETE actions
  • services for managing organization hierarchy
  • services for managing contacts
  • access points for lookup values:
    • organization status
    • organization type
    • organization relation type
    • organization verification type
    • contact type

The following is a sample organization in its JSON representation:

1{
2  "id": 12,
3  "name": "Tele17",
4  "ext_reference": "",
5  "class":{
6    "id": 0,
7    "description": "Commercial"
8  },
9  "type": {
10    "id": 1,
11    "description": "Provider"
12  },
13  "country": {
14    "id": 74,
15    "name": "Germany",
16    "mcc": "262",
17    "country_code": "49",
18    "isocode": "de"
19  },
20  "status": {
21    "id": 1,
22    "description": "Suspended"
23  },
24  "relation": {
25    "id": 17,
26    "type": {
27      "id": 0,
28      "description": "Customer of"
29    }
30  },
31  "monthly_cost_limit": 1000,
32  "currency": {
33    "id": 1,
34    "code": "EUR",
35    "symbol": "€"
36  },
37  "created": "2015-02-03T00:00:00.000+0000",
38  "verification_type": {
39    "id": 1,
40    "description": "Business registration number"
41  },
42  "verification": "123456789"
43}

Organization object

The organization object has the following properties:

NameTypeDescription
idIntegerUnique ID of this organization
nameStringName of organization
classObjectid (Integer) - ID of the class of this organization
description (String) - Description of the class
typeObjectid (Integer) - ID of the type of this organization
description (String) - Description of meaning of the type
countryObjectid (Integer) - ID of the country of this organization
name (String) - Country name
mcc (String) - mobile country code
country_code (String) -
isocode (String) - ISO 3166-1 alpha-2
statusObjectid (Integer) - ID of status this organization
description (String) - Description of meaning of the status
relationObjectid (Integer) - ID of the relation
type (Object) type of the relation
description (String) - Description of meaning of the type id
id (integer) ID of the relation type
ext_referenceStringAdditional information (for example, customer ID)
monthly_cost_limitIntegerAmount of spend money when the organization is blocked
currencyObjectid (Integer) - ID of the currency
code (String) - Name of the currency
symbol(String) - Symbol of the currency
createdTimestampTimestamp when this organization was created - Type: ISO 8601 timestamp format
verification_typeObjectid (Integer) - ID of this verification type
description (String) - Description of the verification type
verificationStringverification data