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": "f5cb6d3d-6337-4584-9dfb-03b285308107",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0c38f1f8-2a3f-42fa-b310-a240036af24f",
"company_code": "sample string 5",
"company": {
"id": "58b2d081-21b0-45af-bf4a-3ba184355b12",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-09-16T08:07:39.2372618+00:00",
"sales_territory_id": "67eed984-3848-49c3-9fa3-7f382d594304",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "05db27fa-188c-4349-be00-5fa471a2a6e6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7ddc24ca-8f4c-42e8-8598-8b0976beb8b4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bbe6bd7d-7765-4030-97df-287d84eb64a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d51ebabf-39d1-4716-b9e4-111eaa5c5917",
"db_currency_id": "2c417d26-d855-44ed-bb7e-0f90609673fa",
"db_language_id": "1da83773-cf2f-456f-a119-0dd2b4d617f6",
"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-09-16T08:07:39.2372618+00:00"
},
"modified_dateutc": "2023-09-16T08:07:39.2372618+00:00"
},
"marketing_segment_id": "3e7df9b0-a5c3-40c4-a2e0-de2c5d905674",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fd65e90c-9b06-4b2b-8683-cdf5d58feedf",
"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": "2489f71f-ad41-46a1-a1c0-219f3d8b6321",
"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": "726f4edf-1e72-4e71-8fe0-c25a419426e2",
"db_country_code": "sample string 28",
"feelist_id": "0abc6710-32a2-49d6-8b4a-f4c59d5ddecc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f2161d34-4c33-4cff-adcc-ae45186cad8a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1f7677c9-33e0-4a93-8389-b8180b091450",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-09-16T08:07:39.2372618+00:00",
"db_currency_id": "1460bcd3-bbde-430a-8f79-887cc22be9d4",
"db_currency_code": "sample string 10"
},
"company_type_id": "1f68adf4-61fd-480f-bc4f-1fa8b11d5244",
"company_type_name": "sample string 32",
"company_type": {
"id": "6e9247cb-76c0-413c-86e7-4cc7cbc0e416",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9c805343-9b70-4618-a8ce-480db247ec06",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cdd943f1-a236-4461-9a41-3af7d67f3eb5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3e663fb5-77d7-4e40-873f-03443e6e87a3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1c3f6eb7-b99d-4875-a4f5-111cb416641b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "55e564b2-343b-410a-ac98-e172ebbd7a72",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-09-16T08:07:39.2372618+00:00"
},
"company_sector_id": "6157a956-3dec-4616-996e-b1ac557aa1d9",
"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": "aba9dcfb-028c-4fd8-a47d-8d1db770c2e8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cf5142a1-114b-42c0-aab2-dc71ba03dc98",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a20f460d-e67c-4069-8266-3caf4c7d6e5b",
"account_manager_user_code": "sample string 56",
"company_status_id": "34850f81-294d-4982-ab02-33d748ec2291",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-09-16T08:07:39.2372618+00:00",
"id2": 60
},
"db_language_id": "90f2b1fd-8313-4b35-9091-dc4ab20d8b86",
"db_language_code": "sample string 7",
"db_title_id": "cbf23664-2cda-419b-937a-98a03d6bda74",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-09-16T08:07:39.2372618+00:00",
"create_date": "2023-09-16T08:07:39.2372618+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-09-16T08:07:39.2372618+00:00"
}