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": "a522680a-ba99-475c-9f8d-2c3e0f20e08f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "afca6bb0-b3ec-4eea-96c7-8a5b071fd52a",
"company_code": "sample string 5",
"company": {
"id": "d1d56553-c4cc-428a-846c-4662b512b709",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-05T06:37:02.9869595+00:00",
"sales_territory_id": "345da171-fa0b-4edf-8b39-0e18d26f78b6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0bd4db58-4d25-4487-a9fb-49c4949c4077",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "798dedb8-6410-45ad-a3df-668556e33fc2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "94c8d45b-e6ed-4ee8-822e-c43af38de24b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46a17845-c11c-4835-843c-0a2096fc2553",
"db_currency_id": "565c2310-9cb5-4324-9a93-6900ef78a42e",
"db_language_id": "83a3f7a9-82ba-48dd-a7c3-10fd3e742595",
"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": "2025-02-05T06:37:02.9869595+00:00"
},
"modified_dateutc": "2025-02-05T06:37:02.9869595+00:00"
},
"marketing_segment_id": "646e3739-e7bd-4dc4-ab53-16dd33cfe1a9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7b1bd032-816b-475b-8991-28350de10fe0",
"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": "340e6da0-960c-4893-a9bc-16d7864cc875",
"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": "2f742f5e-49ba-4dce-8476-dc286871824f",
"db_country_code": "sample string 28",
"feelist_id": "551c9ec4-4fa2-45b8-b5a9-8e660e88f6ad",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4ed68db5-9a7b-4405-96ad-7101469e4a8d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d7b76d09-a4c9-4c52-884b-97963b314fb6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-05T06:37:02.9869595+00:00",
"db_currency_id": "6cf1e306-85ce-4465-a820-cec798d83a27",
"db_currency_code": "sample string 10"
},
"company_type_id": "dc2f2f9f-72d2-4639-a594-fd60c309d9aa",
"company_type_name": "sample string 32",
"company_type": {
"id": "dbbdedf2-4b14-47e1-81ad-f954d969cda7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "42d1a7b7-614f-4c18-b109-ad70b4ff0719",
"sales_organization_code": "sample string 5"
},
"db_language_id": "07ae525c-e757-4dc6-a3c0-072f4868c030",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "45a97677-27ce-4a13-92fc-f7103a56c2b1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "34c6c372-afad-4319-ae00-5b66cf034fbd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d15089e5-0cbb-4a7a-94cb-6e34baaf317a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-05T06:37:02.9869595+00:00"
},
"company_sector_id": "174185ee-0af4-4c98-be18-b4b2d223ac93",
"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": "448941f4-70e7-4407-828d-4b7bd1a7eb1d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "916cbf25-f76e-464d-ab36-0e89a37fa07d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0895b6d8-5634-4754-87b5-1e67ed64065a",
"account_manager_user_code": "sample string 56",
"company_status_id": "a0b7691a-5f0a-4c46-b829-1fc20b803d8c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-05T06:37:02.9869595+00:00",
"id2": 60
},
"db_language_id": "670b4f25-0aaa-4eb7-bcba-b6bfbc17cef8",
"db_language_code": "sample string 7",
"db_title_id": "c9ade280-5fd6-42c9-84df-5c4671fcead3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-05T06:37:02.9869595+00:00",
"create_date": "2025-02-05T06:37:02.9869595+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": "2025-02-05T06:37:02.9869595+00:00"
}