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
contact| Name | 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
Sample:
{
"id": "1ccc1cf1-b7e8-4145-b8ee-78f166990a4d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0e0e0cb5-35d2-41bf-8ba6-c37933b796a9",
"company_code": "sample string 5",
"company": {
"id": "a8eb99f4-d72b-48e5-aced-90834b530732",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2022-12-02T20:28:06.8341924+01:00",
"sales_territory_id": "f3801f09-5f2a-4a90-898d-06393c0ac7f7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "48c99701-55b0-4468-a879-181461bbed66",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c1cb8ee0-ad91-47b2-97ea-c34fb80f93b8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2ce4bf3b-8733-4fb1-a64a-97be27a9d2d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d254bd07-479f-4b06-92f5-4ec39ff4d575",
"db_currency_id": "d3488d88-2bc5-48ed-a332-ae69f4bea15b",
"db_language_id": "2ec5fd6e-221e-4042-982a-854d2531356d",
"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": "2022-12-02T20:28:06.8341924+01:00"
},
"modified_dateutc": "2022-12-02T20:28:06.8341924+01:00"
},
"marketing_segment_id": "ae4684e9-5f11-41c4-bf86-d5352588e5f7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5cfdc805-416c-4965-9c84-03d1af2e6648",
"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": "cc7fb0d7-fa76-48a9-b198-882ea58d2a99",
"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": "76562609-e77f-4f35-8496-9f1ac5f2d7fc",
"db_country_code": "sample string 28",
"feelist_id": "37b099df-43a2-4230-a86b-10b872c8886b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7d0a6095-3dfb-4289-be47-756b52181ebc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b5e0ed01-06e1-4860-9877-87d3a90ed49f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2022-12-02T20:28:06.8341924+01:00"
},
"company_type_id": "20906d88-7f6a-45ec-b3d0-cbce97f1211f",
"company_type_name": "sample string 32",
"company_type": {
"id": "357defad-2405-4faa-99f2-44e15208f5a0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8b6132a5-f086-4037-94a9-a0e153690b1b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7a2b7db1-329e-4f1c-8c26-df66e92a1435",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "eaf22767-dae8-4d86-80f3-33afd005c93b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bb8d490a-a610-4c3b-99c2-2af660972d5e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2e0fbcca-e730-4e67-80b9-5dc597a1333e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2022-12-02T20:28:06.8341924+01:00"
},
"company_sector_id": "2227d97b-e894-4f9d-8318-5eaecaf322a8",
"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": "bddc1c27-6b6c-4dcb-ace3-d2823195f6cc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "28295b1f-3753-44f4-bd33-62c0365b33b4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bd5728bb-efae-4630-8b93-bf424de99f2c",
"account_manager_user_code": "sample string 56",
"company_status_id": "0b298f1e-4b8c-4f4f-bfa9-b54e0fd24631",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2022-12-02T20:28:06.8341924+01:00",
"id2": 60
},
"db_language_id": "1daf86b3-3cc2-43cc-a5b7-17a470fb0e4e",
"db_language_code": "sample string 7",
"db_title_id": "0ecd2445-e21a-44a4-a952-265d572e3b83",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2022-12-02T20:28:06.8341924+01:00",
"create_date": "2022-12-02T20:28:06.8341924+01: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": "2022-12-02T20:28:06.8341924+01:00"
}