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": "d0360e6e-068c-4739-ae04-db3e45cf7d30",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bfc5ec95-42db-4eb2-989b-15903a6a3984",
"company_code": "sample string 5",
"company": {
"id": "a154c841-b511-4c73-a675-ed7171e67663",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-05T07:01:46.9399209+00:00",
"sales_territory_id": "b69960d1-141e-424a-bd4e-6df68c79182f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "81e08f6b-b3c7-4b8e-b7eb-8d140e9d9139",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "57e9e711-e345-493e-b376-f6490e857ad8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "976a2ef1-9091-42e8-9d8c-d89549977057",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8a901ffd-48ad-4c91-8fd1-8fb53cab3c6f",
"db_currency_id": "2615a75f-4a91-461f-9cae-cedc4e769c49",
"db_language_id": "d696ec18-c8ba-420c-9010-869bb0a82378",
"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-02-05T07:01:46.9399209+00:00"
},
"modified_dateutc": "2025-02-05T07:01:46.9399209+00:00"
},
"marketing_segment_id": "656da828-ef23-4f01-8fcb-1aae7a0f3645",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fa3f9ac1-ffd0-4d70-a62a-e0fcabdba7ab",
"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": "668be4f9-f39f-44c2-9a2c-35e8a2dfb2ab",
"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": "f083c6c9-c5ad-42c6-b651-66ecd6f079ae",
"db_country_code": "sample string 28",
"feelist_id": "d2aacb1f-ac9a-4d83-a906-08451732f34b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a78f5843-8a25-49d8-bf78-95af9b8ecd2f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "75be94fa-9630-4ff4-b545-786148b53582",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-05T07:01:46.9399209+00:00",
"db_currency_id": "13ce8a89-59df-4b85-b153-470e6a2e1bdf",
"db_currency_code": "sample string 10"
},
"company_type_id": "d0ecaab6-a058-4669-be77-1f8258637c4e",
"company_type_name": "sample string 32",
"company_type": {
"id": "7b847126-21e3-4de3-91a3-c879f788b19e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d9d17dcb-333c-4a97-b991-fb4534083122",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bb6185fb-f0aa-47c4-9726-135d778afb4d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "524d602d-3287-450a-8add-3be9ff776fef",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0bc20134-e593-4c60-84c4-6c82843cca33",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "165b31aa-a8d0-4a81-89e8-441d8b43cd85",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-05T07:01:46.9399209+00:00"
},
"company_sector_id": "0e2c2183-d6a8-4cad-9671-e0c4dcbca25d",
"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": "41d885dc-3ce1-49d8-834f-a67a5dc4f033",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b68a5969-4fc5-409b-b0b3-2c26359a8379",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dfecc34a-fd3b-48ef-8d4c-09dcb2170b52",
"account_manager_user_code": "sample string 56",
"company_status_id": "652c3df4-db53-457a-9c60-ad72d6b8a731",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-05T07:01:46.9399209+00:00",
"id2": 60
},
"db_language_id": "9043d6a2-2445-4a81-97dc-19dc8b6b6a5d",
"db_language_code": "sample string 7",
"db_title_id": "257bc630-0a12-493d-b502-905fccf03aff",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-05T07:01:46.9399209+00:00",
"create_date": "2025-02-05T07:01:46.9399209+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-02-05T07:01:46.9399209+00:00"
}