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:

{
  "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"
}

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