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": "f84b55c8-9269-4ac9-85e2-7b606b34c48b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b76fd7dc-806f-4fd5-bddd-c65c522bdad2",
"company_code": "sample string 5",
"company": {
"id": "33a9431f-89da-4581-8f45-b7998af7814e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-18T06:25:39.5513893+00:00",
"sales_territory_id": "02d0725a-ca3d-4608-b9f2-4a8aa7b87426",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4036691b-3100-4df1-9967-944f78885f03",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5f85d788-b7b6-4287-b509-d3c8f4f4a2c6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "59ef122e-d17f-4a43-9b49-d14c45457ab8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0f5a4b3-fc9a-4108-8bae-4ccecca7ac1f",
"db_currency_id": "21240ac1-1133-4738-87b4-4cdaf0a1b4d1",
"db_language_id": "3c0892a8-c35a-4fe2-a6ac-53f286c49caf",
"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": "2024-11-18T06:25:39.5513893+00:00"
},
"modified_dateutc": "2024-11-18T06:25:39.5513893+00:00"
},
"marketing_segment_id": "f3edc3d4-914f-4b23-8a9e-6e89820c50c6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d90d7c10-b636-41df-b427-095b25f11a55",
"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": "16a6a053-b365-4257-a8c5-88b145796ab5",
"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": "a19e2968-cea0-4554-9464-d16933a2fe24",
"db_country_code": "sample string 28",
"feelist_id": "047b79e2-3b1a-448f-a22d-ae698dd7cc85",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6851acd5-6ac6-4616-b404-e0af61e7908a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e6b889d5-0d10-47d4-b380-e1a6f73c7096",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-18T06:25:39.5513893+00:00",
"db_currency_id": "0f5b2cc3-078c-4ea1-b6e2-800372029e4e",
"db_currency_code": "sample string 10"
},
"company_type_id": "ffb260b3-5c58-46d8-8dd5-3de085a30866",
"company_type_name": "sample string 32",
"company_type": {
"id": "af11f368-df4d-411d-a277-84935e379c04",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "93108709-f53c-4366-84e1-09b427ebb40f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c3967f2a-97ea-4481-8df1-28428c7e9538",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c48599e0-600a-4bc1-99b1-053a150c5bb2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a5d0692e-3334-4f9c-a14b-2c7fd151751b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "87bdb2bd-2b33-4e8b-998e-2f57c534f258",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-18T06:25:39.5513893+00:00"
},
"company_sector_id": "1726b7d7-babd-4cba-982e-2daa635299df",
"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": "916ec646-5c3f-4df7-885d-2b72c28ed3ec",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f9473c2c-2fa7-444f-a79b-a3792a9236d0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1bcdb30d-57fc-4c1c-b084-32623db9f53c",
"account_manager_user_code": "sample string 56",
"company_status_id": "ed9079f6-6142-47cf-936e-70ab5d555f31",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-18T06:25:39.5513893+00:00",
"id2": 60
},
"db_language_id": "a15fe479-e4b7-409b-96f2-d4fab09d9917",
"db_language_code": "sample string 7",
"db_title_id": "af61798d-bc56-4577-8e44-7537bc4d6d41",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-18T06:25:39.5513893+00:00",
"create_date": "2024-11-18T06:25:39.5513893+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": "2024-11-18T06:25:39.5513893+00:00"
}