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": "419b9d5d-e5d6-40f5-9544-80d219f89d90", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "62a3d6c2-2678-44ec-a23c-afafb3c1cbea", "company_code": "sample string 5", "company": { "id": "bdea865e-e26d-4319-92a2-35f9fc4902e4", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-04-20T12:05:17.8385212+00:00", "sales_territory_id": "b34141a4-e55c-4542-9bc4-9204787f7876", "sales_territory_code": "sample string 9", "sales_territory": { "id": "40747241-e4d0-4925-9448-fb6f78f04e7d", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "3a959b76-f3bf-402a-a264-f40f679087c0", "sales_organization_code": "sample string 5", "sales_organization": { "id": "f46e1de1-ea77-4654-88de-6f1f933cb310", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e47826cd-e223-42af-8f13-6006a6ad9e13", "db_currency_id": "61188069-e1dd-4473-81b1-a2d114eb725f", "db_language_id": "f37b4a28-1f34-4ef5-b1dc-e7a91f47314d", "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-20T12:05:17.8541433+00:00" }, "modified_dateutc": "2024-04-20T12:05:17.8541433+00:00" }, "marketing_segment_id": "24d134d3-c025-41c2-8248-1a1e4529f06a", "marketing_segment_code": "sample string 11", "sales_organization_id": "ff7e1469-867d-45ab-b2cf-5e9fc81c6756", "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": "0be8ccf7-da6a-40aa-bfa3-affc27def3f1", "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": "370a4651-ba15-4be1-bd3c-38002f6c6cee", "db_country_code": "sample string 28", "feelist_id": "d0eeb325-57df-4eb3-80ce-5f8325afbcce", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "428e6f8c-62a7-4b80-bff5-bec0772df324", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "ce998876-12a7-4527-b66c-157ea58cf372", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-04-20T12:05:17.8541433+00:00", "db_currency_id": "b2466b3a-202f-44b0-ae30-3cb51906ace1", "db_currency_code": "sample string 10" }, "company_type_id": "e47f76fa-8759-4288-ba2b-5369871f76c9", "company_type_name": "sample string 32", "company_type": { "id": "1bd6dfde-c262-4ddd-9a2a-76f4e4ed78f8", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "fc2a246d-2ba2-4d79-b1d3-48c66ef07271", "sales_organization_code": "sample string 5" }, "db_language_id": "36c6902f-5ec1-4f9b-b703-2b4103dec9f4", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "580c1375-e33c-4dfe-81fa-4bd45d20127e", "article_price_label_code": "sample string 37", "db_payment_method_id": "b9e111b0-8210-4ff2-bd5f-9e11a75196d5", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "6c578f9e-53a9-488e-8ddd-7269a6ee9c9a", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-04-20T12:05:17.8541433+00:00" }, "company_sector_id": "07940e55-e962-4b9e-b720-a6a54ee51b2c", "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": "f36f3b0f-3cfa-48fc-ba5e-8fc4fc198216", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "5cf6817e-964e-4072-83b6-b377882e5f5b", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "f4409ebd-5c6d-4569-bf50-be1cfdbb56d3", "account_manager_user_code": "sample string 56", "company_status_id": "aea7eb61-344f-46a6-afe4-be723834d3b0", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-04-20T12:05:17.8541433+00:00", "id2": 60 }, "db_language_id": "fa73ff16-6d40-4b79-8736-edb88261b6e9", "db_language_code": "sample string 7", "db_title_id": "4bca69b2-69d6-458a-86af-ad6a5ed64f3e", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-04-20T12:05:17.8541433+00:00", "create_date": "2024-04-20T12:05:17.8541433+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-20T12:05:17.8541433+00:00" }