Retrieves the 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": "26657a34-7f0b-476e-84ea-bbfae3faf893",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a18e8d4a-c44b-457e-81bc-7ef1a3fe8f04",
"company_code": "sample string 5",
"company": {
"id": "12192429-19ca-4fa1-b803-7e04ce9be41c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-21T08:34:34.6219744+00:00",
"sales_territory_id": "3e00089c-a5da-4f28-9951-f0d592f62cf4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "77e8647b-5610-4c4b-9664-72eb2371d96f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a5fd5fe9-d772-4f9a-ad80-ee0c504ddeca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "774946d4-0aba-41b2-8dcb-07af5eea5748",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99c9b7cf-9c57-4e94-9ae3-b922a2e130d1",
"db_currency_id": "bd593105-d493-4769-980e-b4cd7502f3bf",
"db_language_id": "b295cd67-c81f-4971-b7aa-8378393799de",
"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": "2024-11-21T08:34:34.6376013+00:00"
},
"modified_dateutc": "2024-11-21T08:34:34.6376013+00:00"
},
"marketing_segment_id": "a213df2a-dcf1-4bbc-b1de-0cbf810b4684",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7959af59-0aa7-4352-bef1-5fd799f27a1a",
"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": "9e21ca04-e009-47d2-9043-1717ea0d79d7",
"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": "f57a7b74-0de2-4ee7-a4c7-87681ff49d39",
"db_country_code": "sample string 28",
"feelist_id": "783194b1-1c3e-4fd0-a9c6-5e63e876f715",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "811a91b6-152a-44ea-aeb7-270e2fa9131b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c627408f-e655-4e5d-8c23-51788b35fc3f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-21T08:34:34.6376013+00:00",
"db_currency_id": "e7317da8-8ca4-42b4-b3cc-4fcb290676ff",
"db_currency_code": "sample string 10"
},
"company_type_id": "8c6af358-a8c1-4f72-9ebf-f4d47b5177a0",
"company_type_name": "sample string 32",
"company_type": {
"id": "99a59b88-ea0c-438f-bc14-72b542d4c6b2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "05e8aa1e-53ad-42be-b6a2-188ebdb45672",
"sales_organization_code": "sample string 5"
},
"db_language_id": "502df964-3aa5-42ab-a00b-ea5436f793c0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "94ff1f8f-68f4-4d08-9b8a-b5411e273978",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "35ad1f12-1db9-48ee-a4eb-e815ad9119d1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "759d697e-1be4-4eb3-a36a-1f0ce07bbd4e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-21T08:34:34.6376013+00:00"
},
"company_sector_id": "12f2d7cf-9d50-45d6-93a0-f1c34ee55ef0",
"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": "ac410c15-6b74-4aee-b4fb-194e886fb94f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7f99d986-0579-4c23-b22f-8f18544b7ff5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "576c0216-4439-412f-ab0d-3a379a65b57d",
"account_manager_user_code": "sample string 56",
"company_status_id": "bb01c659-1d2f-4d9e-a0a2-2c99a0d9f344",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-21T08:34:34.6376013+00:00",
"id2": 60
},
"db_language_id": "57471042-cd1c-466f-815b-9a309551c82e",
"db_language_code": "sample string 7",
"db_title_id": "4e8a46c0-e963-4b29-8389-f8ba999d9b78",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-21T08:34:34.6376013+00:00",
"create_date": "2024-11-21T08:34:34.6376013+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": "2024-11-21T08:34:34.6376013+00:00"
}