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": "4bd6ba87-9b67-4b7b-8898-3e23a1b71a3c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "28e22437-e851-46da-a3bb-1a59f32c2f79",
"company_code": "sample string 5",
"company": {
"id": "f1d71e13-7568-4713-8c58-bd250e51eba7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-12T04:43:30.9563793+00:00",
"sales_territory_id": "46a26d04-0456-4db8-93c6-e6309b1889eb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e0c70155-181c-4521-8b89-3061d4972ab0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "734f0505-85c0-40f6-ba4e-d0fc409fd8d6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3899cf17-aa7c-4446-b2a5-aa4ddd54c922",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a688ac0-2d31-4563-b06f-783a1626075d",
"db_currency_id": "bf7a134f-b402-4c3d-9417-7c99685e019f",
"db_language_id": "25341871-77e5-4f1d-be08-8f06e3532e19",
"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-12-12T04:43:30.9563793+00:00"
},
"modified_dateutc": "2025-12-12T04:43:30.9563793+00:00"
},
"marketing_segment_id": "90339831-5ad3-4ba2-802f-d6daa3eafba2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2cdcfa8c-11b6-4ff7-9e19-a2a297bf83aa",
"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": "e4f10fca-8b02-4b05-824e-0717111813b5",
"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": "8d289f51-be4f-4725-b5da-3742efdecd16",
"db_country_code": "sample string 28",
"feelist_id": "6c902824-1b03-411d-b351-95d135928c63",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f436a7f5-e06e-43f0-9089-059de6a8f60b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e17115e2-16c1-4c02-b71b-e1973573107e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-12T04:43:30.9563793+00:00",
"db_currency_id": "157a47c9-0922-4e36-a791-38b551118b24",
"db_currency_code": "sample string 10"
},
"company_type_id": "f96546cd-7155-43b4-8eb9-aeb133a17e09",
"company_type_name": "sample string 32",
"company_type": {
"id": "1e1e2e6a-8592-4454-8019-7396bfdf831a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7b48b994-0644-4166-9f2e-408ecf9fcb37",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2e983bbd-446a-43ed-a3ed-d469cb4b4f1a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7297a00c-866a-4714-a706-31a12647d496",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d7bcacfd-2459-4112-b2e2-ca098aba60b0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e268c85f-77b4-4dd2-8580-f55dd419de35",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-12T04:43:30.9563793+00:00"
},
"company_sector_id": "062ce494-e1a8-4a38-b609-67b050106ecf",
"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": "9af8af47-368f-40cc-8494-8b5f89f9806c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c70ec70f-3f7a-485a-9477-27e62ccdf2ad",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d47a8ba8-f56b-4c59-97d3-d10302a2583a",
"account_manager_user_code": "sample string 56",
"company_status_id": "a098729a-f370-433b-af36-6a1c208389c7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-12T04:43:30.9563793+00:00",
"id2": 60
},
"db_language_id": "f0adddd6-edac-4e09-939b-f95c122e7799",
"db_language_code": "sample string 7",
"db_title_id": "8f443a45-f45f-4d25-93c4-86507928dc5b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-12T04:43:30.9563793+00:00",
"create_date": "2025-12-12T04:43:30.9563793+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-12-12T04:43:30.9563793+00:00"
}