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": "c94fe545-d082-41e7-81c4-a33d4b5d7881",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "93fae2aa-fe01-4795-ba19-c3a28326dd50",
"company_code": "sample string 5",
"company": {
"id": "2fefeb62-cdf6-4a09-937c-9162d9e15afc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-31T21:32:40.0283401+00:00",
"sales_territory_id": "48ac5fa0-e264-43c4-873c-c28f7fdb425a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "63d329bc-4289-4d9d-a607-42a9dbf41d96",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "83c6caba-5937-4a44-9d1c-795233c89a49",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e1acde4f-7009-4b71-a940-4777290bba7f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8329d576-d0ef-41e3-a5c0-715f14519939",
"db_currency_id": "7421e799-510e-471a-9302-7698115b6fce",
"db_language_id": "202ee5ba-ab0a-4a03-bf61-d8daf98bd4b3",
"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-31T21:32:40.0283401+00:00"
},
"modified_dateutc": "2025-03-31T21:32:40.0283401+00:00"
},
"marketing_segment_id": "742eb2e8-af6e-4347-8c5d-8f8064723978",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "388edd42-3c0a-400e-9fc5-7f2062eccbe2",
"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": "95b1d1d0-7a22-4f9b-8337-050f9e096979",
"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": "6f18dc04-8f37-4f14-bcf7-b17b0b6dbaf0",
"db_country_code": "sample string 28",
"feelist_id": "718afe62-a494-46b6-99d6-cfdd8f349e1d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e1554a5a-580f-4916-8e2a-c135de64c3a7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "85418784-5bd7-4c3c-8921-f8bc22b55a21",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-31T21:32:40.0283401+00:00",
"db_currency_id": "60c34c89-4d23-4aaa-a6e6-ffd2473b2eaa",
"db_currency_code": "sample string 10"
},
"company_type_id": "fc17cb32-e327-4e2b-b3da-b616c7c10ed6",
"company_type_name": "sample string 32",
"company_type": {
"id": "d529bef5-d1e4-407f-88b8-433adf97466c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8bcdfdf8-5e22-430c-b155-06c63a3f4a7c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "90284d90-5ac2-42b8-a212-33f8e43b5a92",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b3580f56-7da2-4d63-8e75-75cac34896f4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4bbc9157-19b6-45cb-97e3-a46c0e7b3857",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "77701436-c66d-46fc-bcf6-d687eee03975",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-31T21:32:40.0283401+00:00"
},
"company_sector_id": "b0cca3ad-101b-4477-8a54-95dd23870996",
"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": "9e7ab5c6-270e-4e54-8b82-263ec7b54cd8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b1166eb0-3cf7-41ec-a038-7490d8c0f92d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9752cb39-8e14-4672-90e4-7042d0fc7f29",
"account_manager_user_code": "sample string 56",
"company_status_id": "077725df-e05b-4134-9892-d9adedacd356",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-31T21:32:40.0283401+00:00",
"id2": 60
},
"db_language_id": "1881a52a-c7ee-47e5-8147-72e8dbada430",
"db_language_code": "sample string 7",
"db_title_id": "5815b14a-6f84-48d6-b1f2-09c0387b8c13",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-31T21:32:40.0283401+00:00",
"create_date": "2025-03-31T21:32:40.0283401+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-31T21:32:40.0283401+00:00"
}