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": "7bb95389-e9a0-422a-a7dc-98fddf8ebee4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8f3d1ce4-c256-4a45-959d-822c1f37ae24",
"company_code": "sample string 5",
"company": {
"id": "5d459fb6-45e3-4da3-8a3c-7631f46a0b12",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-18T01:46:41.5756787+00:00",
"sales_territory_id": "5c1741cb-fbeb-466e-b6b0-eb0e77ecebb5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c5ebb788-c8e3-4d04-ab10-b735a143fa55",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "760b8682-1efe-4ce1-834e-9fc32f3a2d6f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "93c9c812-7dba-41a5-b725-93ff4e6a09ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "27d05876-df03-459e-be01-8f9e688c7670",
"db_currency_id": "a23f8005-6c82-4303-8d23-084a7cccdeda",
"db_language_id": "c393f589-4500-43a4-a8c7-bd866326aa6b",
"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-05-18T01:46:41.5756787+00:00"
},
"modified_dateutc": "2025-05-18T01:46:41.5756787+00:00"
},
"marketing_segment_id": "dc09dca9-12d9-4037-90bc-ee3f23322e00",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e3b46e49-5f07-47db-aa96-b173b04d145b",
"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": "2d7c3aec-c4f3-48b0-82ab-0431a25bb0ea",
"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": "b53a7dec-a3db-4e13-9664-eb0ec3aa88d0",
"db_country_code": "sample string 28",
"feelist_id": "50009575-751f-4d99-a2d5-352e405498b3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "56e81b16-c454-4fe3-b765-d29bf2988290",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "baf44f81-40f7-4fc8-a960-06ff9c970d29",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-18T01:46:41.5756787+00:00",
"db_currency_id": "99dd798a-ddfe-41b4-af46-56ef6310f5da",
"db_currency_code": "sample string 10"
},
"company_type_id": "5e288414-af4d-4b62-aa42-df8b8e5ed034",
"company_type_name": "sample string 32",
"company_type": {
"id": "80d05d50-ca43-4339-954f-768e29bd7e64",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7368c914-4cfc-4660-aa95-b538aeedc578",
"sales_organization_code": "sample string 5"
},
"db_language_id": "13f3d22c-a916-4124-89f2-d7cd3d081e0b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5a2dacc0-02d5-4f85-b0e4-3cbc654049b7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "60b7b4c4-28af-4132-9dcf-da574d2521fc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b39750c2-2b0d-4705-b962-65563bf9f648",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-18T01:46:41.5756787+00:00"
},
"company_sector_id": "9ed9340e-ccf6-4439-9edd-9b467cdf14fa",
"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": "6f317930-d5c6-4949-83f5-ff7800d8dc5a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "be333e5f-7b4a-49e2-af80-d8673e64c5e0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "44ed693e-fcc0-4e5e-a404-97a5cce5c1c1",
"account_manager_user_code": "sample string 56",
"company_status_id": "179d9875-a605-4121-9846-7497fd1f8c9d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-18T01:46:41.5756787+00:00",
"id2": 60
},
"db_language_id": "ab088a5d-9add-405a-b6ac-b6979c5b9797",
"db_language_code": "sample string 7",
"db_title_id": "40ba7d4a-0deb-495d-83e9-472b6bbdea37",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-18T01:46:41.5756787+00:00",
"create_date": "2025-05-18T01:46:41.5756787+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-05-18T01:46:41.5756787+00:00"
}