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": "e8fdd9e5-51ba-44f1-94cc-6d934d9e8aab",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "29eae9e2-0ff2-45c4-a230-9c7aa46f2ff1",
"company_code": "sample string 5",
"company": {
"id": "ca988af4-ddf8-4ae9-b584-27c7df7b1625",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2022-12-06T05:03:32.2068982+01:00",
"sales_territory_id": "3a79f069-0570-4077-91f2-3acba66fd5dd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "45c43cf2-2570-40c4-825d-bd2f513c892a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "643e0ac6-3f89-4e72-b722-34529f61cd84",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e45356c8-a62f-4cf7-b329-437dbd6e5a33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f65513a5-31b7-48d7-8799-cd99ed2d7c42",
"db_currency_id": "699b31f3-7ae5-45c9-9404-0e07499bb317",
"db_language_id": "dd6b3751-f7c1-4960-8f33-e8002a14bb59",
"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-12-06T05:03:32.2068982+01:00"
},
"modified_dateutc": "2022-12-06T05:03:32.2068982+01:00"
},
"marketing_segment_id": "04eaa4bc-2901-4a71-8026-2c0d9d095bb3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7a73e869-0c51-436a-bb00-f1c335b6d655",
"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": "9e2a1ca1-6ce8-4bfb-80bd-7baeca155f47",
"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": "1be53c70-de02-44ab-9b53-a886e8a90093",
"db_country_code": "sample string 28",
"feelist_id": "0503b5b4-ba63-4bff-b348-88fae3dfc1d4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c6f82561-9922-4d85-bfa7-b22625d93c96",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b849acd0-50e3-45ab-ad76-cada6fc06a8d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2022-12-06T05:03:32.2068982+01:00"
},
"company_type_id": "a3b2079c-3deb-4ae0-8bc0-3f4049ae2afe",
"company_type_name": "sample string 32",
"company_type": {
"id": "fee7640d-6c94-4a31-b2db-00f38e38fe9f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4426dff5-1f4e-4755-95aa-684de033a54a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b9ce08ba-be14-47eb-9855-cb009951476a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5453029f-d360-45b6-bd2c-893d11e4971d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "25c19ae6-d5b0-41e0-b212-0c3a6d82efd6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4c775110-a648-4a0b-bb8e-29154d5bd593",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2022-12-06T05:03:32.2068982+01:00"
},
"company_sector_id": "5117c7cb-a35c-4a80-9e3c-361f387c92af",
"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": "a9e18d70-bd8a-4567-860e-0e7b9ef5516c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "429e0ea6-5988-4fb4-b936-20efd76755a2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b7eebb4d-222a-4256-a600-6ead72af4f76",
"account_manager_user_code": "sample string 56",
"company_status_id": "33cdc897-8ba2-4992-b4ec-51e840a40489",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2022-12-06T05:03:32.2068982+01:00",
"id2": 60
},
"db_language_id": "089f421e-90d6-4450-a243-879ed6d3ef8c",
"db_language_code": "sample string 7",
"db_title_id": "8865b36f-26e6-4e88-941a-5186658479a5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2022-12-06T05:03:32.2068982+01:00",
"create_date": "2022-12-06T05:03:32.2068982+01: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-12-06T05:03:32.2068982+01:00"
}