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
{
"id": "62130692-8102-4dac-a010-bc4de0841c49",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0a7f5bea-de3c-4ac0-8af1-8460a7a8eb07",
"company_code": "sample string 5",
"company": {
"id": "7d33832e-bbfe-4839-a1bd-090d96d84d54",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-29T10:25:22.7501337+00:00",
"sales_territory_id": "90a36d15-85d0-41a2-999b-39cbb8b4509e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "748abd1b-3a1e-4546-a7f2-3db4c1574f21",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "531b06ef-8369-429f-b9b1-a67ec5a1aeff",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c1e72e67-0342-48a6-bc74-eece4d13ce67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3714487-e241-401a-958f-6b8b2860fe64",
"db_currency_id": "f21a2652-7f97-478c-9d07-aab2aa7e242a",
"db_language_id": "a3370754-2982-4d71-a44d-a9fce8c3db0c",
"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-11-29T10:25:22.7501337+00:00"
},
"modified_dateutc": "2025-11-29T10:25:22.7501337+00:00"
},
"marketing_segment_id": "6525a564-8838-444c-bd52-b89a93a83b50",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c6394f1b-8515-4a92-abf8-3eadf138ff33",
"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": "149bfcad-e49b-43ea-9e5e-9a639111d88e",
"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": "2f4dfe6d-b35f-43e6-8499-1481c0c0a33a",
"db_country_code": "sample string 28",
"feelist_id": "371d812a-23e1-443b-9cbe-1c58dc33ea7a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "234b828d-6080-414a-9983-573c6a6cc759",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "04206dce-cf43-403f-a91f-5bfca40ca65d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-29T10:25:22.7501337+00:00",
"db_currency_id": "2a290470-3a15-4b64-9b5d-5541d08ea5db",
"db_currency_code": "sample string 10"
},
"company_type_id": "a69f4654-8268-4559-926b-dc503d4aec28",
"company_type_name": "sample string 32",
"company_type": {
"id": "3e7f7f96-276f-4901-ae99-7e1b8100680d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3c224b5f-3fe3-4a10-9d5e-dbd3899e66ca",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3013549b-3d12-4ed7-aa9f-2983c920e2d2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ed62e809-8ccd-44a4-adb3-a91980054a34",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fb77ad57-9161-46b7-a11f-ef8784894187",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6869e995-0140-4ca3-bc66-acdf5572ff7c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-29T10:25:22.7501337+00:00"
},
"company_sector_id": "316cd1d0-3c54-4309-abc5-759d2ddf0bfd",
"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": "733dbb75-8672-472c-87d0-8a61e304fff0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fd00cc46-c923-4c80-bd2c-f167aa6621ef",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "43021992-e6d9-4871-873f-68f1e3951fa9",
"account_manager_user_code": "sample string 56",
"company_status_id": "6af445c5-6b17-4a74-8dad-87702a7d3824",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-29T10:25:22.7501337+00:00",
"id2": 60
},
"db_language_id": "b19824c4-f288-4f12-b4b3-bc3940fa436b",
"db_language_code": "sample string 7",
"db_title_id": "df6adfac-2e46-4b24-9770-059f8b148753",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-29T10:25:22.7501337+00:00",
"create_date": "2025-11-29T10:25:22.7501337+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-11-29T10:25:22.7501337+00:00"
}