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": "c042fa94-d2f8-4617-91c7-7c6c80e4b48b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f3789f27-871c-4960-8fd3-48d8ffb0995f",
"company_code": "sample string 5",
"company": {
"id": "a941e791-a502-4ab5-a91f-b06099e3c5ee",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-21T12:12:33.1736411+00:00",
"sales_territory_id": "e9920418-7ba1-4d82-b705-82d7e5f84358",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f5761c9a-16ce-47f6-85f4-7b09e69c19cd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5cbcfe8-6629-4d7c-8612-2ad4beb37f07",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bf52d872-1667-4e39-83ca-48219a17f056",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91f1f8cd-7e71-4992-a39d-b450fe3b2e0d",
"db_currency_id": "63d69fb3-c319-4a88-bff6-39d2e3da6a3d",
"db_language_id": "b27ebd64-e6e9-41ab-aaf4-cd8832c17cb3",
"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": "2025-06-21T12:12:33.1736411+00:00"
},
"modified_dateutc": "2025-06-21T12:12:33.1736411+00:00"
},
"marketing_segment_id": "152e366e-b3cf-4c18-a3f4-c28044a448d6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "df4f035d-8973-4d89-b377-d143d9762af7",
"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": "c7387979-1dc0-4f3a-be6c-5e09ccb89453",
"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": "78a70673-1ab2-45f0-b6b9-0ee1b2f27b45",
"db_country_code": "sample string 28",
"feelist_id": "8a037931-7d4a-4f29-8808-cf2a1c47bbbc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3439e975-bc66-45e5-ba9c-41359c7e626e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "581fae03-34d2-4432-b878-063d169891ac",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-21T12:12:33.1736411+00:00",
"db_currency_id": "7afed07f-7747-4042-bfea-cbce142b1c38",
"db_currency_code": "sample string 10"
},
"company_type_id": "1caea1e6-cfad-47c4-bd02-b72c40c8732d",
"company_type_name": "sample string 32",
"company_type": {
"id": "5111c739-de6f-405b-95a6-3f358ed685aa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f2b80a5e-bcf9-40a2-bf2b-a6711d147c51",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ed91f2fc-19b6-444a-855b-c41bc7f314a7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "314d0826-f98a-4bdb-a60c-d2f34839c152",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9af18ca1-7fff-4bc0-8c6b-344aaf5dc221",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9a66154b-1ae0-48c0-9198-d48815bfa07f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-21T12:12:33.1736411+00:00"
},
"company_sector_id": "d90ee8ce-8ca6-43ed-bf4b-287a39566857",
"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": "1d014768-a44a-4060-ac57-40ed502ebc2e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "32e13495-4536-4d13-8925-454e963ab6da",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4ed6c0c7-5f29-47ce-b76d-f355b1468690",
"account_manager_user_code": "sample string 56",
"company_status_id": "54913142-9950-4114-807b-aaa59edb476d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-21T12:12:33.1736411+00:00",
"id2": 60
},
"db_language_id": "b4d6b899-386a-4fd6-94a0-7dfbc9e8dbd4",
"db_language_code": "sample string 7",
"db_title_id": "617229cc-3e0e-4866-b7c4-be6a510fa79c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-21T12:12:33.1736411+00:00",
"create_date": "2025-06-21T12:12:33.1736411+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": "2025-06-21T12:12:33.1736411+00:00"
}