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": "a7abbdb3-87bd-475f-bf70-a028e4003e19",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "aafb5034-d2a2-46f0-903c-4155e89a9f61",
"company_code": "sample string 5",
"company": {
"id": "6c805946-0dea-4314-85b9-954b07395d37",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-03-19T12:55:22.0840474+00:00",
"sales_territory_id": "7afd8813-468a-410b-b7b3-94c8ceb80d82",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5666f23f-eee9-4519-bb3f-a91a31c5f8e8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8c543151-2e73-4aa6-9139-8da4388a15ce",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "db95b9a6-905c-4ecd-bd3c-16251b59c96b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cde65f4f-def7-46ef-a004-675b0d69f6a8",
"db_currency_id": "ae1cb6ea-03e5-4fd4-b291-7f7b9fac6755",
"db_language_id": "f476e8a8-6f7c-4d1a-b1dd-4571723a038f",
"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": "2023-03-19T12:55:22.0840474+00:00"
},
"modified_dateutc": "2023-03-19T12:55:22.0840474+00:00"
},
"marketing_segment_id": "6d2942ac-5d06-4513-9675-3dda2e10d49a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6992e04c-eb34-4d73-85b9-9c382427a2d8",
"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": "2d8d649b-132e-4ec6-ac3e-afe087b77d84",
"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": "1e7e68b4-c4c8-44d1-9e35-a4a703d705bc",
"db_country_code": "sample string 28",
"feelist_id": "c60b2b30-a71d-4d12-8504-a9f935ab8fb5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "99c3f465-f499-4f7f-a4df-783e94213dc1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "94a6e262-999e-4089-a49a-ee3830fb9e5d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-03-19T12:55:22.0840474+00:00"
},
"company_type_id": "e9c93fb5-20d5-49ad-8659-e4319820e3f1",
"company_type_name": "sample string 32",
"company_type": {
"id": "53c32dcf-a704-4aa1-b020-f9d4710c2c70",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c14603ed-a145-41de-ac02-27638e59966c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "27d48ac1-9509-4cb7-9bc8-0085cfb921ea",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4c2d0a52-614d-4d8e-915c-55a4b3bdf0f3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c609c72a-a191-4b68-8d2f-31e59a3ff933",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9fd0ebbe-d26e-4f96-8521-f8fb3d0c29c3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-03-19T12:55:22.0840474+00:00"
},
"company_sector_id": "9505917f-01db-48e6-84dc-68f2ded130e9",
"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": "7b8fe940-23d0-46e2-a15a-b47f330cc745",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "55bf7e4f-68b2-4cc2-9998-6f752de6f4c3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "256bb692-5bbd-445e-9ba1-3444584b912c",
"account_manager_user_code": "sample string 56",
"company_status_id": "3296d531-4fd8-4f42-9374-692415f2efd7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-03-19T12:55:22.0840474+00:00",
"id2": 60
},
"db_language_id": "ed724a4b-4ff3-4a38-82f1-d6605e12a397",
"db_language_code": "sample string 7",
"db_title_id": "d108ce96-4d30-411c-97a0-60a80555593f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-03-19T12:55:22.0840474+00:00",
"create_date": "2023-03-19T12:55:22.0840474+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": "2023-03-19T12:55:22.0840474+00:00"
}