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": "87c2b058-4eca-4d7c-8e0c-6dd3466069ef",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d0ad92d0-04da-429d-8038-29226db78893",
"company_code": "sample string 5",
"company": {
"id": "d5c6f798-272a-4c96-9fd4-2215549b36a3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-19T16:49:30.578401+00:00",
"sales_territory_id": "63341f7b-3036-4afb-98ad-dd03e8fc300e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9f93b551-d2c8-4993-a961-04b34a765d07",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c0e4d340-c8bd-4f73-a277-5a092f73df9a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3cf8d3b7-e1d5-46a3-a418-2b772eec7448",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f001da0-a3e6-4f34-9dfd-aadf6c7386ef",
"db_currency_id": "75954040-c8b3-4942-b6fa-df93bb012185",
"db_language_id": "5dea20d9-62be-455b-9b8b-321bd50ffab3",
"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-12-19T16:49:30.578401+00:00"
},
"modified_dateutc": "2024-12-19T16:49:30.578401+00:00"
},
"marketing_segment_id": "117a3dc2-13b9-4b30-995a-29230e80e5fd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0e0ff7bf-c16c-46d1-a97d-c1a1605e5c8b",
"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": "b8606419-db17-44f2-929d-6e52933d7135",
"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": "1a8971ae-6ea2-4ab9-97c6-7f26b0805148",
"db_country_code": "sample string 28",
"feelist_id": "87ad8e57-080d-4b26-8632-3cf327514551",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "070fbfcf-ec59-405b-9f5a-648c83108460",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6c61c4df-19d0-4f15-a624-25aff462347f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-19T16:49:30.578401+00:00",
"db_currency_id": "adfa7c72-436d-4c83-ab53-18b3632b5b15",
"db_currency_code": "sample string 10"
},
"company_type_id": "4972c9d1-8d67-43b0-998f-70dc5df40fc6",
"company_type_name": "sample string 32",
"company_type": {
"id": "f0aff98b-18d6-4ac9-bd19-6433c9c93d63",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1348c7bb-2070-4476-a374-c864278c29c2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bd4598cb-6e81-4166-9b35-1b2f0fcc3e9e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6668c604-7adb-45db-a2da-51c242bfd0ec",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "833c9e0e-d042-4ee5-8297-8086256614ad",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d5fc7a12-fd34-4838-abc6-0a263664a306",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-19T16:49:30.578401+00:00"
},
"company_sector_id": "0badb647-f70f-4fee-ba42-49e80df609de",
"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": "ac259540-4563-438f-8781-e464e8bb594b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6c2ba624-7167-4e81-9f7e-a5c120cd521b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ea12a795-b7c5-450f-a7bd-68a114b1695d",
"account_manager_user_code": "sample string 56",
"company_status_id": "25841a03-b36b-43f0-a9d5-08e60db7d06b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-19T16:49:30.578401+00:00",
"id2": 60
},
"db_language_id": "a91260b6-e065-41ae-beb4-3cb8d100e42b",
"db_language_code": "sample string 7",
"db_title_id": "a612fbff-c110-4df1-93ae-29dac74affa2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-19T16:49:30.578401+00:00",
"create_date": "2024-12-19T16:49:30.578401+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-12-19T16:49:30.578401+00:00"
}