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": "34ad8fe8-d8a2-403e-8cb5-6a6c5506cc56",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "87480d97-45cb-4c1b-86b3-962d08a6f3ed",
"company_code": "sample string 5",
"company": {
"id": "ce22f6e4-2195-4dee-bbb6-d70aa0d82a9c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-25T04:25:19.4629608+00:00",
"sales_territory_id": "df6511d8-b36e-44cb-94e9-279f80e5ca67",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "52822641-0c5c-4fc8-80f7-721e0aa864e9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f4dcb138-ed64-4c67-bf1d-a473cffd59f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "abe963d0-a966-4ae5-b56b-7c875eded615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70369801-4b8e-406c-ad62-dc3ddad976d1",
"db_currency_id": "ca7f5289-3639-4b97-bcf9-5aa3df09eac3",
"db_language_id": "0b26d36b-0be3-477e-8bdd-da78cb1d8303",
"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-03-25T04:25:19.4629608+00:00"
},
"modified_dateutc": "2025-03-25T04:25:19.4629608+00:00"
},
"marketing_segment_id": "59cd7afd-d830-462b-8677-f6f7cd57d687",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "882f590c-cf94-4d46-9f63-b9525e5f685c",
"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": "603eb002-66fd-4f87-8014-224880e3110d",
"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": "cae4ed95-ac2f-4f10-ab2d-7796b71a0940",
"db_country_code": "sample string 28",
"feelist_id": "35ace115-ced6-4bbe-b0c8-7047b2dbeb78",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a069c76f-a025-4494-879f-8bfe8054ac2e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c94700de-2123-403e-be02-36b028226aea",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-25T04:25:19.4629608+00:00",
"db_currency_id": "37646eb8-23ec-48fa-9c4f-8fccb6153abf",
"db_currency_code": "sample string 10"
},
"company_type_id": "d36f1d85-dfc1-40df-be21-c2190255068f",
"company_type_name": "sample string 32",
"company_type": {
"id": "61b98b6e-49b8-46e4-a264-c6280ae4756a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1050e701-2bc4-43ca-94db-b2a7a925f800",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ee2142b5-63b2-486c-840e-286b2a5141e3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "43da0e14-0dac-424f-80d9-f65f68a7c2ab",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "78cb4c7f-f5d8-42bb-98d2-fe0b641d9078",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "19eabbc3-0a7e-45ba-8bbd-8a3cdcab3e21",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-25T04:25:19.4629608+00:00"
},
"company_sector_id": "9ac2a8d6-9ae5-4fcb-81e4-781f4541ab1f",
"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": "809eadd3-ff59-48f8-8468-294eba722c80",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "858beb08-a0bd-4e91-a596-80f50e105a9f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5daac25a-0dcf-47d5-b26f-f3e2063d031a",
"account_manager_user_code": "sample string 56",
"company_status_id": "3b8a9857-0517-41ec-bfa8-9731bfdeb9e3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-25T04:25:19.4629608+00:00",
"id2": 60
},
"db_language_id": "3a226f8c-7e13-42a8-8bae-09c9130e65af",
"db_language_code": "sample string 7",
"db_title_id": "c002e256-4880-4b05-9309-d1079eb66ee4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-25T04:25:19.4629608+00:00",
"create_date": "2025-03-25T04:25:19.4629608+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-03-25T04:25:19.4629608+00:00"
}