Retrieves the company 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": "0b855115-9cdb-427e-8ffb-e0d1ef0c7b16",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "95912ce5-758c-4ce5-a33c-b348e70fe979",
"company_code": "sample string 5",
"company": {
"id": "7a7cf402-10fb-4694-905d-bc487b7f8993",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-21T16:55:22.2599151+00:00",
"sales_territory_id": "eec40325-d2cf-4e0b-a2ae-13e8a40bd40f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1bef08ba-82ff-4f14-8ac2-4face2d8cf4d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c7ffb6f4-0c68-4ac5-bc38-ca6bf8acac7b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4c091928-6c67-460f-9277-38c91b802b14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "20d41b6d-8de1-4c56-a28b-8cc5ba633cb3",
"db_currency_id": "bbb9e46d-d766-42f9-a38f-cfaaf22f33f4",
"db_language_id": "6d429f7c-01ba-487e-a9ef-864ed7c90564",
"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-21T16:55:22.2599151+00:00"
},
"modified_dateutc": "2024-12-21T16:55:22.2599151+00:00"
},
"marketing_segment_id": "1c63e992-da04-4684-9053-e23632700403",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2d1a936d-8f0c-4ae2-8a49-8a99836f714e",
"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": "5f39f213-4363-4e39-9e15-47bb05b13e82",
"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": "4bbb23b7-3d83-4e24-9c4f-03eb8fad5b77",
"db_country_code": "sample string 28",
"feelist_id": "405bdc83-842c-4b31-bde9-da2dba3880e6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4308dbcc-0b8c-45cb-a016-b5f6efb24654",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "da16a627-d539-46ad-a6b2-abac6f340d5c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-21T16:55:22.2599151+00:00",
"db_currency_id": "695dbba5-7527-40ed-a905-b253421a5c92",
"db_currency_code": "sample string 10"
},
"company_type_id": "191d62c7-4380-4be3-986a-e78ce8185108",
"company_type_name": "sample string 32",
"company_type": {
"id": "e663c298-a676-4292-ba7c-30046244d71e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "70ec0b7e-dff7-46bd-847f-539e9143d140",
"sales_organization_code": "sample string 5"
},
"db_language_id": "497c84be-a84c-4083-8c95-fea1fc284cba",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7af03ef5-d62a-409d-be31-e7ec238fc24a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6cdbab22-6f8c-428e-a22f-e7e506af7aed",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c528a52a-1990-400e-9d49-353b6aaf71c9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-21T16:55:22.2599151+00:00"
},
"company_sector_id": "63148437-c445-4364-9cb3-b205a531de8b",
"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": "145e941f-3bfa-4c6c-b6c2-a376dc6dbeaa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a9e49449-8a09-4cf7-86c8-c1af9faf88aa",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2b84ca64-fd57-44fd-a22d-9ed723a1551a",
"account_manager_user_code": "sample string 56",
"company_status_id": "304d4139-139d-4d40-8c19-fa6d0d8ccb49",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-21T16:55:22.2599151+00:00",
"id2": 60
},
"db_language_id": "8f5c4d56-b986-4446-9ce0-4a33de6a23f6",
"db_language_code": "sample string 7",
"db_title_id": "b4686e18-57c8-4a01-9502-3133f619f668",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-21T16:55:22.2599151+00:00",
"create_date": "2024-12-21T16:55:22.2599151+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-21T16:55:22.2599151+00:00"
}