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": "822a22fb-c483-490a-bad0-16f99c4e82b5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1a6ace1c-d60b-4202-95b8-41f068f1b5e4",
"company_code": "sample string 5",
"company": {
"id": "d6a7992f-6e6c-43cb-b3ac-284c0f26ff75",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-03T03:53:00.7839807+00:00",
"sales_territory_id": "61c4e513-d846-4c8a-81e9-ff0898a86125",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e3fd6a48-5c6a-4902-88c8-31844b3fd1e9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a8abf619-0146-43dc-9208-73032c24685e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "30737e60-740f-4e16-8254-7fccd654498b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "943cbeac-7edb-4e27-b5b0-a2123a859d46",
"db_currency_id": "cccbc03a-6efe-4fa6-90d0-47580c4727f9",
"db_language_id": "cd198823-6b18-4b16-b398-566956338a89",
"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-03T03:53:00.7997192+00:00"
},
"modified_dateutc": "2025-04-03T03:53:00.7997192+00:00"
},
"marketing_segment_id": "56f9e232-1908-48a2-b301-5dc5d3bbb188",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "adce6d7e-1760-47fd-ba42-52a95eaa82df",
"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": "aa3de98d-c37f-43f2-903c-4372444b0817",
"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": "e809d27d-c15c-462a-8073-0f45467285f5",
"db_country_code": "sample string 28",
"feelist_id": "944a5e03-40c0-4c62-bb54-2f47ea14b06c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "06d4c9bd-3d47-4e8c-9f9e-19cfe28257f1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "40188c01-5248-4437-9649-a2a63728f516",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-03T03:53:00.7997192+00:00",
"db_currency_id": "c1cc51df-943a-4bc7-afb1-4acbb58c6937",
"db_currency_code": "sample string 10"
},
"company_type_id": "a281dade-c8a5-434b-aedf-7672a0363bed",
"company_type_name": "sample string 32",
"company_type": {
"id": "adcc5f0f-fc25-454b-b64c-89ecfcf95e75",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "09915580-e2c0-4b07-be1c-2a7aabfd80e2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "906b73e7-fdfe-4ff8-9ef9-19dcef0f4200",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5a1e6700-90f8-47cd-aa38-068f213a4ca6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a37886c8-ee03-4402-9bcc-d13fc04df4be",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "92169f0f-b051-4ac5-9346-66096c556590",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-03T03:53:00.7997192+00:00"
},
"company_sector_id": "2b58ba9e-be48-4ec2-be29-6b69b778e141",
"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": "7f4881af-f4d4-42b7-88ad-69363b20d2dc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e82d77b0-c618-40cc-9277-0bf27d714d52",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b407246f-f894-4b5f-9338-be83804ff6a3",
"account_manager_user_code": "sample string 56",
"company_status_id": "d444ac76-e719-4e36-81b1-ea38acf86c9e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-03T03:53:00.7997192+00:00",
"id2": 60
},
"db_language_id": "83fe1857-67ce-419c-82fc-5d8637b7cf3a",
"db_language_code": "sample string 7",
"db_title_id": "8894cd81-65c4-4e94-9a4f-bed1bf7dea12",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-03T03:53:00.7997192+00:00",
"create_date": "2025-04-03T03:53:00.7997192+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-03T03:53:00.7997192+00:00"
}