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": "bad77fdc-ab48-4999-9d86-bb3a2cdea290",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a65005b4-e125-467e-9b60-07570d15eb50",
"company_code": "sample string 5",
"company": {
"id": "a29c0558-5601-4652-961c-a60d9a0e5b9b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2022-08-17T03:19:28.2323448+02:00",
"sales_territory_id": "b10c57ac-e114-4e9b-a777-17dc51fe9dd4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0a0d99ce-0e96-4ba9-9ddb-d5096cbddf58",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a9ed05f4-fb6f-4689-88cf-64bba608f7fe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d0f68ac1-84de-4429-a161-fd1c143fbac7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e05d9eca-4e1e-4a6f-a9e7-ccbafd81c0c4",
"db_currency_id": "81b7984f-2205-4563-b830-b656eb3c5c6a",
"db_language_id": "7f972157-ff5b-45ea-8ec0-c5cb369d660a",
"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-08-17T03:19:28.2323448+02:00"
},
"modified_dateutc": "2022-08-17T03:19:28.2323448+02:00"
},
"marketing_segment_id": "4be8762b-ca3d-435b-b9ea-630ab3e9a8c5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4caca767-af14-4946-873d-915e5099e656",
"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": "75d320e3-3dc5-454b-b698-61fb291164b0",
"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": "b66261a0-f03c-4161-bdec-e209e3d0b221",
"db_country_code": "sample string 28",
"feelist_id": "d867247d-9bee-4bae-842d-57f726ddaf1b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6cf14bf1-e038-4ce0-a5bd-0078e96851de",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dea23738-16dd-42aa-b2f8-9660ab930592",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2022-08-17T03:19:28.2323448+02:00"
},
"company_type_id": "10298b8c-633d-4346-89cd-7ef60c286aae",
"company_type_name": "sample string 32",
"company_type": {
"id": "292f9443-ceb0-4b5a-b6f7-581be9d26ec5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e9d6bcd5-ea5a-4154-84ba-7e0ac9aab517",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6060763e-6022-4cdf-9d70-5c6c672c4a7e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7471f1b3-573c-42d6-aea0-d4c87e200222",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "734997d3-9341-4569-b471-28feeb969e16",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d806a5e8-0d35-4962-83c7-99590caa70c5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2022-08-17T03:19:28.2323448+02:00"
},
"company_sector_id": "cd8cddf3-e4a4-4feb-b340-5f5786251cb7",
"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": "87f7cfa3-995e-498d-a1d9-91367f550e0b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8f0a8431-fd8f-4379-95e7-ab918c8290ef",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "edda86ef-f7cc-44e9-a11a-5211ad88939e",
"account_manager_user_code": "sample string 56",
"company_status_id": "ecb78755-4a6a-462d-bad2-9219c78cc9f1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2022-08-17T03:19:28.2323448+02:00",
"id2": 60
},
"db_language_id": "a28c4961-6433-41ab-8189-7058161f49e4",
"db_language_code": "sample string 7",
"db_title_id": "6bf115aa-8548-4ded-9927-ebebd4b419c7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2022-08-17T03:19:28.2323448+02:00",
"create_date": "2022-08-17T03:19:28.249166+02: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-08-17T03:19:28.249166+02:00"
}