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": "936ec987-dab3-4640-8a3d-0e64c47c6f53",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3297ee33-29ef-479f-aa66-2e703a490140",
"company_code": "sample string 5",
"company": {
"id": "a8512e32-8c13-4a29-b679-374e57a7ea1d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-22T17:34:06.5026977+00:00",
"sales_territory_id": "5167161e-7093-4531-a2e6-a95b7107be63",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "14b8734a-ea90-45db-99a8-f68fc50267a3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "499ec40a-d5be-4788-b38f-1a4b0c6b3411",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8696502f-6a20-4134-90c3-66e10dab1a5c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b5bd38c-ec75-470a-aafd-90b1c437e381",
"db_currency_id": "33184417-2d1b-4d41-a575-00c11b3e59a6",
"db_language_id": "347a2cb0-1576-4eb0-b2f8-03cc490396b0",
"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-02-22T17:34:06.5026977+00:00"
},
"modified_dateutc": "2025-02-22T17:34:06.5026977+00:00"
},
"marketing_segment_id": "3b5f87d4-c78b-4afe-91cb-2e9832f660ad",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9b5326f2-0a91-476e-835f-d201d00653c2",
"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": "b7366f1a-7de6-4c3d-8344-b477eff4ada6",
"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": "9796096a-65d6-4883-b142-f49d72c58e5f",
"db_country_code": "sample string 28",
"feelist_id": "b2fa873a-0597-4dfd-b3fb-a21a186c1c23",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "72a90393-75cf-4ab6-9272-b457a27767cc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6f6d2ad1-565d-4a0d-8c99-de2c165e2854",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-22T17:34:06.5026977+00:00",
"db_currency_id": "c7579212-5038-425a-bd1b-84d652e892ba",
"db_currency_code": "sample string 10"
},
"company_type_id": "f1a5587c-b4b7-49fd-8abf-41fc845d8ea9",
"company_type_name": "sample string 32",
"company_type": {
"id": "c8b42796-74a4-4359-9e06-4b3109e85066",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "28bd1610-9f39-4f83-95aa-087b2edaa22e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a50a6147-98d0-4e7d-9ea5-9d80470cd6b1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "df84f1c3-cdc6-4748-9e2c-16c164581826",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2bc54220-4f55-4b58-8582-1a1eb2d8e4dc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9fe3916e-15ce-47ee-9667-c67f2a8c50f9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-22T17:34:06.5026977+00:00"
},
"company_sector_id": "329e4b35-fa7e-4224-bbca-1f3ee814c6f6",
"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": "d9ed652f-e039-4e6c-a465-0416b5db0f10",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6f282458-8a94-4978-a04d-2b63e6dbc0f4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f1577cae-f97b-4fa8-acde-f097b15017e0",
"account_manager_user_code": "sample string 56",
"company_status_id": "1fe29a23-a755-4776-b97b-dfbdb2c47a06",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-22T17:34:06.5026977+00:00",
"id2": 60
},
"db_language_id": "d5fd033b-c072-42e0-9a91-4e95b8655098",
"db_language_code": "sample string 7",
"db_title_id": "5ac925f8-de33-42c7-8a1c-7439ad5aaf6d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-22T17:34:06.5026977+00:00",
"create_date": "2025-02-22T17:34:06.5026977+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-02-22T17:34:06.5026977+00:00"
}