You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 7
Next »
Name | Type | Description |
|---|
| default_system_language | String | The default system language of the organisation |
| maximum_file_size | Number | The maximum size of files which are allowed to be uploaded (in KB) |
| allowed_file_types | String | The type of files which are allowed to be uploaded |
| default_country | Country Object | The default country of the organisation |
| default_currency | Currency Object | The default currency of the organisation |
| time_zone | Timezone Object | The timezone of the organisation |
contact_information | Contact Information Object | The contact information related with the organisation |
| supported_languages_set | Set of Language Objects | The languages that are supported by the organisation |
| supported_countries_set | Set of Country Objects | The countries that are supported by the organisation |
Referred Objects Response Data
contact_information object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
| company_name | Sting | The company name of the retrieved contact information |
demographics | Demographics Object | The demographics information of the retrieved contact information |
company_profile | Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
demographics object response data
Name | Type | Description |
| gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
| id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information |
passport_number | String | The passport number of the retrieved contact information |
| passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information |
social_security_number | String | The social security number of the retrieved contact information |
date_of_birth | Date of Birth Object | The date of birth of the retrieved contact information |
name_day | Name Day Object | The name day of the retrieved contact information |
country_of_residence | Country Object | The country of residence of the retrieved contact information |
id_issued_by_country | Country Object | The ID issued country of retrieved contact information |
passport_issued_by_country | Country Object | The passport issued country of retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
date_of_birth object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
name_day object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
company profile object response data
Name | Type | Description |
| profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
| number_of_employees | Number | The number of employees of the retrieved contact information |
| registration_number | String | The registration number of the retrieved contact information |
| vat_registration_number | String | The vat registration number of the retrieved contact information |
| vat_registered_by | String | The vat registration by of the retrieved contact information |
| vat_registration_date | Date | The vat registration date of the retrieved contact information |
| tax_reference_number | String | The tax referenece number of the retrieved contact information |
registered_in_country | Country Object | The country of residence of the retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
currency object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
timezone object response data
Name | Type | Description |
|---|
| region | String | The region that is represented by the selected timezone |
| utc_offset_in_minutes | Integer | The selected timezone offset in relation to UTC in minutes |
lanugage object response data
Name | Type | Description |
|---|
| language | String | The language supported by the organisation |