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": "4cd3d3d2-727d-4ee0-921d-65ffd7f9c240", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "cc59c72a-e0ae-495e-9e50-27b94a683748", "company_code": "sample string 5", "company": { "id": "719113c5-3e76-4ea5-afce-fe801eafba20", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-04-18T10:48:38.3146183+00:00", "sales_territory_id": "58cb2e73-ba2a-4d0d-affa-1f4aa3fa4163", "sales_territory_code": "sample string 9", "sales_territory": { "id": "b8f95c61-1bcf-4e2e-afcd-0edba4900918", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "b8fb3786-31e9-40b2-ba3d-acde5699e9d6", "sales_organization_code": "sample string 5", "sales_organization": { "id": "f0bdfc0d-6a6f-4fe0-843c-2959dfea43f1", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "bdc574a7-0a57-411b-a7af-233d2b99e7a9", "db_currency_id": "147129d3-8992-4fe4-9f39-d5e59f1de0f9", "db_language_id": "5cf47697-cde2-4cf3-878c-9148292536fd", "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-04-18T10:48:38.3146183+00:00" }, "modified_dateutc": "2024-04-18T10:48:38.3146183+00:00" }, "marketing_segment_id": "cfa9fea3-5cf9-4a0b-aff8-f098db8a052f", "marketing_segment_code": "sample string 11", "sales_organization_id": "92738a16-7612-4d8f-b5b9-3c748330ef09", "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": "0fe438e3-ee5d-47b4-a3c3-5695d386a048", "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": "3bc83eea-2015-45f4-a3e0-9632e8dd863e", "db_country_code": "sample string 28", "feelist_id": "240679e0-2b71-441c-b7de-92d816e15b40", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "ae89ff53-5d6c-439d-a075-a2bd43d70684", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "585eed70-edc2-4002-a84b-e3e41c3691dc", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-04-18T10:48:38.3146183+00:00", "db_currency_id": "f7bbe97f-8394-4705-997a-b1520af1f364", "db_currency_code": "sample string 10" }, "company_type_id": "2b99ba59-ee51-4c7b-83f9-837410bdcfbc", "company_type_name": "sample string 32", "company_type": { "id": "3c1124fe-1f28-4bf6-a398-df76458d5d1d", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "749e39aa-e324-4998-9978-8023716642ab", "sales_organization_code": "sample string 5" }, "db_language_id": "79241377-3509-4e9f-8014-f7778c5473db", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "117af0cf-ac65-4cc6-ad25-5fa14fa637a7", "article_price_label_code": "sample string 37", "db_payment_method_id": "8c11c522-3722-490e-82eb-41030498a752", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "761da404-c80d-4e09-a165-9acc739a2c78", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-04-18T10:48:38.3146183+00:00" }, "company_sector_id": "205ed4e1-488b-4da9-920f-89ca6f6854b1", "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": "c8753e05-cec6-4079-b3fd-aa2aea61ba72", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "b146b63b-c0a0-43de-a831-65745c7b6459", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "7183bf9d-aa23-4bc1-bcc6-7fbdc834b225", "account_manager_user_code": "sample string 56", "company_status_id": "b2f54f60-0570-406c-a23f-5d87aeed171c", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-04-18T10:48:38.3146183+00:00", "id2": 60 }, "db_language_id": "ed1c1c38-c203-4345-a5f3-26069519bfe7", "db_language_code": "sample string 7", "db_title_id": "3055737e-7fa6-41a2-bf35-b62a027fbe7f", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-04-18T10:48:38.3146183+00:00", "create_date": "2024-04-18T10:48:38.3146183+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-04-18T10:48:38.3146183+00:00" }