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": "4d2fc59f-1696-482e-83a1-ef6ed35c10c9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "01dedebf-9a27-4e76-83ca-359c45e052ba",
"company_code": "sample string 5",
"company": {
"id": "7418aadb-5e39-4424-8469-dad7f868b5f7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-28T23:29:14.5456236+00:00",
"sales_territory_id": "5ca451d1-ff4a-4a79-b9ab-46471e1c30ae",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c4f597f5-7d4b-4993-a55a-1c4d4c3a7af7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "beafcd64-08c0-4a12-9cb1-01e7dcaa43cf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f6f4e1d7-6270-41c2-94b4-c2a156d4881d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "950c8d9a-0136-479f-b4e7-249c449a3867",
"db_currency_id": "4303f933-3667-40d8-8d79-69df1d640420",
"db_language_id": "83500447-4f9b-440f-8306-6005985f1314",
"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": "2026-09-28T23:29:14.5456236+00:00"
},
"modified_dateutc": "2026-09-28T23:29:14.5456236+00:00"
},
"marketing_segment_id": "c37ae6e0-f29e-4cfa-a11f-d1e7229373c6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "68516650-6850-4206-a770-3a0708642729",
"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": "8f7e8c02-73a7-4462-875c-d32d7c3bf2fb",
"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": "eff8175c-0cc0-42e9-9979-a82820c9632d",
"db_country_code": "sample string 28",
"feelist_id": "738322cc-30b4-415b-9421-29c16139436c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f3b9ed74-2e9e-4209-a69d-5b43b61bd348",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "58a2001a-cd99-4b35-80ac-e183985e8b63",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-28T23:29:14.5456236+00:00",
"db_currency_id": "41c92830-162d-4f28-9df2-e3dd704c5bd3",
"db_currency_code": "sample string 10"
},
"company_type_id": "b249080a-1c9b-4935-901f-ca4dbabd7815",
"company_type_name": "sample string 32",
"company_type": {
"id": "378a9f39-4f0c-4f49-9c46-fc9a2b203f5e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4bc2c0cb-a33a-4682-9d9a-7a4c78915530",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b4b55ad9-84dd-4081-8018-e93932e47a19",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b23c97a3-1d9d-4a2f-86b8-41314129568c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d596fe23-d865-4abf-a29f-bda13395ac70",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6d74afee-bda5-43ba-b872-74de0b22ad75",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-28T23:29:14.5456236+00:00"
},
"company_sector_id": "850bf492-a3e1-454f-a0bb-2002d8dd5acd",
"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": "65594770-df77-48da-944c-0d2f37f5ce4f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2d874fc1-df7e-426d-aa0f-fcc26f749744",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "68326272-f810-404f-8dcf-f08d79032118",
"account_manager_user_code": "sample string 56",
"company_status_id": "2fce29fe-e514-481b-b252-98dd2fc812b4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-28T23:29:14.5456236+00:00",
"id2": 60
},
"db_language_id": "a13356cc-a63a-47a9-917f-b7cedfa8be8e",
"db_language_code": "sample string 7",
"db_title_id": "14cfdf88-7f60-4ecb-9af1-9f604cad9f1f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-28T23:29:14.5456236+00:00",
"create_date": "2026-09-28T23:29:14.5456236+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": "2026-09-28T23:29:14.5456236+00:00"
}