Retrieves all the contacts
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": "dc9cfe44-9108-4443-96ed-844ae205699e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "11b8a3df-ab0b-4f71-9528-1a0a455040d0",
"company_code": "sample string 5",
"company": {
"id": "6b9427c8-37eb-4e9d-91dd-14444acc205f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2022-08-17T03:01:23.7737397+02:00",
"sales_territory_id": "6bf9702d-9224-41d3-8a10-1fe9ae3dfc68",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ad707066-fb3d-45b2-9b03-ed352c7f42ea",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0dbf7c5c-4e38-4052-b681-b691143064e6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "19bc8f26-834e-4cb7-b43e-31f625a4c4e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "02195652-2262-42a6-a3a3-e90539217233",
"db_currency_id": "b5b57877-c977-405e-ada4-1de26c1db101",
"db_language_id": "86f7e3d9-f5dd-4f7b-8dc7-031af7f1e49d",
"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": "2022-08-17T03:01:23.7737397+02:00"
},
"modified_dateutc": "2022-08-17T03:01:23.7737397+02:00"
},
"marketing_segment_id": "589df968-568c-4dba-a14b-54bd555b9714",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "16474b92-9679-49aa-b65b-a0757b152629",
"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": "e188c276-7f61-4f7b-a25c-4f145db6a7d4",
"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": "f602c4d3-85fb-4cdc-bde5-bdec30efc57b",
"db_country_code": "sample string 28",
"feelist_id": "7628981f-5b62-48c6-a95c-1c3b03810da0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "56ead361-8410-4a73-be33-97d8a16f7774",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f47cda76-681d-46cd-ba45-991b76881d84",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2022-08-17T03:01:23.7737397+02:00"
},
"company_type_id": "ec51c1cd-90d5-4ced-b322-955341717413",
"company_type_name": "sample string 32",
"company_type": {
"id": "9cf236a4-681a-470e-be7a-dcecd9e06c3d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2fcd9f42-ba85-4788-bf99-71dd51b04164",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4255fec2-a6d6-44ea-b9ca-833b36dda2a4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5f6637a2-cf9b-4e34-b5b9-1a68b3e83945",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f5c1e34a-ec77-40f6-9f8e-d366ac2e947a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4657cb51-6c53-49b2-9894-a51427aafdd0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2022-08-17T03:01:23.7737397+02:00"
},
"company_sector_id": "77c6838b-87aa-47f3-9d14-974a30df75e4",
"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": "363b7ae8-eaf4-4c8b-a5a8-a394a88bde5d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cb69c0f3-a581-4d12-9ea6-c92b83780c41",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a9abd800-13cb-42cc-84e0-55af334a3f57",
"account_manager_user_code": "sample string 56",
"company_status_id": "4c9f0103-52bf-43c0-a38c-132dabcc1e16",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2022-08-17T03:01:23.7737397+02:00",
"id2": 60
},
"db_language_id": "b81c159a-b1c6-4e2e-b1f0-4e6852354ea8",
"db_language_code": "sample string 7",
"db_title_id": "53b92a1d-ed16-4ea7-83e7-a1e7384b8e97",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2022-08-17T03:01:23.7737397+02:00",
"create_date": "2022-08-17T03:01:23.7737397+02: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": "2022-08-17T03:01:23.7737397+02:00"
}