Retrieves all the contacts
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": "7c55e015-baeb-4608-a24c-e21aaa03fdb3", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "9952e114-f6ca-4ac8-a24b-6d55d511d8d9", "company_code": "sample string 5", "company": { "id": "4ca133eb-bdc3-4640-ac3c-5f413f1fb182", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-10-22T08:55:02.6151022+00:00", "sales_territory_id": "60f2605a-740f-4544-94e4-20653f72fbd4", "sales_territory_code": "sample string 9", "sales_territory": { "id": "4461c276-9aa3-4e8b-a9b5-67532ddb7b5f", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "3844fb02-57ee-4793-bbda-a986f51dd259", "sales_organization_code": "sample string 5", "sales_organization": { "id": "9f312e65-9933-4b24-a475-b662d43b84d7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "45a87a69-b076-4472-b625-5b4389423847", "db_currency_id": "4a9c59c0-fb01-4064-9306-c3185397f9c0", "db_language_id": "93db0f03-e130-4e97-b6fd-7769ced80c4d", "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-10-22T08:55:02.6151022+00:00" }, "modified_dateutc": "2024-10-22T08:55:02.6151022+00:00" }, "marketing_segment_id": "f361fa46-80fb-4752-b4fc-189d4814f9cf", "marketing_segment_code": "sample string 11", "sales_organization_id": "52bea528-e32b-4f5e-9d68-ef97460f3c90", "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": "707a6745-f0a0-4cf6-9d8d-1594e266d652", "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": "4de451bf-8ad3-4a9c-a7fa-31e0316d0aca", "db_country_code": "sample string 28", "feelist_id": "86030dd8-393d-49a7-b712-7594fc02a741", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "a934d5fd-1973-42c2-9c9a-afc1b64a3d47", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "50b9fd0a-10e1-440c-b2b4-c2cf678f651c", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-10-22T08:55:02.6151022+00:00", "db_currency_id": "3e855b94-72d6-4d53-bee6-e74decc09841", "db_currency_code": "sample string 10" }, "company_type_id": "2e7d91c7-afb0-40c7-9607-e778bd9c0b41", "company_type_name": "sample string 32", "company_type": { "id": "80875a08-0826-4141-a709-c205f04bcc54", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "d164a617-0b3d-47b5-a988-6d6d026813b5", "sales_organization_code": "sample string 5" }, "db_language_id": "57572a3a-a380-46b5-afba-0e80c7c35f84", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "f3679512-ace1-4514-9874-e1a2b3a2043e", "article_price_label_code": "sample string 37", "db_payment_method_id": "b5b5abc3-e017-4fc0-981d-7cd23245fff7", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "282d9620-043e-4104-aa4b-a8dc57aec2e8", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-10-22T08:55:02.6151022+00:00" }, "company_sector_id": "67e6dc8f-0466-4bb5-9b0a-528f355ff88e", "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": "6f8cbe9b-0382-4794-8c1e-9e75dc726eb5", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "c8d23472-61c8-4a26-b5f5-ee557dc67089", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "a862a269-3f85-4118-8be9-b384679b7bb6", "account_manager_user_code": "sample string 56", "company_status_id": "1a76bcb2-0547-4adf-8833-4182c411ccdd", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-10-22T08:55:02.6151022+00:00", "id2": 60 }, "db_language_id": "abde8a10-b364-414d-9a9e-e874d9c7842a", "db_language_code": "sample string 7", "db_title_id": "3bf101c8-078b-4be8-a320-6680434413a2", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-10-22T08:55:02.6151022+00:00", "create_date": "2024-10-22T08:55:02.6151022+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-10-22T08:55:02.6151022+00:00" }