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": "05a96edd-1b51-4556-9c58-04fdf98a0269",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "58bd339a-bed4-49d5-98e1-d0f0f24c714c",
"company_code": "sample string 5",
"company": {
"id": "278bffab-10a2-44b9-ba67-596711fd6948",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-21T08:55:52.7749875+00:00",
"sales_territory_id": "b77bb0fb-b877-4cdd-897a-4d0f01a58250",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "396fbfde-7c47-4434-a9d8-e46ef1a901e8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2673b857-d46f-4d0f-9b91-16cad37b84f1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ce6e4bb8-7126-4b75-a19e-3f2fe5f3f18a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f363fa66-4853-4a1a-aae9-069599f44446",
"db_currency_id": "6ada6190-4e62-40e9-9e7a-a17480f63586",
"db_language_id": "1195ca8b-9879-4efa-813f-7cdcd2c12b39",
"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-11-21T08:55:52.7749875+00:00"
},
"modified_dateutc": "2024-11-21T08:55:52.7749875+00:00"
},
"marketing_segment_id": "0b1b6c86-91d0-4e88-a765-6d75124cd394",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "50112885-2584-4dbc-bbc5-85dadbe18118",
"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": "862aed0c-ec3b-488f-8b1b-d3d9a69f6c83",
"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": "0a7387b1-ea03-4792-be7a-75648e9cb267",
"db_country_code": "sample string 28",
"feelist_id": "0a27efb6-47f4-45e5-9bdc-0ed63db0c85d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "425361d0-f3f8-4a1b-ad31-59a6601c1521",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d66e40f8-d545-4c93-8bc8-b6d64315d155",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-21T08:55:52.7749875+00:00",
"db_currency_id": "31780f97-c213-4f33-84a0-93cea01854d0",
"db_currency_code": "sample string 10"
},
"company_type_id": "42ad4556-cee6-4bff-86cf-e896effc0997",
"company_type_name": "sample string 32",
"company_type": {
"id": "fc8c2f0d-1f50-47b3-a67f-e6fb8105d12c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5bde48d8-c784-4e71-b360-ae2e7e51f006",
"sales_organization_code": "sample string 5"
},
"db_language_id": "45f5aa58-3f76-4f17-bbbe-2c0677ebdab2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "58da6637-8a63-4380-a93a-5ee7d6382b0c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "69ae87a1-8a3d-4ab4-be5c-1ca78982f840",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "88d84599-c12c-4ae2-b6b8-0f15af9656fe",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-21T08:55:52.7749875+00:00"
},
"company_sector_id": "4c1fa12e-ac7d-4db0-817d-671a053d93cf",
"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": "287b8df8-bf0d-48d2-8c50-119d4eef839b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7749e937-9670-4b09-ab58-610f59f0916c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c375114e-4aed-4b01-894a-8b27fd0f1ad9",
"account_manager_user_code": "sample string 56",
"company_status_id": "3158d9d5-e4ff-4987-9cd7-8c72e6c4b720",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-21T08:55:52.7749875+00:00",
"id2": 60
},
"db_language_id": "a7b0d5e5-fbfe-41d1-bc79-91b63e133e88",
"db_language_code": "sample string 7",
"db_title_id": "a4e359e9-d91f-4878-8206-50647df3d06e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-21T08:55:52.7749875+00:00",
"create_date": "2024-11-21T08:55:52.7749875+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-11-21T08:55:52.7749875+00:00"
}