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": "867b8a61-83dd-47ae-a596-32b329369047",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "15382430-9e1a-4d4d-9d8c-3325978faa87",
"company_code": "sample string 5",
"company": {
"id": "e1d81b86-9603-42ef-a96a-bb8a6215fbd1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-09T01:33:39.9854106+00:00",
"sales_territory_id": "6673cdf4-8346-4d33-949b-f92ad1ceaa70",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d7d5d092-a7a1-4a73-b50c-8a37ef1154fa",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "db3932e6-5956-4ea0-8948-207d2e7d3901",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0b81ef59-eb19-441c-be35-56fabbad79a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e428eebf-c2db-49af-a948-3f0d4da569d2",
"db_currency_id": "8d1e8db4-995f-4b52-b5ab-3c4551cef754",
"db_language_id": "530cc7f2-78f2-4a2c-92a1-6bc4be834a6f",
"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-09T01:33:39.9854106+00:00"
},
"modified_dateutc": "2025-05-09T01:33:39.9854106+00:00"
},
"marketing_segment_id": "3b0d3708-f692-4b5b-961c-83dbba9e3d56",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "82d67d8e-c72b-4506-bdaf-904c128e6fe7",
"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": "b4565381-e965-4db9-852b-666bafecb659",
"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": "7ea3066d-6c47-4442-a6fe-407b2a13738c",
"db_country_code": "sample string 28",
"feelist_id": "ef520ed4-c5b5-4ee2-b253-487d4e3eb14d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d155d54f-2715-43c5-a121-348f0fcc4615",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8e1bbb99-c595-43fd-991e-7b15a201ecf1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-09T01:33:39.9854106+00:00",
"db_currency_id": "b87f13c8-0ba6-400e-a3f8-4716370dcdbf",
"db_currency_code": "sample string 10"
},
"company_type_id": "eee87803-0c41-4c9f-b9e1-beb19ab87a74",
"company_type_name": "sample string 32",
"company_type": {
"id": "84ed7927-e236-41e6-b713-0db7e64d3d3d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7e6bf2bc-08e1-498c-8f1b-25475c6933a2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7e51ae30-0bab-447a-b395-e0f99418c56e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4e39f6a2-f02d-45de-bdb7-77637e2611fe",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9757321e-3a15-4a51-8234-7642047da7b3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b24fe9a8-95d1-4b69-bc0b-f256adb1a423",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-09T01:33:39.9854106+00:00"
},
"company_sector_id": "67090d28-e18a-4d6a-b412-02436c30d58f",
"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": "b3a97db0-2f4c-4eea-8424-9232adf4f79b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f1e651d9-5967-4e98-b5fe-bf2f3a1a7fe0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b71fccd5-b912-4040-80a6-ca3f6ae70c27",
"account_manager_user_code": "sample string 56",
"company_status_id": "b5df5368-2a38-4b28-bafe-c2754f2847d1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-09T01:33:39.9854106+00:00",
"id2": 60
},
"db_language_id": "9830fe31-73c1-4f90-8205-e2f8cc3be971",
"db_language_code": "sample string 7",
"db_title_id": "938b865d-9ae9-4a0b-8796-6b88c92abaa7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-09T01:33:39.9854106+00:00",
"create_date": "2025-05-09T01:33:39.9854106+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-09T01:33:39.9854106+00:00"
}