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": "d4261889-241c-4632-a965-359f26a3525e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8b4411d1-498e-41e4-91bc-e9b2480b3020",
"company_code": "sample string 5",
"company": {
"id": "7f256663-d610-49f0-b675-5c8b81218f12",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-01-22T01:13:32.3027268+00:00",
"sales_territory_id": "ab36823b-72da-48ac-bf96-d49b9778fe93",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7c3aedf8-da7a-413d-ba43-201e53ca4d79",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "22a17bb4-cd6f-43ad-a33a-758d7b56a3e7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "25259020-e49e-4558-b738-170ffe04dccc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8d6fbe1a-bff8-4db1-8094-a3ca07f9c6ca",
"db_currency_id": "6b414af5-f118-478b-9a3b-38be5bc656e2",
"db_language_id": "5934e124-bfbe-4872-96f8-72baed1c813d",
"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-01-22T01:13:32.3027268+00:00"
},
"modified_dateutc": "2025-01-22T01:13:32.3027268+00:00"
},
"marketing_segment_id": "a2174c5c-ed8e-47ac-8bd9-84ea95c097b2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d37b9d51-3424-414c-9b78-0da3ef21ed75",
"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": "f7ee6c64-0511-4c5e-8ee0-300991294afd",
"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": "b837da80-55d3-4b22-bb9c-68bbeb9657fa",
"db_country_code": "sample string 28",
"feelist_id": "26172a11-ce02-4fa3-abd3-ced4f5c81440",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "52bd454c-d06d-4310-8a66-0c81f905c2a0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fae5d044-6f9d-4f57-8a9b-15e4417fc8eb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-01-22T01:13:32.3027268+00:00",
"db_currency_id": "28584d0b-9144-41a9-ad1e-c2450fa31794",
"db_currency_code": "sample string 10"
},
"company_type_id": "eaf97bef-15a4-4e00-9781-9fed4c36649e",
"company_type_name": "sample string 32",
"company_type": {
"id": "32e7a3ce-dca2-40e5-8c9f-774a5534a26d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7d7ae017-ce4f-4c18-9745-143aa69484a7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "51457950-d9fa-4292-a36a-150ea894d401",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7da5bba7-3006-4d61-9098-d4eac19f6583",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "91d69b35-c64f-405e-80e1-7882673ff40f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a24ba028-c39d-4aa0-9633-2b9deda94167",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-01-22T01:13:32.3027268+00:00"
},
"company_sector_id": "7b44946f-6b21-48ca-9409-4d4fbf8dbee8",
"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": "13c01fee-d83c-46f6-b52d-47059bb28770",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "146f7178-b354-4544-87cb-6723c315e5d2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f5524648-adf8-41eb-b625-04f347dc512b",
"account_manager_user_code": "sample string 56",
"company_status_id": "a3e167d0-55a2-4085-a011-9060b8bfe734",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-01-22T01:13:32.3027268+00:00",
"id2": 60
},
"db_language_id": "09526006-5186-4a4d-abc1-701fc29362da",
"db_language_code": "sample string 7",
"db_title_id": "ab78e8c8-c7ea-4361-8a5b-e57cb309573c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-01-22T01:13:32.3027268+00:00",
"create_date": "2025-01-22T01:13:32.3027268+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-01-22T01:13:32.3027268+00:00"
}