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": "dcb45460-4e2a-4ad8-b991-f09cbb54d286", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "b918b8bb-4c8c-4da6-9121-750231580ba7", "company_code": "sample string 5", "company": { "id": "1beb0767-59b1-44bc-9ba7-baf2aeac5f69", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-04-16T15:01:06.5054215+00:00", "sales_territory_id": "2ff0f0bb-c79c-4370-9297-ad65d3191471", "sales_territory_code": "sample string 9", "sales_territory": { "id": "22a904be-1721-437c-8d32-24878cf9c02d", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "c560063a-defb-4549-9daf-69ed7c4b0bb6", "sales_organization_code": "sample string 5", "sales_organization": { "id": "482f2503-5d5e-4087-b226-8dae64e07919", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "22d7c5b4-ccb8-4b49-a4f1-63b3954064f7", "db_currency_id": "c82753b9-c5c5-439b-b7c4-583cd60f25e5", "db_language_id": "dfcae531-61d0-4bb5-b263-697edce0a3db", "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-16T15:01:06.5054215+00:00" }, "modified_dateutc": "2024-04-16T15:01:06.5054215+00:00" }, "marketing_segment_id": "852981eb-656a-4872-b77e-43f1cf351a1e", "marketing_segment_code": "sample string 11", "sales_organization_id": "aea22532-40b7-4f60-99db-50f92fa20e8b", "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": "0c804b1b-cde5-4da6-8fec-f6b57c8158d8", "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": "faa13bc6-c4b8-4554-a71e-c91cfa30b4d8", "db_country_code": "sample string 28", "feelist_id": "0aae583e-6b12-4ee3-abd1-bdfc2a2eb368", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "d0e79337-c0bf-4d62-b50b-32964a9b26ee", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "cee3ee25-a296-4a55-8588-a9b5c5191eef", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-04-16T15:01:06.5054215+00:00", "db_currency_id": "21358c86-b04a-4fe6-bb83-06eba23ab64f", "db_currency_code": "sample string 10" }, "company_type_id": "216f1c6c-c864-4681-8f8c-1e43fec07049", "company_type_name": "sample string 32", "company_type": { "id": "faa323fd-1534-4c57-94fc-e597b90f5d22", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "9e688d52-d4e6-4d80-a747-0fd8ee667eec", "sales_organization_code": "sample string 5" }, "db_language_id": "5d44d048-cf64-49e1-9ca0-cf44ec07cd40", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "7c0cc66e-c07c-4074-b9a5-3347daa21d13", "article_price_label_code": "sample string 37", "db_payment_method_id": "07b5e4a2-ebd0-4aee-821f-62a71d6fefa3", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "f1827f7b-9283-41e9-afd0-c1e44e0ae8ac", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-04-16T15:01:06.5054215+00:00" }, "company_sector_id": "d3513e87-1308-40aa-bd7d-2617b2638266", "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": "1e032107-2e96-4269-9574-cb5719874492", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "4ac098b7-f975-4862-8cf8-4e59ae20fb05", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "136b152b-fdfe-4ceb-9088-06bbc2e32993", "account_manager_user_code": "sample string 56", "company_status_id": "74f2d2b8-0714-4a5c-afdc-b9b18f03b038", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-04-16T15:01:06.5054215+00:00", "id2": 60 }, "db_language_id": "1a7f3873-3093-40a4-84ce-7b81d042f225", "db_language_code": "sample string 7", "db_title_id": "3c263afe-0aaf-447c-a43d-8d5d57c69ade", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-04-16T15:01:06.5054215+00:00", "create_date": "2024-04-16T15:01:06.5054215+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-16T15:01:06.5054215+00:00" }