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": "b6c0bb70-cbed-42a9-a4c6-5703878789f2", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "52a80203-d0fb-4c6b-ab5e-c8c21132ae0d", "company_code": "sample string 5", "company": { "id": "dbadac87-27ec-4e00-91e3-f28e2784a07e", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2023-03-31T22:39:06.1823413+00:00", "sales_territory_id": "3572defd-ae8e-445b-9ed1-b6e2c7d703a5", "sales_territory_code": "sample string 9", "sales_territory": { "id": "75f740f5-4f20-4c7e-8d68-9823d31d7fb8", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "832d57e3-d6a9-4272-8679-614ccc573377", "sales_organization_code": "sample string 5", "sales_organization": { "id": "72e107ce-d83e-4503-8fdf-9e241e6e9e60", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "5617cb2e-8314-4625-b89d-335c0710c2b8", "db_currency_id": "886e3d9d-a297-4864-9ca3-cd0320559f75", "db_language_id": "6f47d6b9-3d64-41fb-a6aa-e4769b8bbf16", "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": "2023-03-31T22:39:06.1823413+00:00" }, "modified_dateutc": "2023-03-31T22:39:06.1823413+00:00" }, "marketing_segment_id": "3c993886-3eeb-4ede-934f-139c4e7bf404", "marketing_segment_code": "sample string 11", "sales_organization_id": "3d173b94-76ea-467f-a5e0-44c9d3e4a438", "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": "b292dd96-5094-48de-9f65-f069732d8e7e", "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": "c2392fe3-c03b-4282-a991-9994db509029", "db_country_code": "sample string 28", "feelist_id": "35538ca8-5ab2-4285-85ad-778a953a898b", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "34ca8748-ffec-4276-868a-ab6215794ad6", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "b90fe17d-f27a-442f-9a83-7b63f34f8d39", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2023-03-31T22:39:06.1823413+00:00" }, "company_type_id": "285b023a-4e89-4bdc-a9e1-8bad32036834", "company_type_name": "sample string 32", "company_type": { "id": "8c60c565-cb37-4d1c-b4d6-ae1eec362de7", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "b03a6653-82cd-43a2-9df0-05761f77d564", "sales_organization_code": "sample string 5" }, "db_language_id": "c9c9562d-7eac-4d23-a09d-b64eee6bf790", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "9af80452-98bb-4aa2-9d42-65ae66ac2057", "article_price_label_code": "sample string 37", "db_payment_method_id": "b6a08a0f-19c3-4eb6-a291-be500b6932ee", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "9f2ba427-78c9-4b63-a644-7d41425ac2a9", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2023-03-31T22:39:06.1823413+00:00" }, "company_sector_id": "f3dc9e79-8893-48c1-96df-dd01614d76ed", "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": "9fa83ae7-eb7c-4851-b9a5-2dff3a606e28", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "b2f3643e-32c4-4f9a-a942-dffbf64a5048", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "43494e5f-d12d-4a48-ad53-0b2f2cba473a", "account_manager_user_code": "sample string 56", "company_status_id": "56af3c4c-1430-4b12-a318-4f2410f56c76", "invoice_email_to": "sample string 58", "modified_dateutc": "2023-03-31T22:39:06.1823413+00:00", "id2": 60 }, "db_language_id": "ccdcec48-cdd7-42c4-bf84-b339d0f3d087", "db_language_code": "sample string 7", "db_title_id": "647537a3-20b6-4947-9590-464bfdce95e0", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2023-03-31T22:39:06.1823413+00:00", "create_date": "2023-03-31T22:39:06.1823413+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": "2023-03-31T22:39:06.1823413+00:00" }