Retrieves all the company contact
Request Information
URI Parameters :
None.
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": "dbd82f2f-641f-4ec7-b2b9-b7ab245fe863",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "22237073-7699-4128-a96a-8c780a03bc4a",
"company_code": "sample string 5",
"company": {
"id": "46c9718c-9990-473f-8486-f5ac163926dd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-26T05:17:22.0750896+00:00",
"sales_territory_id": "42e95f18-b487-4a1a-b384-d20d4b34842c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b8be3d00-df84-42fb-9c0a-c7ba9cbaa2ac",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dce40777-8276-4ead-abe3-583895a3723c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4ef21a99-dea2-4a68-9a70-901850098e6e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ad26aa6-b1a2-4202-8b8d-d2bacbeab0d2",
"db_currency_id": "6bb084e6-c849-4b0f-b1f0-10e0d83e0dbb",
"db_language_id": "f4ebc7a5-db90-4eff-9284-86420ae9d148",
"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-04-26T05:17:22.0750896+00:00"
},
"modified_dateutc": "2025-04-26T05:17:22.0750896+00:00"
},
"marketing_segment_id": "878a50d5-f2ff-497d-823f-4bda42f181ae",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5601339a-5f22-432b-b548-7d9ff2fb6a0a",
"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": "cb967383-1135-429a-88df-b55627e59056",
"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": "1f7d3076-e6be-473e-860e-fb0bf8c99f81",
"db_country_code": "sample string 28",
"feelist_id": "b420ab00-12e4-4e3f-9ff6-90ed73e2ba7e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7441a083-6703-4dd7-8b98-c77cb0dd6a93",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cc2d1f30-4089-435f-abf0-522a52e77251",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-26T05:17:22.0750896+00:00",
"db_currency_id": "ee939cc3-a306-4532-94c2-c86e6be5d238",
"db_currency_code": "sample string 10"
},
"company_type_id": "e7a11d54-5cc2-4cdd-8aa0-369373d515f7",
"company_type_name": "sample string 32",
"company_type": {
"id": "7d533f76-9867-4e67-bdce-145cc702c8ca",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "18fa2f2d-e84a-42cc-9e66-60ac0901cab5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "dbf78361-a81a-4e9b-b31b-98e2cac438dc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8c8fa3f7-ceec-446e-8755-4b6c0f44a3ba",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bad7f385-c34a-4c67-afd9-d0d54d66d15d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9a3a177d-b157-4b72-91f4-d59ed5eb41d8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-26T05:17:22.0750896+00:00"
},
"company_sector_id": "611d2d8d-7e09-425a-a9c1-2d23e3a6c562",
"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": "061f295a-065f-4c03-a7e1-3c46fc102f74",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "13f6fe16-7d63-4728-9781-da623e85d94f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "30704f6c-ff13-43b7-9132-a907758a5723",
"account_manager_user_code": "sample string 56",
"company_status_id": "bac250d0-9d44-41f0-9ea0-35a831997718",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-26T05:17:22.0750896+00:00",
"id2": 60
},
"db_language_id": "201da8a8-3afb-41f3-aadf-2051f0a46cea",
"db_language_code": "sample string 7",
"db_title_id": "28251756-b301-43a7-a08f-7fdbaf722777",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-26T05:17:22.0750896+00:00",
"create_date": "2025-04-26T05:17:22.0750896+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-04-26T05:17:22.0750896+00:00"
}