Retrieves all the company contact
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": "13787e63-3270-4573-aa94-10f81c28ccaa",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9f8d85e0-6846-4133-9489-ded1cae9050e",
"company_code": "sample string 5",
"company": {
"id": "1a5a9c09-bd89-4438-a243-38a43230e611",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-07T02:54:02.6799293+00:00",
"sales_territory_id": "ac0d2700-7571-4dab-a8dc-ac7a5724a217",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bb3d523e-2c3f-4efc-9098-34f68362b986",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f32e8a9f-c645-4f3c-a5cc-d9f554f22fd7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9e20f25e-3a1d-4d19-a045-b10cdd65dd42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd06a8d1-6f86-460c-b628-0d4d66cf4c59",
"db_currency_id": "5d185da6-04e4-4b5d-80d9-a1be0e7002d3",
"db_language_id": "af2cba96-3ff2-496e-a444-e092003e7954",
"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-03-07T02:54:02.6799293+00:00"
},
"modified_dateutc": "2025-03-07T02:54:02.6799293+00:00"
},
"marketing_segment_id": "e545f4b5-4dc3-41bc-951a-157a041e641a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2cbfa6cd-4866-4f91-ac2e-9bc0d97c8421",
"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": "bedcba0e-c2ba-433d-8430-9f0a23c935da",
"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": "12a41d59-2c5f-4f62-a1da-ec20c6072806",
"db_country_code": "sample string 28",
"feelist_id": "8ee3a6de-02ff-40fb-aeb4-81b7ad54ff1b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "61414111-4e9b-4887-899f-9ad86f4e2052",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "66cd8b43-ad8b-4194-9294-04539d6bda16",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-07T02:54:02.6799293+00:00",
"db_currency_id": "9d8f3427-dcbd-4d57-a0e1-c14b1036f71e",
"db_currency_code": "sample string 10"
},
"company_type_id": "afd2603a-14f6-4848-b4aa-e6eb79969b1e",
"company_type_name": "sample string 32",
"company_type": {
"id": "2e7a0261-682c-4aa0-9a4e-f8f40ef06707",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8aedb1ca-aff3-4043-a1a3-e75b55ba0406",
"sales_organization_code": "sample string 5"
},
"db_language_id": "031f69d4-341f-4bf5-83eb-42d96af81980",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a0f7b058-f358-4803-8246-57635e31d3e4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "eb924848-dded-4aff-98e1-77e6a5e7641b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "03f56f0b-7769-4e3f-9f8c-384312f7adfd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-07T02:54:02.6799293+00:00"
},
"company_sector_id": "21e972a0-4eba-4db2-b820-d3fcd655b669",
"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": "e152c276-045e-49ca-af05-154f55724c37",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eb443895-e26a-433b-a4aa-08596aa8bc44",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eb658c4c-20f0-400c-8df1-948ad9892fa6",
"account_manager_user_code": "sample string 56",
"company_status_id": "d419b2a0-dfd5-4b2f-9ca0-30171ddf1e96",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-07T02:54:02.6799293+00:00",
"id2": 60
},
"db_language_id": "6728a6d7-97a7-470b-837c-dbdf1e0de517",
"db_language_code": "sample string 7",
"db_title_id": "80565614-de4b-480d-b572-4d6f36faad8d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-07T02:54:02.6799293+00:00",
"create_date": "2025-03-07T02:54:02.6799293+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-03-07T02:54:02.6799293+00:00"
}