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": "a4aa594a-c434-4687-a407-d65f740477d3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3e77f571-f2d1-445a-b8c3-cc1d4a6aa85a",
"company_code": "sample string 5",
"company": {
"id": "72cfb0fb-31b2-44a1-a44c-781fe8a2888c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-03-19T20:26:51.750415+00:00",
"sales_territory_id": "048b8344-399e-4576-8724-0f34e068bb22",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0940b799-b415-4978-b639-d8df83bc9918",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "43bb90f9-edab-42ff-8adf-8f65ae3dcca8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c407f437-fa6f-4ee1-9c5d-67e951e11b37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e287d16-97ba-4fe2-856c-e7210f28dbc3",
"db_currency_id": "a3b0e502-9fde-451d-b266-51fb9e339740",
"db_language_id": "a71bc51b-e517-405d-afab-77851f95fb43",
"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-03-19T20:26:51.750415+00:00"
},
"modified_dateutc": "2023-03-19T20:26:51.750415+00:00"
},
"marketing_segment_id": "43a1f7b8-c645-4710-85d4-a19f5ad5e3e7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3b3e5437-9df4-4a63-94e7-12e6c80c9287",
"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": "24bf4602-93b7-4c58-8ede-983763016fe0",
"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": "7752551d-80ff-4041-8f0a-8dd2966ec909",
"db_country_code": "sample string 28",
"feelist_id": "159560e8-a8d8-4197-abc5-866a57f4019b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "659b8b4c-8823-49f1-8d4a-9f1f224e7418",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "58b3c46a-0d19-4858-b0b1-7346cb7493d5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-03-19T20:26:51.750415+00:00"
},
"company_type_id": "bf927140-dd36-435a-8780-c1d9eedf6a67",
"company_type_name": "sample string 32",
"company_type": {
"id": "a60f7c80-d6fc-4391-87a1-ba4babc38f2a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "776177c1-208e-4970-9da5-46647cf7cb8b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2cf6f33c-40ed-449d-ba54-7c83680d3f6a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b6048113-203c-4e53-bd4c-70547e255616",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a64c8dd2-4a64-4ce5-b7bc-fad7b4988a09",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ed3a8784-630b-472f-93d1-c115d307d8f0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-03-19T20:26:51.750415+00:00"
},
"company_sector_id": "f793eaf8-9796-40b6-a4b1-13e09d9439e0",
"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": "4db457e1-93c7-4544-bc84-0b89577ff068",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eecdb64e-a8fd-4e63-86df-d8e2d06a28df",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4fc256cf-69e4-417e-acad-8b64b996fa92",
"account_manager_user_code": "sample string 56",
"company_status_id": "4870af68-903a-4acf-8d3e-65231c297bd0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-03-19T20:26:51.750415+00:00",
"id2": 60
},
"db_language_id": "430a0702-6041-443c-9d71-c1f1cee00e46",
"db_language_code": "sample string 7",
"db_title_id": "8e8e4acc-8337-4fee-ad64-ae4ddf3b0f3c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-03-19T20:26:51.750415+00:00",
"create_date": "2023-03-19T20:26:51.750415+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-03-19T20:26:51.750415+00:00"
}