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": "40fda63f-fd8a-49a7-b3d6-d1b1105c4adb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2acad2ad-6a21-4372-8b7d-0e4da8401289",
"company_code": "sample string 5",
"company": {
"id": "09f6cae6-f8e9-4a65-971d-df8cf7494e7a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-03-31T21:51:02.1698496+00:00",
"sales_territory_id": "86ff5bfd-4ddc-46b0-8af4-0148edaeb7a0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "387b510f-020a-442a-a36e-9bbb0eecb44a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dc99527c-671f-448f-8e49-945766e13172",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5830ae7b-c567-4214-91b2-20485ae9b370",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bc73d658-4531-4491-afd8-74affe4c17f2",
"db_currency_id": "db4f981b-b917-4d7f-abaf-712c1662e41d",
"db_language_id": "d85abfa9-e2a4-4efe-9bb5-f7f4eea4bc75",
"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-31T21:51:02.1698496+00:00"
},
"modified_dateutc": "2023-03-31T21:51:02.1698496+00:00"
},
"marketing_segment_id": "32c0c8fd-a279-46b9-8ce5-09263d8cf454",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ec41e7db-3aba-44b1-9c67-a78f0c53d087",
"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": "236971ff-01a3-46e7-b9f3-29a366d5d9bf",
"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": "b5d95bd2-d823-4352-941d-5c1a33415f0c",
"db_country_code": "sample string 28",
"feelist_id": "5b102c15-3b74-4796-ad30-088ba5283d0c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "df1c8b61-281e-4ce4-8619-ee6280c8b4d8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3f3b2ccf-9740-43b6-a596-27dcc124c7e1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-03-31T21:51:02.1698496+00:00"
},
"company_type_id": "bf5e4705-da49-488a-ad73-ba2aac812953",
"company_type_name": "sample string 32",
"company_type": {
"id": "1421f98f-6556-413d-b3e8-591199f9ced9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0bd1e1f2-5333-4315-8c53-f566912a1bc6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "dec20085-9a57-488f-8dcb-08c2918bd21d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fc3fd4de-f831-40e7-ba0f-ae22be9a6ce8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1b4db580-aad8-4644-b380-3ebccb4e4ca6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "57eeb1fc-5fb8-4007-9beb-79843adba19b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-03-31T21:51:02.1698496+00:00"
},
"company_sector_id": "11c1593a-ef3d-44e4-9f5d-15bb096ece9a",
"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": "a60269e9-e8f7-41b7-87b4-077b5e23eade",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7e980151-e446-49d4-96c5-d39bc692cfbd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d672a22b-9cf0-417b-a988-d3446ac2896c",
"account_manager_user_code": "sample string 56",
"company_status_id": "b02dd342-f04b-4ecf-aa42-588cdade5f39",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-03-31T21:51:02.1698496+00:00",
"id2": 60
},
"db_language_id": "4ff0154c-4bba-42e4-b0a5-336accb96ae3",
"db_language_code": "sample string 7",
"db_title_id": "8dfcfc10-1452-417b-85af-19ffca4a4ce3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-03-31T21:51:02.1698496+00:00",
"create_date": "2023-03-31T21:51:02.1698496+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-31T21:51:02.1698496+00:00"
}