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": "87a20e06-8917-4dc0-8e47-4698deb30d7f", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "352f29b4-7a0b-45d3-b561-7db23f6f9bde", "company_code": "sample string 5", "company": { "id": "a1342255-b990-4244-a4ec-a36a15cf1c82", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-01-22T01:25:05.075199+00:00", "sales_territory_id": "f64e695a-8ac5-4d58-9943-4abb62c1c263", "sales_territory_code": "sample string 9", "sales_territory": { "id": "adc09282-75c7-4ed2-af75-211d6be58b5c", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "9861fb16-d50b-4a49-81e9-3ac98e97276f", "sales_organization_code": "sample string 5", "sales_organization": { "id": "a903f39c-e07e-4767-bb94-626786a48000", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4ff05f3f-f9c3-4336-938e-1a2ec020f5a1", "db_currency_id": "85c71b17-3d89-41e8-b928-df81f2bdfe50", "db_language_id": "a34dd668-8a80-4dff-93e5-a5b829b98e61", "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-01-22T01:25:05.075199+00:00" }, "modified_dateutc": "2025-01-22T01:25:05.075199+00:00" }, "marketing_segment_id": "e68df0f5-7a33-4b80-a108-06d3c7b48db7", "marketing_segment_code": "sample string 11", "sales_organization_id": "4ba9c778-b712-4580-8dc2-fae71d8a2ef0", "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": "24b7b60a-9daa-452a-923e-34f70fe83695", "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": "db1506e5-a14f-4e4b-a853-89f60d212f51", "db_country_code": "sample string 28", "feelist_id": "274bb5ee-897c-4518-9841-2a469fc1a40b", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "e54cb9f2-f09e-44b0-8f41-26cea3c01517", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "4158aa30-20e3-4ce5-8756-67ca1669d935", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-01-22T01:25:05.075199+00:00", "db_currency_id": "17a63f56-8b53-4eee-b865-4aef81a6d009", "db_currency_code": "sample string 10" }, "company_type_id": "a9b39c6a-2877-4bf1-a5a4-7dea2b9c1605", "company_type_name": "sample string 32", "company_type": { "id": "8c0c6980-6648-4f6e-8b32-9d6fe5afbabd", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "3690b0f2-a2b8-44a8-8ec5-732b5f7725d0", "sales_organization_code": "sample string 5" }, "db_language_id": "8281830e-7b1e-4920-9e75-356f835bcdb4", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "1a9ed933-fc3e-440b-8390-6326b10f71ef", "article_price_label_code": "sample string 37", "db_payment_method_id": "aaa66dc5-0465-471e-afa2-02127614b951", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "a7d1fa4f-1381-4edc-a7ad-c5c5f1fc4073", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-01-22T01:25:05.075199+00:00" }, "company_sector_id": "1ce5b2ba-7b89-4229-a82a-5a0ca0fe04a2", "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": "b41612e5-99fc-4aff-8029-5da374eb5579", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "92ec0cc9-7e01-4a69-9b9e-d5adc40b1e4a", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "8ae53017-144d-474e-b748-e3d4f898ef4a", "account_manager_user_code": "sample string 56", "company_status_id": "ab743e8f-7a94-4249-a536-e80d327bc2a1", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-01-22T01:25:05.075199+00:00", "id2": 60 }, "db_language_id": "174439cc-21e1-41d1-9571-d7ed5ddef2bc", "db_language_code": "sample string 7", "db_title_id": "c0579348-f222-4d92-b690-c50cee3b919f", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-01-22T01:25:05.075199+00:00", "create_date": "2025-01-22T01:25:05.075199+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-01-22T01:25:05.075199+00:00" }