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": "a1fbbd84-e23d-4215-8d78-44d431288c5e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "021a3807-406b-40a0-a4c4-6cc65c79ba0b",
"company_code": "sample string 5",
"company": {
"id": "bc21d7cf-6b20-47e7-8f74-44d58325547e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-21T17:00:19.1400334+00:00",
"sales_territory_id": "85fa5b17-7b27-43bf-9908-fc1dee255df5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4f601373-04ca-4f45-b257-895393a697e5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7a98cd14-4133-46ca-af7e-ac21d157a9a8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4150c203-b613-444d-96ff-7bfad27da5f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e24ab14d-1537-4082-b91c-ca8c21906336",
"db_currency_id": "8ef143ef-2f64-4c37-a7aa-33bd2679a587",
"db_language_id": "e5e8b13a-3f99-4dab-aabe-79d9fd9bfd30",
"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-12-21T17:00:19.1400334+00:00"
},
"modified_dateutc": "2024-12-21T17:00:19.1400334+00:00"
},
"marketing_segment_id": "d431888c-7db6-4735-96da-be167d94d8d6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e426d7ce-0e82-441b-8ff5-91f914a92381",
"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": "402c470a-1644-454b-b2b6-89dbb50aa38d",
"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": "8b565fc2-59a6-45be-97cb-83a3f6ee30af",
"db_country_code": "sample string 28",
"feelist_id": "ae57f423-62d4-42c9-afd5-d2199a80e135",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1ae9e734-59c5-47e3-b2bf-b94aece25b13",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bc93ec61-9fa8-4ed4-b553-dadab6e2daa3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-21T17:00:19.1400334+00:00",
"db_currency_id": "23ebe2df-0276-4edc-9a04-d26953c3bb61",
"db_currency_code": "sample string 10"
},
"company_type_id": "6ded1745-071c-46e8-94d6-78098562845f",
"company_type_name": "sample string 32",
"company_type": {
"id": "9a5a1ce5-08c5-4e9a-a7f6-d45148062791",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8b7d02e6-0f45-43f3-9a40-8c9a97654ddc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "86e9e825-f657-4524-b803-fa4a69fa4682",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8ba922cf-3b37-4704-9ade-5d01f37af117",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "371a8228-7300-4cb1-a614-f493d727daa1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0d414406-3a85-4f41-b60a-37a343d175ab",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-21T17:00:19.1400334+00:00"
},
"company_sector_id": "245d348d-0689-4bb7-9c6c-b9094116b405",
"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": "5a79968a-c93b-4d7a-9a4b-6fc38e68ab8a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4a97dea1-e2e0-4dc0-bdce-6f20138bb242",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "26498ed7-c3ff-4d9b-ab9f-73a6efd0fafc",
"account_manager_user_code": "sample string 56",
"company_status_id": "aafb408f-1955-44fc-9614-c4da2de2da5a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-21T17:00:19.1400334+00:00",
"id2": 60
},
"db_language_id": "777b757a-0cbb-42bf-8059-b9c1608a012f",
"db_language_code": "sample string 7",
"db_title_id": "5d075133-cc17-4bad-8fe2-c135043867cd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-21T17:00:19.1400334+00:00",
"create_date": "2024-12-21T17:00:19.1400334+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-12-21T17:00:19.1400334+00:00"
}