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": "bd36f5f4-ef7f-401c-bfea-75a0d4686b64",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2c737a1f-8d2d-4334-971c-503504823c40",
"company_code": "sample string 5",
"company": {
"id": "3343d19f-0f76-4101-a494-5a888fd3b012",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-24T12:45:48.69485+00:00",
"sales_territory_id": "e4c9eb55-50cd-496e-a0bc-574f8b0725bd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a5eb6f9f-ddbd-4043-a1bb-ea649492261a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3d48ef6b-090f-4b8b-bf84-8b5f219aea7f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "59d81eef-674b-410a-b1df-a43e48c6653d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3415fcda-7202-4617-a176-34f43fa48158",
"db_currency_id": "337b857d-fa66-4902-a6d1-7bef637bce38",
"db_language_id": "3aa60ae0-487f-457a-919b-f0ea835e79a9",
"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-24T12:45:48.69485+00:00"
},
"modified_dateutc": "2025-11-24T12:45:48.69485+00:00"
},
"marketing_segment_id": "ab9df059-cd8a-4022-bb1c-b58b44ef4050",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b9f5684a-a372-412a-bdb8-20bffd5d1257",
"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": "622c30e5-b488-4a50-8da2-be4a8c8c9538",
"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": "01cf4577-1e23-498a-a2af-c04eca3c31ef",
"db_country_code": "sample string 28",
"feelist_id": "dee4f3a5-3e46-4bbc-8e5e-516a066d2619",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "21c816be-ae17-4f4e-9ea9-e8c6ee9feffe",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a26dc3ea-0705-435a-86f3-dedadd657178",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-24T12:45:48.69485+00:00",
"db_currency_id": "747685a4-8727-4637-ae2b-1ec3d550761a",
"db_currency_code": "sample string 10"
},
"company_type_id": "54c324d1-a641-4fe7-9716-d204f6f9508e",
"company_type_name": "sample string 32",
"company_type": {
"id": "ce86ee45-4cb7-4448-8e35-a6dd9f870b0e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6f9917a0-1859-4736-9c47-ba3aae8ff5f9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8b17fe9e-d038-4185-9ccf-5df3a03d446f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dbef5694-0020-4c9d-ae04-6644c709c0e1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "99bf01e5-bd41-4ce7-b067-3b261ab9cb6c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "36b60f87-9f14-4fa9-930a-c1a0d05dbc6a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-24T12:45:48.7104778+00:00"
},
"company_sector_id": "fd55aac9-063c-424a-aed9-466b04496b5c",
"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": "65a883bd-b4bc-42e0-a914-798598cb8c3b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5d8ae5e7-a484-419d-8989-4e32811d4da8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c06dab75-c6b7-45dc-a230-65de26e0036a",
"account_manager_user_code": "sample string 56",
"company_status_id": "1cec3101-430e-49e1-a835-d1863457a521",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-24T12:45:48.7104778+00:00",
"id2": 60
},
"db_language_id": "c36f5f92-e52c-4ecc-8bcd-3f9b804bf8e8",
"db_language_code": "sample string 7",
"db_title_id": "43104645-d5e0-4ddc-b641-927efc47f456",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-24T12:45:48.7104778+00:00",
"create_date": "2025-11-24T12:45:48.7104778+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-24T12:45:48.7104778+00:00"
}