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": "fb0ab5ab-a5e0-4a5a-9ccc-c3feed8e060f", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "0ed8c4b5-c766-440d-910d-2e0c7f41b07c", "company_code": "sample string 5", "company": { "id": "1f4ea98f-ebf6-4e3e-b53d-bcc1aac4a2e3", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-09-29T01:38:18.0403992+00:00", "sales_territory_id": "a1d02773-7c32-4c98-b50c-086efe53c98d", "sales_territory_code": "sample string 9", "sales_territory": { "id": "50250e7e-8243-4c7c-a8a3-7160b0da43f2", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "45dd10ec-daef-4318-b1a8-d8de8c24a724", "sales_organization_code": "sample string 5", "sales_organization": { "id": "b1af3f93-cd4e-473d-b4ed-d81f09e68618", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fbc99926-6ffc-4852-beee-48868ef900dc", "db_currency_id": "5d77c535-94b2-408f-9c6e-37b9f864c1ca", "db_language_id": "64975ae6-bdc2-488a-895e-4b060c79e7bf", "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-09-29T01:38:18.0403992+00:00" }, "modified_dateutc": "2024-09-29T01:38:18.0403992+00:00" }, "marketing_segment_id": "f62a84d1-e905-41d9-a6b8-f6ffb99d576a", "marketing_segment_code": "sample string 11", "sales_organization_id": "6bf12416-8257-48e3-944c-003ea8965909", "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": "1de3539b-b168-4209-9f98-87c57d87cb40", "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": "b59c8ea1-7590-4734-b10a-0771464d3536", "db_country_code": "sample string 28", "feelist_id": "5f7014fc-d135-42bc-89b1-48add79dbfce", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "5dbd8583-df85-45a3-9607-9b33ae2c8323", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "e9f2bcdd-73c4-470a-8916-24b9f37ebae3", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-09-29T01:38:18.0403992+00:00", "db_currency_id": "cbd5d196-ed4f-4577-a597-33934448e270", "db_currency_code": "sample string 10" }, "company_type_id": "318f1b35-ffd2-448e-bb6a-4ee4ba8e1570", "company_type_name": "sample string 32", "company_type": { "id": "26cf777f-9793-4529-9d95-dea93fa84213", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "741e5277-6b10-4a29-96e6-e7dd781d3e2a", "sales_organization_code": "sample string 5" }, "db_language_id": "f749df9b-1f84-4543-8198-989652f3343a", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "b5624902-da3d-4243-adda-1f1de4873e25", "article_price_label_code": "sample string 37", "db_payment_method_id": "06dd8008-3269-4031-a170-fc7f34bf9ec6", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "987196ab-a6ff-48df-8159-5b7ee9d8e85d", "name": "sample string 2", "pm": "sample string 3", "description": "sample string 4", "reference_back_office": "sample string 5", "activated": true, "modified_dateutc": "2024-09-29T01:38:18.0403992+00:00" }, "company_sector_id": "a358642f-eaaa-40bb-8f24-f08901c15ae3", "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": "7c98f294-6fa3-45f4-a233-4dfa6b1eed39", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "eac3336b-3ca3-491d-a4e9-4a7d59b0ae30", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "31a54e42-a950-4e3a-87e3-ce18069a2e41", "account_manager_user_code": "sample string 56", "company_status_id": "38ab56f5-2497-4bd5-88a4-fd9cd4985136", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-09-29T01:38:18.0403992+00:00", "id2": 60, "po_number_required": true, "invoice_contact_id": "b1efc380-e7a8-4c0e-a992-16971903ece4", "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": "a4723f1b-bef9-4090-bbce-a5061a3f67fa", "db_language_code": "sample string 7", "db_title_id": "fef91c14-6e53-47d0-83c9-1a846a176d57", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-09-29T01:38:18.0403992+00:00", "create_date": "2024-09-29T01:38:18.0403992+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-09-29T01:38:18.0403992+00:00" }