Retrieves all the company contact
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
contactName | 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": "1fabf430-d60c-4ba3-935b-5d5940ed0a57", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "0beff9ca-ad96-42ec-bfb1-f6a04a154391", "company_code": "sample string 5", "company": { "id": "ece50011-30f5-4238-9484-b134dafc25e7", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-03-31T21:29:13.601868+00:00", "sales_territory_id": "c367559d-f1cf-456d-8d87-8f654f3fa7d5", "sales_territory_code": "sample string 9", "sales_territory": { "id": "e4c7616b-6a09-4c11-9a7b-7b42784b34a7", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "dbbfbe26-d293-4df9-acc8-79895a8575ea", "sales_organization_code": "sample string 5", "sales_organization": { "id": "71ca5bc6-36de-4003-bb09-0afdae1f0c53", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "feb7a966-c971-41aa-afba-d3992b2b55fe", "db_currency_id": "7ec9081f-3ba8-44bc-9921-9fc9e1c1ad51", "db_language_id": "b37fe629-fce4-4b93-8ba6-5bdad9fc0d98", "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-03-31T21:29:13.601868+00:00" }, "modified_dateutc": "2025-03-31T21:29:13.601868+00:00" }, "marketing_segment_id": "f428484a-1c63-4801-b99a-0e84b5db7e83", "marketing_segment_code": "sample string 11", "sales_organization_id": "26134e73-b98e-4998-aeab-9f3d3cb3a982", "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": "91f0db8c-6e27-4e99-bca8-fb88dcdefe44", "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": "2f4c3551-e43a-4874-abd1-978dd2b86381", "db_country_code": "sample string 28", "feelist_id": "827af97a-c251-4af7-970d-f7351939f5c2", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "e166ca8b-56ae-4138-ba44-92b4aba2d4fe", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "25076195-4d7f-449c-a643-a9b354562bdb", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-03-31T21:29:13.601868+00:00", "db_currency_id": "85498ddf-bee4-4919-9a2c-61873c46f02a", "db_currency_code": "sample string 10" }, "company_type_id": "c564a3c0-6eb2-4747-bd7c-de816bb04e28", "company_type_name": "sample string 32", "company_type": { "id": "81743da7-c253-4886-88c0-ae8ea34959e1", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "0ddd68f7-72b4-402d-a710-8f592de01f89", "sales_organization_code": "sample string 5" }, "db_language_id": "525b3b51-9604-47f7-a3f0-cd17e41e239e", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "844c3968-d702-4945-8b40-bf4657dfd401", "article_price_label_code": "sample string 37", "db_payment_method_id": "cd2162a0-bc44-4c03-b1a4-87d39f8a4608", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "d2c5407e-a12f-495b-a6b4-960e986b0eb9", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-03-31T21:29:13.601868+00:00" }, "company_sector_id": "26c681ee-4400-47d0-a3a1-d781a0670420", "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": "39f96646-8a5f-4135-b87d-14db2923ee9a", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "5f09cf7f-a6ba-466f-8953-e1aeabf64bff", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "8d95dc2a-e14e-4e1a-9653-58659bbc68b2", "account_manager_user_code": "sample string 56", "company_status_id": "7f3c46a5-0421-44b0-b755-483859a6be77", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-03-31T21:29:13.601868+00:00", "id2": 60 }, "db_language_id": "acb7117c-6623-44a9-b07c-83ab7a63f221", "db_language_code": "sample string 7", "db_title_id": "284a3b8c-f85f-4782-8943-db8e19203db8", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-03-31T21:29:13.601868+00:00", "create_date": "2025-03-31T21:29:13.601868+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-03-31T21:29:13.601868+00:00" }