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
{
"id": "adb28dcc-eaf6-4da9-ac42-2cab9b27a49d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9b298fb3-3407-4e62-bb9f-4b6e5a37deee",
"company_code": "sample string 5",
"company": {
"id": "fd7cef01-09b2-4a2c-87c0-a92c9a31bbc4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-30T05:52:08.1202275+00:00",
"sales_territory_id": "6f397444-6ab5-4856-b83f-8647f2cd3c74",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9a4f0d44-85f4-41a4-8e8a-86dd481851fb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "db4101c0-c136-4614-b6d1-f8756531f220",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4c5736fd-24b0-4bf6-9a76-a4563017e7e7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26304497-0e0e-4926-8dc1-572fc14342ac",
"db_currency_id": "e27e2ba8-d909-47f5-91fb-4dc066b63032",
"db_language_id": "89c20f6f-5dc1-4e91-ac20-7c94294fee4a",
"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": "2026-09-30T05:52:08.1358901+00:00"
},
"modified_dateutc": "2026-09-30T05:52:08.1358901+00:00"
},
"marketing_segment_id": "1a4e91d2-a151-4d31-a16a-86adb0b00975",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5570e8ca-d7e6-42ff-b071-38c50f91c119",
"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": "212941be-161e-40e6-bd97-2cedcf305c7e",
"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": "4030bc11-e39c-4144-8977-5622370203bc",
"db_country_code": "sample string 28",
"feelist_id": "563adbb5-8c84-4034-b70b-4e6c27eaab19",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c67ec9e3-0d4b-4e9a-aefc-8c87f859350d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "eb36de4f-15c8-41b6-85c6-dea4fb47fb81",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-30T05:52:08.1358901+00:00",
"db_currency_id": "413f6d78-8551-453b-8a6b-698554470dfc",
"db_currency_code": "sample string 10"
},
"company_type_id": "ecc1a180-6579-4584-a0ff-08ff09f106af",
"company_type_name": "sample string 32",
"company_type": {
"id": "bcf33021-45c2-46d0-97d5-758f511fea2f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0fecb039-4908-4239-812b-15d88a87feda",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3a330f2e-4b57-46f1-8b33-85918f5bdc05",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c2aaf8d8-8121-414b-997c-93179998b005",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8137bf8b-b51f-4859-aa12-93b1a63efc7b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "47f1e5bd-a81c-49ce-a5b5-6ad0b7c343f5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-30T05:52:08.1358901+00:00"
},
"company_sector_id": "dfd405c6-7b7e-4169-af6c-ac590d5499e4",
"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": "d24b9684-603c-49e0-a9dc-f67543a6ccd9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "40d3a295-b372-407d-841c-8074876f9f84",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "655f9a44-132b-45db-b099-adba61402235",
"account_manager_user_code": "sample string 56",
"company_status_id": "33ff2d21-2bcb-4fb7-9101-2efe8401fbcc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-30T05:52:08.1531071+00:00",
"id2": 60
},
"db_language_id": "e6b2a287-79c0-4b01-8aba-ea74f93d814f",
"db_language_code": "sample string 7",
"db_title_id": "13f11bff-77eb-40ba-9080-b76b24f20337",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-30T05:52:08.1531071+00:00",
"create_date": "2026-09-30T05:52:08.1531071+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": "2026-09-30T05:52:08.1531071+00:00"
}