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": "85ae9877-ed7c-43f6-9793-c323238b1ed0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1867eb6e-2cf5-4822-9a1a-dab15aff39ba",
"company_code": "sample string 5",
"company": {
"id": "22e447f2-3977-43f0-897f-081a23511362",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-20T11:13:26.4114067+00:00",
"sales_territory_id": "1c92650e-ac4c-4453-9698-4fe54d24cb64",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8c947ff7-6dfc-42ef-a0ef-fb2459412f70",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "64b066bd-1c63-412b-a434-0bff74a86536",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a8df7516-36a6-4240-9ecc-f48f6425ff82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8efc680a-322a-464b-91ed-0a2bb9bf5343",
"db_currency_id": "9c37b9bc-0faf-4882-94bc-b47be7fd1070",
"db_language_id": "c34f56e3-3239-411a-b3f7-ab2fb03d0f86",
"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-11-20T11:13:26.4114067+00:00"
},
"modified_dateutc": "2024-11-20T11:13:26.4114067+00:00"
},
"marketing_segment_id": "900a91b5-9b5a-477f-925d-136f64f78961",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7513d0d3-008e-4744-b1ad-044255921049",
"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": "4dd7f0b9-a2b1-4851-8e72-cb9a71185d95",
"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": "6fe260bb-7064-42aa-82b8-fcb1d28d9cbd",
"db_country_code": "sample string 28",
"feelist_id": "9bd0f311-6fbb-4b00-94e4-2e1497aa66d6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8ef9d065-722e-4acb-8d24-b13e09e91a29",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3d295e67-e482-4aec-bd3c-3df313bd4847",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-20T11:13:26.4114067+00:00",
"db_currency_id": "e6f78a84-3591-4c91-b7ae-6eb2f3065d08",
"db_currency_code": "sample string 10"
},
"company_type_id": "c0f5a4dc-ef56-4666-b2b4-80a61af2e16b",
"company_type_name": "sample string 32",
"company_type": {
"id": "add8e9c9-11da-4b79-a6ce-9a7cb6699923",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "77c8e9b4-dd1e-4e3e-8c00-0c2905b2e13b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "84bc3589-7265-44f1-b7ad-90df0b4c5bef",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e3a972ab-f7ad-4deb-bc11-64b433ae19d5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fef77f18-b567-414f-943f-8cd57c5d308e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6a70f4ba-5fbb-47a3-b24c-1a5967d94b6c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-20T11:13:26.4114067+00:00"
},
"company_sector_id": "c19a808b-68dc-42b5-86e0-c1b5f175685e",
"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": "730000c7-aba3-4eb8-b421-40d9aa67d882",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "17fc1850-2952-42b9-a797-011cefca01dd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9b1d67fa-0e4b-44d0-baa5-ae649e628ed4",
"account_manager_user_code": "sample string 56",
"company_status_id": "7eb5cc35-4564-4b64-8121-4805589bf1bd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-20T11:13:26.4114067+00:00",
"id2": 60
},
"db_language_id": "9733a009-d6cf-475b-9fcf-cb8e311182b9",
"db_language_code": "sample string 7",
"db_title_id": "d36ca0a7-8356-4271-9cd1-3c904bb62269",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-20T11:13:26.4114067+00:00",
"create_date": "2024-11-20T11:13:26.4114067+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-11-20T11:13:26.4114067+00:00"
}