Retrieves the company contact with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
Company of the contact |
globally unique identifier |
Optionally required : company_id,company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating contact |
string |
Optionally required : company_id,company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating contact |
company |
Optionally required : company_id,company_code or company must be provided |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating contact |
string | |
| db_title_id |
The title of the contact |
globally unique identifier | |
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| e_login |
Login of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| e_password |
Password in clear text of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| notes |
Notes/Remark field |
string | |
| birthdate |
Birthday date |
date | |
| create_date |
Creation date+time |
date | |
| phone |
Phone number of the contact |
string |
Max length: 50 |
| mobile |
a number of the contact |
string |
Max length: 50 |
|
|
string |
Max length: 250 |
|
| skype |
skype |
string |
Max length: 250 |
| private_phone |
Private phone number of the contact |
string |
Max length: 50 |
| private_mobile |
Private mobile number of the contact |
string |
Max length: 50 |
| private_email |
Private email |
string |
Max length: 250 |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "3a44b4af-c961-40be-a316-71c87f4b40cd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fdceb92d-e314-4a00-af50-2754ae401463",
"company_code": "sample string 5",
"company": {
"id": "cb12d600-301b-4751-b8ed-95961beca276",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-25T12:45:55.6603681+00:00",
"sales_territory_id": "f441e35e-48ef-47fd-bea3-ee2dc17b5cc1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b7626622-d5a3-4f29-8ea9-26b6ba3cf643",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "846f7987-157f-43e9-b8a3-a47ce0586d3d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c235e686-46e3-42f1-878f-dd9f2e323103",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d66276ff-23f4-4813-b711-a00148b14325",
"db_currency_id": "b44e803f-6df3-44b7-a745-8917ee899809",
"db_language_id": "603139ba-d850-43fb-9c3c-af1fb55f50d4",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-06-25T12:45:55.6603681+00:00"
},
"modified_dateutc": "2025-06-25T12:45:55.6603681+00:00"
},
"marketing_segment_id": "b4d3533a-757e-4fde-bd1d-31eaaedf73cc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ec3586ff-da14-4340-8d0e-297f2f09aecf",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "2456ed33-f524-4ba6-97c5-8726d4fff37f",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "901806e3-8eef-4a14-abd6-435ef09c0524",
"db_country_code": "sample string 28",
"feelist_id": "93a2851a-585f-4e60-bebb-d067cf75ad43",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "75c991a1-4904-4a38-9101-d7b9336a8cfc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "21ade46f-77c8-4abd-913f-7e85ebacfacd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-25T12:45:55.6603681+00:00",
"db_currency_id": "99baef4a-4be8-4213-96d6-a8e058af15da",
"db_currency_code": "sample string 10"
},
"company_type_id": "b435ada8-90bb-4409-8044-6aa5bdf53c5b",
"company_type_name": "sample string 32",
"company_type": {
"id": "049f6504-d917-4850-b5c2-8decf5365644",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fa2a2829-38ac-4892-bc7c-cd0fba676601",
"sales_organization_code": "sample string 5"
},
"db_language_id": "02436f2f-4d80-4550-8335-d20dfd4f2161",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0cce725c-4b51-4225-84c8-d6b46b809ef6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "37ca528f-14d2-4166-a354-2debe349ea64",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9f70dccd-7fb1-4514-97ac-74056dc48acf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-25T12:45:55.6603681+00:00"
},
"company_sector_id": "a10d353e-e3f5-4041-8884-d1e1766bf855",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "bb83a794-48a2-4052-bb67-47a0e8645425",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "991c6f38-79ad-4132-8298-3d2ff68c455c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8c6bedb6-11a0-49fd-9f9e-0f6ae98af104",
"account_manager_user_code": "sample string 56",
"company_status_id": "11651da3-8159-40b2-8c6c-427a181f30f4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-25T12:45:55.6603681+00:00",
"id2": 60
},
"db_language_id": "4673d757-7b58-4cf9-b4b5-3b9340ceaa59",
"db_language_code": "sample string 7",
"db_title_id": "90550b84-dcb6-4a5f-bbb8-01e2f3922846",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-25T12:45:55.6603681+00:00",
"create_date": "2025-06-25T12:45:55.6603681+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2025-06-25T12:45:55.6603681+00:00"
}