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": "4003cbe4-15e4-4da4-9f8b-64bcf37e1b13",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "99e7c731-639d-441f-bf9b-86d288379ea5",
"company_code": "sample string 5",
"company": {
"id": "84c60be7-ac79-4525-9c28-2cf1b5a66596",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-05T06:57:39.448663+00:00",
"sales_territory_id": "ebc83d7e-e108-4f4d-b92b-a0266b07bdb1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4a04a33a-15fd-454f-897e-3972d265c98b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cbc3d294-373f-49bc-a35f-a45c1c5e764b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "941f43a9-e961-4432-8bf2-a44267c16659",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56b0c1b9-7101-461e-8cdb-4edd08a3fffe",
"db_currency_id": "028d316b-f58c-45b4-a80f-cb6ec6c4cc41",
"db_language_id": "6c40d984-4729-47d6-87c5-f0ba17119653",
"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": "2025-02-05T06:57:39.448663+00:00"
},
"modified_dateutc": "2025-02-05T06:57:39.448663+00:00"
},
"marketing_segment_id": "0dbf749a-7536-408c-8647-8341374bccfe",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "540b6cec-5da4-42fc-a663-e70b426c0bcf",
"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": "abf37cd0-cfae-4b02-9b05-151f742f4e6e",
"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": "a32c8122-6b62-4737-ab71-559227b58cca",
"db_country_code": "sample string 28",
"feelist_id": "17dd4beb-add7-42a6-a244-00a85f261c12",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ba3e8b60-ec02-4d4f-9782-e0c94c6cf23b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3a363f16-3da4-44bc-97b6-d5a26c07f0a7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-05T06:57:39.448663+00:00",
"db_currency_id": "f32cb262-7794-4f47-ba7b-e11677babd8f",
"db_currency_code": "sample string 10"
},
"company_type_id": "aa87c430-3cae-4672-a603-45d0ecdaac43",
"company_type_name": "sample string 32",
"company_type": {
"id": "3db08f39-61a5-4e1d-8da4-aaef152eda38",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f3dbe239-93f3-4d6b-941f-4ae079b34f09",
"sales_organization_code": "sample string 5"
},
"db_language_id": "02766080-08f2-46dd-ade4-12d28bbb193e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f764d0a2-9078-431d-a797-7a9ffbf79da9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7da15ad1-8d5c-40d8-97f0-2eba982ae78d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "79463044-6279-4959-b744-7f4c6ed210fe",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-05T06:57:39.448663+00:00"
},
"company_sector_id": "b0e17cdb-8966-48d7-a985-f63f8d08d0d9",
"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": "7cc87dd7-ddc6-4b5a-ac05-6498bac89ee0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "355d08c7-808a-4f14-88a5-12db437fc04e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b004e5da-7007-4248-8a70-ea9569158135",
"account_manager_user_code": "sample string 56",
"company_status_id": "94d748b9-272f-44d5-87be-d4a12f94a375",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-05T06:57:39.448663+00:00",
"id2": 60
},
"db_language_id": "89a581a1-d1a1-43dc-bbd0-6067653a69b5",
"db_language_code": "sample string 7",
"db_title_id": "0489eaa9-2ab6-465e-b16b-b02788582624",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-05T06:57:39.448663+00:00",
"create_date": "2025-02-05T06:57:39.448663+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": "2025-02-05T06:57:39.448663+00:00"
}