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": "a4bc491e-e357-42ae-8ebe-b46bf54d93d1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "732cfb22-9cb4-408e-ae55-3c723cf4a7c2",
"company_code": "sample string 5",
"company": {
"id": "524c91cb-09a6-487c-98b0-68ec9c929def",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-28T04:37:58.533195+00:00",
"sales_territory_id": "b6b807d9-b11f-4b5c-9136-d20788ebee48",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "564a2185-4424-4a14-8a7e-6a44fe57bb91",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b3502a34-53c4-46f2-84fb-3beb31a7a555",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "579da1f3-9dff-4ecb-98a7-c2b2adecad60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba083fd5-15de-4d67-ad5e-981ff2267e44",
"db_currency_id": "984d18f3-341c-4585-adfd-ffff672bcfd9",
"db_language_id": "29364a44-a6e1-49be-9e49-dfb95247e5e5",
"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-28T04:37:58.533195+00:00"
},
"modified_dateutc": "2025-06-28T04:37:58.533195+00:00"
},
"marketing_segment_id": "da507ae9-bd56-459e-9bd3-dff1b289e503",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a30d2a4b-bcda-44f5-8772-358e96a2dd3e",
"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": "943981cd-42e2-4d37-a990-136359d18de6",
"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": "650f3eee-8ff5-457f-a2bf-e68b940c6da0",
"db_country_code": "sample string 28",
"feelist_id": "c201139e-f9ec-4acf-a68a-4e900ca6d5a5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ef0102fd-2c39-4caa-b1fb-7785a8a276b0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5a400c4c-4734-43af-86fb-5447b45d624b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-28T04:37:58.533195+00:00",
"db_currency_id": "2ae8d4e0-3f76-4105-b625-da09e3a0149a",
"db_currency_code": "sample string 10"
},
"company_type_id": "059d649c-4a04-434c-a270-400493839033",
"company_type_name": "sample string 32",
"company_type": {
"id": "26032ab3-18d5-4a25-adb5-407ec58e7689",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f5e0d81b-8ef2-42f1-8a2c-9c3fc347cdd8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ea97b8de-8edb-46a3-8495-263174200188",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d7eb1202-00dc-4ef7-8ff6-e036533b2eeb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "af57df2d-2b20-4a27-a04b-f2f1b5a2e499",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "96956e26-07cd-4c64-8d43-2db41fadc219",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-28T04:37:58.533195+00:00"
},
"company_sector_id": "468482d5-1c43-4841-b0a8-02d081b1d9a4",
"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": "d9c2bcf3-d90e-4b04-b84f-08cc34c2e074",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "484fce26-213b-4a81-aad9-a34ae3a439ba",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dcaf6ea6-74df-4045-bc85-d2c8d1dd5426",
"account_manager_user_code": "sample string 56",
"company_status_id": "69d0fb91-601a-4813-a20d-d97b639a5c95",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-28T04:37:58.533195+00:00",
"id2": 60
},
"db_language_id": "a99f17d8-747b-4e4a-ad5d-3949a1078fbc",
"db_language_code": "sample string 7",
"db_title_id": "45bf9445-3796-456a-865e-549bb1441f26",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-28T04:37:58.533195+00:00",
"create_date": "2025-06-28T04:37:58.533195+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-28T04:37:58.533195+00:00"
}