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": "af49e12b-e0fc-431b-a78f-98b65514b392",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7221da1c-4d6b-4214-b51f-e8c62f092646",
"company_code": "sample string 5",
"company": {
"id": "6ce8fdd7-102d-4f9b-b3b3-155c26296730",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-28T12:55:38.0520293+00:00",
"sales_territory_id": "d9b3646e-24a0-425a-92a5-5ae069eff5c4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "96e4b516-f086-4e89-9aa9-2e8a6fbe46f3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e53e2817-6347-45e6-b2ce-5048a03fdefe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fcce7793-2992-447c-922a-20f62a839b4b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "569363bb-02a8-4403-bf0f-08d7fd854e9c",
"db_currency_id": "b390fce5-53f6-4d4e-ac87-9f54ba5207e4",
"db_language_id": "e37182a3-5cdb-48b6-b5c7-61ed961eb7f5",
"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-28T12:55:38.0520293+00:00"
},
"modified_dateutc": "2025-05-28T12:55:38.0520293+00:00"
},
"marketing_segment_id": "f99a2ebe-bf01-44b6-bbd4-349b34c207ce",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "df5606ac-48a8-4c79-bcf0-e7cd9b0a94ed",
"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": "534d94f5-dfaf-447d-b618-83e3214c4045",
"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": "6cde79e8-fd8f-40d8-bbc8-bd6755c3c444",
"db_country_code": "sample string 28",
"feelist_id": "7300c305-4d2d-427d-9caf-8988702c460e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "17b483ea-90b0-4d7c-8178-cabb0f68b06f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4e585ebc-1142-4b95-bcc2-d3d9267dc8dd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-28T12:55:38.0520293+00:00",
"db_currency_id": "0a87dd1d-71ff-4112-90c1-871a9343fb97",
"db_currency_code": "sample string 10"
},
"company_type_id": "c705075a-652b-4ddf-84a7-836b92c2aadf",
"company_type_name": "sample string 32",
"company_type": {
"id": "5d672e1d-2bb1-49d4-9896-69559ab2b66c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1879558b-c048-4f00-b5b4-4494b4f77132",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d221325e-8a88-40cc-a64b-224a52e5df44",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4c539715-1292-4926-904f-55fd6e060efa",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cfc70d20-c909-46a8-b295-5298f597697c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6c0bd048-e168-49c6-9e50-c3a969f6fee8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-28T12:55:38.0520293+00:00"
},
"company_sector_id": "74ee243d-9917-4918-8276-bb970c1fb285",
"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": "dcd143a3-1fac-4b42-9a83-db9d7b304aa2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e26f322a-fd0e-45bb-a904-2c2e3113b48f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "790587ff-663c-4c1c-b7f4-28e8f1aafc1a",
"account_manager_user_code": "sample string 56",
"company_status_id": "7306a300-d00b-447a-83fb-e1fd921d2d9a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-28T12:55:38.0520293+00:00",
"id2": 60
},
"db_language_id": "3ae9e139-c0fe-451c-ac24-fe1e41220d06",
"db_language_code": "sample string 7",
"db_title_id": "6096f56e-d9e8-47c5-aeeb-b31b138c8bec",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-28T12:55:38.0520293+00:00",
"create_date": "2025-05-28T12:55:38.0520293+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-28T12:55:38.0520293+00:00"
}