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
contactName | 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
{ "id": "b49f684e-59fc-406a-8443-0288f9829bd4", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "70021e26-7ab1-4ecb-af7c-8f13dd725bfc", "company_code": "sample string 5", "company": { "id": "10ab9630-644d-407c-ac6d-94320adafd69", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-03-09T14:19:17.6256862+00:00", "sales_territory_id": "819594ee-72ff-42e8-a167-7a1025e6c1e2", "sales_territory_code": "sample string 9", "sales_territory": { "id": "1fbeb9b2-0722-46cf-8cb5-afd8172abd64", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "6c0ed27e-3e26-4097-a179-88cbb2241212", "sales_organization_code": "sample string 5", "sales_organization": { "id": "64d4c341-14db-4c94-808e-33d6dcc17b1c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "90a65cb2-6aca-4941-b4ee-f5b259eacc50", "db_currency_id": "ee2bdf84-42cb-40ea-9cf8-5f97713feb0d", "db_language_id": "f5196340-4bc2-4269-9556-e6ca24bde2f6", "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-09T14:19:17.6256862+00:00" }, "modified_dateutc": "2025-03-09T14:19:17.6256862+00:00" }, "marketing_segment_id": "a12ca1cf-de30-4322-9e50-45529c332ff4", "marketing_segment_code": "sample string 11", "sales_organization_id": "6b0fb0c6-ad17-4e2e-a52f-78dceea2f6e5", "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": "d3e71e46-298a-4b70-9975-79896963757f", "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": "61920e84-5411-43d7-b174-6ce81cc462b5", "db_country_code": "sample string 28", "feelist_id": "f0c756b2-93c5-4ef0-b50c-d13c9cf4d912", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "d7726703-01ae-4228-a0ae-5a960889e6cb", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "2001726c-f95a-4a47-8ad8-97cb4ea1a959", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-03-09T14:19:17.6456733+00:00", "db_currency_id": "368fa566-898f-4766-a46e-14172564759e", "db_currency_code": "sample string 10" }, "company_type_id": "b3deed85-ee37-41de-bc1e-495f69935673", "company_type_name": "sample string 32", "company_type": { "id": "206e096f-7ed3-49c8-88c9-91443daa141a", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "acd40ef8-7b1f-4f1c-bad0-7445183cafa8", "sales_organization_code": "sample string 5" }, "db_language_id": "6a40fbd9-fb55-484c-be92-5185168ff21a", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "a3c39b60-4b9f-47be-a8b2-5ed0e339b618", "article_price_label_code": "sample string 37", "db_payment_method_id": "e4a28ba5-848b-4377-a8fe-40cb1d1dc6fa", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "0b6213b3-30f8-4e3d-b5e2-fe7c8069f656", "name": "sample string 2", "pm": "sample string 3", "description": "sample string 4", "reference_back_office": "sample string 5", "activated": true, "modified_dateutc": "2025-03-09T14:19:17.6456733+00:00" }, "company_sector_id": "0d0c2d8b-2030-45e8-bf77-92ab8b81b753", "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": "3474b064-8505-47e7-8861-63147ab41146", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "97e430a7-02d3-4a37-ba7e-3c2140688657", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "4f95f6e9-c5cb-426c-baf9-e5408c8e2621", "account_manager_user_code": "sample string 56", "company_status_id": "dd1376cf-e3aa-4e23-80f8-9901120e5200", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-03-09T14:19:17.6556752+00:00", "id2": 60, "po_number_required": true, "invoice_contact_id": "3105f1db-3c8d-479a-9a97-ec5647a5bcf9", "due_monthend": true, "payement_conditions": "sample string 64", "udf1": "sample string 65", "udf2": "sample string 66", "udf3": "sample string 67", "udf4": "sample string 68", "udf5": "sample string 69", "udf6": "sample string 70", "udf7": "sample string 71", "udf8": "sample string 72", "udf9": "sample string 73", "udf10": "sample string 74", "udf11": "sample string 75", "udf12": "sample string 76", "udf13": "sample string 77", "udf14": "sample string 78", "udf15": "sample string 79", "udf16": "sample string 80", "udf17": "sample string 81", "udf18": "sample string 82", "udf19": "sample string 83", "udf20": "sample string 84", "udf21": "sample string 85", "udf22": "sample string 86", "udf23": "sample string 87", "udf24": "sample string 88", "udf25": "sample string 89", "udf26": "sample string 90", "udf27": "sample string 91", "udf28": "sample string 92", "udf29": "sample string 93", "udf30": "sample string 94", "udf31": "sample string 95", "udf32": "sample string 96", "udf33": "sample string 97", "udf34": "sample string 98", "udf35": "sample string 99", "udf36": "sample string 100", "udf37": "sample string 101", "udf38": "sample string 102", "udf39": "sample string 103", "udf40": "sample string 104", "udf41": "sample string 105", "udf42": "sample string 106", "udf43": "sample string 107", "udf44": "sample string 108", "udf45": "sample string 109", "udf46": "sample string 110", "udf47": "sample string 111", "udf48": "sample string 112", "udf49": "sample string 113", "udf50": "sample string 114", "udf51": "sample string 115", "udf52": "sample string 116", "udf53": "sample string 117", "udf54": "sample string 118", "udf55": "sample string 119", "udf56": "sample string 120", "udf57": "sample string 121", "udf58": "sample string 122", "udf59": "sample string 123", "udf60": "sample string 124", "udf61": "sample string 125", "udf62": "sample string 126", "udf63": "sample string 127", "udf64": "sample string 128", "udf65": "sample string 129", "udf66": "sample string 130", "udf67": "sample string 131", "udf68": "sample string 132", "udf69": "sample string 133", "udf70": "sample string 134", "udf71": "sample string 135", "udf72": "sample string 136", "udf73": "sample string 137", "udf74": "sample string 138", "udf75": "sample string 139", "udf76": "sample string 140", "udf77": "sample string 141", "udf78": "sample string 142", "udf79": "sample string 143", "udf80": "sample string 144", "udf81": "sample string 145", "udf82": "sample string 146", "udf83": "sample string 147", "udf84": "sample string 148", "udf85": "sample string 149", "udf86": "sample string 150", "udf87": "sample string 151", "udf88": "sample string 152", "udf89": "sample string 153", "udf90": "sample string 154", "udf91": "sample string 155", "udf92": "sample string 156", "udf93": "sample string 157", "udf94": "sample string 158", "udf95": "sample string 159", "udf96": "sample string 160", "udf97": "sample string 161", "udf98": "sample string 162", "udf99": "sample string 163", "udf100": "sample string 164" }, "db_language_id": "ada9de88-f65b-4a35-ab77-b0410ef13d0c", "db_language_code": "sample string 7", "db_title_id": "0898364f-f97d-4b15-8a8d-a825e3543dba", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-03-09T14:19:17.6556752+00:00", "create_date": "2025-03-09T14:19:17.6556752+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-09T14:19:17.6556752+00:00" }