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": "d5ed52eb-0762-4f9d-992b-55db9d2b569e", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "7516e2fd-eecc-4678-becd-140e980a9dc3", "company_code": "sample string 5", "company": { "id": "45bd6dea-a18f-47ee-a038-17fd708c394f", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-07-20T07:06:17.3354201+00:00", "sales_territory_id": "97615b6b-ec3a-458c-a219-49628a454e08", "sales_territory_code": "sample string 9", "sales_territory": { "id": "8cb5d281-56ae-4977-9a9d-5543be63cc77", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "12ec722f-fb43-45fc-a09d-a41837e0d0f5", "sales_organization_code": "sample string 5", "sales_organization": { "id": "dfc8c7d0-f425-4b8f-bd8c-f70d28f5abc8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "972b0b0e-8fc2-4218-a035-b837787fe6c3", "db_currency_id": "400567a1-b58c-4608-81ee-455e82487724", "db_language_id": "31a41d79-2fc4-4caa-9e8b-91c8f6a33a09", "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-07-20T07:06:17.3354201+00:00" }, "modified_dateutc": "2024-07-20T07:06:17.3354201+00:00" }, "marketing_segment_id": "8486bb9e-3a87-4355-8186-ca1816c011f0", "marketing_segment_code": "sample string 11", "sales_organization_id": "fed994f4-0918-444b-a159-8df17c441faa", "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": "cbbc678e-c8ce-4793-a227-fe80ee39a584", "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": "a2b676e1-635c-4689-90b9-393f3da7407a", "db_country_code": "sample string 28", "feelist_id": "37dfc0b3-f347-48e4-8bb0-089a84baaf4c", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "debea6f1-478a-490d-ba6f-6b5d5f6b7c21", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "a0ad4b80-13f3-4791-a07e-2a750c179bb9", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-07-20T07:06:17.3354201+00:00", "db_currency_id": "1fd6e907-1730-48a9-9212-1e19d03519e1", "db_currency_code": "sample string 10" }, "company_type_id": "bb28bd91-9d42-4fc5-a993-ba740f66fb8c", "company_type_name": "sample string 32", "company_type": { "id": "ca463550-f8f4-4ee4-be7b-b92b13bbf044", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "f5553a76-fceb-482e-948d-dfed4cad2364", "sales_organization_code": "sample string 5" }, "db_language_id": "3e3c849f-71d1-4344-989f-85fc0e7e8ba3", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "caa35fa9-d67d-478e-9a86-ae65a0dde872", "article_price_label_code": "sample string 37", "db_payment_method_id": "485f1a48-7d7c-486b-b607-9a3a57eae2fa", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "57513521-7070-4541-8b2b-7d4f3b5aeb12", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-07-20T07:06:17.3354201+00:00" }, "company_sector_id": "6e571f6d-5a58-432c-86ac-56f7aea9fd31", "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": "946583a0-e990-49f1-809c-18d41eaef353", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "2e5f8934-1308-4637-b734-3f0a02f82a67", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "d2ad71c9-021d-4537-a145-9b14b5051e88", "account_manager_user_code": "sample string 56", "company_status_id": "fdbbd120-763f-497b-af45-aaf33980247d", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-07-20T07:06:17.3354201+00:00", "id2": 60 }, "db_language_id": "43ef5dba-d787-4841-aa34-43cc1fab3cb8", "db_language_code": "sample string 7", "db_title_id": "fcdfcf3a-0873-4742-acd2-a90473336958", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-07-20T07:06:17.3354201+00:00", "create_date": "2024-07-20T07:06:17.3354201+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-07-20T07:06:17.3354201+00:00" }