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": "6410918b-b667-4781-9db1-fefc0e376cd8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b0073005-879a-4199-94a9-77b6205baf4a",
"company_code": "sample string 5",
"company": {
"id": "64eeedcb-b8cd-42a5-a6f9-ab04660fe677",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-18T02:23:28.8565147+00:00",
"sales_territory_id": "3bc99d56-eaef-4872-9208-53b130da1a1a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ff0f0fdd-d58b-420a-9db3-90569aef736d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d85b6058-87a6-4f9a-ab23-b9f3f5642e99",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "33c88c5e-a65d-4915-8f4d-be9748e90156",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28f3b403-3a13-4bec-8c8c-700fe74861b3",
"db_currency_id": "5df8c306-bc21-4d75-bc29-1d3cb824db40",
"db_language_id": "c657a335-8ea0-4390-bc60-cde24b70ac6f",
"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-05-18T02:23:28.8565147+00:00"
},
"modified_dateutc": "2025-05-18T02:23:28.8565147+00:00"
},
"marketing_segment_id": "cdeb6b8a-6d17-4865-999d-bf4585496732",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7d0077c5-8efe-4096-8b2a-9cf8cd3eac2a",
"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": "9dcbc0e9-1277-4e0d-9255-773ece64575d",
"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": "e7a28569-6bc6-4e71-be2b-6a82abc17d7d",
"db_country_code": "sample string 28",
"feelist_id": "89e7cecb-b792-4bee-89e6-57bacd4a2b11",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "572182a2-6f34-440c-b3a6-944317de4b16",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "98db4ebe-3ac3-482b-943e-1d053a015978",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-18T02:23:28.8565147+00:00",
"db_currency_id": "4efc51e6-ec34-4e33-b0d4-ee5a290fdb09",
"db_currency_code": "sample string 10"
},
"company_type_id": "59139de9-0945-46b2-b0e8-93310fdc2955",
"company_type_name": "sample string 32",
"company_type": {
"id": "79207b6b-1edd-4f96-a18a-3ebb1853da4e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9b7c2e2c-5132-4b4e-ab00-1723d220f93f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4c4d934b-da35-4225-a4a6-7ab5be01b00b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e4a1ccbc-7d04-4883-b049-dbf32a202d91",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0624c216-8d08-4707-8d76-720c069074ee",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7ad7958f-ae83-4c12-ad0b-dc8b17bdb377",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-18T02:23:28.8565147+00:00"
},
"company_sector_id": "b31c0854-7aea-49a8-84ea-631ba9963720",
"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": "dec49c01-3049-48c2-9d69-54027f4a17e0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "efdadb48-9be7-4e93-a1a9-d62d598e148e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "79ca6ee8-5f68-4a6b-9bab-4fb26390c327",
"account_manager_user_code": "sample string 56",
"company_status_id": "ac4f73b3-c121-46f1-8fae-a48c9ae4a189",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-18T02:23:28.8565147+00:00",
"id2": 60
},
"db_language_id": "3d76ee04-71b2-4424-a217-5d4aade50263",
"db_language_code": "sample string 7",
"db_title_id": "e0c952a5-37ae-434b-8e84-6a94f7b5de24",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-18T02:23:28.8565147+00:00",
"create_date": "2025-05-18T02:23:28.8565147+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-05-18T02:23:28.8565147+00:00"
}