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": "29863716-86d9-4695-9292-c5edbb5a652c", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "8ab5df0d-5e80-4f77-a132-9dd72c56e4b6", "company_code": "sample string 5", "company": { "id": "348582c4-849e-40d0-94b2-16e3ba6d402a", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-07-26T02:19:51.4537939+00:00", "sales_territory_id": "b02403a6-efb2-4781-84b8-f11e8512f3fc", "sales_territory_code": "sample string 9", "sales_territory": { "id": "f93495c2-0f96-4abd-ac1c-41a69e482dfa", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "5a73830d-272b-458e-98ac-22a43acfc40a", "sales_organization_code": "sample string 5", "sales_organization": { "id": "331307d5-9286-4190-937d-5c5a147ac8d9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aa18e175-40aa-4f88-97bc-c4f49a62bc0f", "db_currency_id": "0009f8b4-24bb-43ec-818f-f19acb7380c8", "db_language_id": "2d2e13bf-6115-4373-b52c-ec027a2071c1", "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-07-26T02:19:51.4537939+00:00" }, "modified_dateutc": "2024-07-26T02:19:51.4537939+00:00" }, "marketing_segment_id": "43d02500-9a2b-49af-b785-790ebd0f5d28", "marketing_segment_code": "sample string 11", "sales_organization_id": "9b1d219a-56c7-4129-8a31-6bf68a734088", "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": "038e33d7-0a35-485d-836d-cc895cf8f3fa", "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": "36d9a5f1-2063-4d9a-beb4-2a0e62d341c9", "db_country_code": "sample string 28", "feelist_id": "a8ef398b-601a-4444-bdb4-14e0efbd2fc9", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "5d4c6184-cf4b-4be9-a7f8-c5f8c55d5c55", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "d8944f37-aba3-4912-a08f-28265374d202", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-07-26T02:19:51.4537939+00:00", "db_currency_id": "8c08eca1-342e-4adf-a912-0dc8fb5c8f0c", "db_currency_code": "sample string 10" }, "company_type_id": "59d6ac24-f625-4854-84b4-da1c3e2c651f", "company_type_name": "sample string 32", "company_type": { "id": "9489a368-e38b-4f30-a744-20183b75d400", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "80f445fa-2fb3-446c-9b41-f0ccf7faaa0e", "sales_organization_code": "sample string 5" }, "db_language_id": "f1c949ea-0bed-4c27-8f83-343e576e2f0f", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "9b14284a-ad82-4fe9-9bb5-2d1e7f1f21ef", "article_price_label_code": "sample string 37", "db_payment_method_id": "8df7a6a5-6775-401b-a651-1d839a55fa0e", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "07137a1c-3ec1-422a-b6b6-b1e7f881aa91", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-07-26T02:19:51.4537939+00:00" }, "company_sector_id": "40276966-b330-4c31-8415-a6c2cafea9b9", "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": "09f26f7c-aa81-4ae0-a20e-cb406a146335", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "3b910453-7725-469a-a8f4-ee258634df0f", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "e2f2662f-17ae-4b36-9953-c60c572d0e3c", "account_manager_user_code": "sample string 56", "company_status_id": "946d59de-869e-4f96-8587-c879008e2062", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-07-26T02:19:51.4537939+00:00", "id2": 60 }, "db_language_id": "72cb7d7b-0121-46de-b3c7-429a72322b14", "db_language_code": "sample string 7", "db_title_id": "4fae2a18-c771-4311-b106-b2277cd00b0e", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-07-26T02:19:51.4537939+00:00", "create_date": "2024-07-26T02:19:51.4537939+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-07-26T02:19:51.4537939+00:00" }