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": "00e8e161-4d9b-438a-80b5-45a263a5f5dd", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "f58ad519-e58d-4c44-a818-a0acb9dd2a9e", "company_code": "sample string 5", "company": { "id": "c9850bc4-2409-4737-9292-833018979a10", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-04-19T03:29:45.2102615+00:00", "sales_territory_id": "74f25ad9-23d4-42f8-b2d7-243775a790dc", "sales_territory_code": "sample string 9", "sales_territory": { "id": "0f4ea720-0ace-4e1a-9c5b-e6a00137d354", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "24ed65a2-4996-423f-a881-4cb09f080d55", "sales_organization_code": "sample string 5", "sales_organization": { "id": "87bc067c-31ea-48c9-a1ee-853207968471", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9993fa10-e0e6-4763-ac52-69cb8bb47a72", "db_currency_id": "86548902-4f64-472c-a795-c7144f94a470", "db_language_id": "ae26d41d-e24c-462c-8526-b43ba651f4ec", "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-04-19T03:29:45.2102615+00:00" }, "modified_dateutc": "2024-04-19T03:29:45.2102615+00:00" }, "marketing_segment_id": "ddbadf2e-a2fc-460d-8869-8962907a6aae", "marketing_segment_code": "sample string 11", "sales_organization_id": "d3731f7f-40eb-487b-9377-d04a25c3cc9b", "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": "ee6f2ae8-03b8-4a1f-97e3-fcc67b73dd42", "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": "72f82f3b-8423-42ca-8b5d-910028e9740f", "db_country_code": "sample string 28", "feelist_id": "3568ad3b-d80e-4fe5-8709-1003b446e0e5", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "57780cae-b770-46f4-b588-9112638606a9", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "43141030-d851-4b79-8430-2fad86f52712", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-04-19T03:29:45.2102615+00:00", "db_currency_id": "565cf65d-9081-40c6-beec-e2d1f3ba18ec", "db_currency_code": "sample string 10" }, "company_type_id": "eb142324-5bed-4a7c-a915-282021c5cf9c", "company_type_name": "sample string 32", "company_type": { "id": "86f408e3-629e-4c98-840b-5413e618bea6", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "1b4f021d-655f-48ce-b4a2-88cdfa59467f", "sales_organization_code": "sample string 5" }, "db_language_id": "a6fa7ca8-ea0c-49ff-a938-db8972d08f29", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "9654c635-2452-49c3-8503-9206cc0dee0c", "article_price_label_code": "sample string 37", "db_payment_method_id": "127f1c38-8ac9-4f52-a856-090c45303af9", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "260cb328-bb4d-4dfc-bfe9-eaa848a27245", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-04-19T03:29:45.2102615+00:00" }, "company_sector_id": "deb6ae67-e839-4015-ad29-2e2c2d96039a", "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": "84f93fe5-6774-4204-83bc-24087219a5b6", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "ee9f95fc-f84d-4219-bd4f-e4774fc8873c", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "e544ef39-e216-403d-93df-ae4e1e29f079", "account_manager_user_code": "sample string 56", "company_status_id": "3335948a-d601-4a04-afb6-2a26a4d9747a", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-04-19T03:29:45.2102615+00:00", "id2": 60 }, "db_language_id": "e4079eeb-fefd-4bc0-847e-c64ab2abf38a", "db_language_code": "sample string 7", "db_title_id": "5e37064e-d168-4e87-b41f-6b287ac9455d", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-04-19T03:29:45.2102615+00:00", "create_date": "2024-04-19T03:29:45.2102615+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-04-19T03:29:45.2102615+00:00" }