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": "c7512fa6-b8e3-435f-99f1-dc61181f3ca5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "200157c4-03b7-4413-a630-acc9575e1d02",
"company_code": "sample string 5",
"company": {
"id": "4f268618-f02c-4299-8f44-43ebff70a3d8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-28T04:56:35.962889+00:00",
"sales_territory_id": "64aba6c4-8a96-43a4-b985-21c30a6ff0e9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8e9466e0-b2d6-47c4-96f5-3511332d2d55",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b1fd1307-613d-42b6-90cc-60e383725e37",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0e00b55c-8e51-49dc-9b6c-e7d69d8a1615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "22c0386b-4764-454c-b55c-261424def927",
"db_currency_id": "390a16eb-94bb-4eed-a338-a25519fdb83b",
"db_language_id": "96efc253-d3ef-435b-9558-a402920c562b",
"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-05-28T04:56:35.962889+00:00"
},
"modified_dateutc": "2025-05-28T04:56:35.962889+00:00"
},
"marketing_segment_id": "6a6003a1-efd9-4d33-b0b1-b7dc0560892b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "22805f9f-74b8-4797-a743-3e885cc38b82",
"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": "f3871e1e-9982-486f-b105-9f0ecaafa711",
"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": "2efbcdf7-d319-4c7c-a0b9-36eee3910a31",
"db_country_code": "sample string 28",
"feelist_id": "f5cf8d58-a01b-4c27-acbe-53685139bbc0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b37711df-191b-4920-8d49-0ce9f4a2cb12",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e93839a4-efb3-4249-b087-adfef494b88c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-28T04:56:35.962889+00:00",
"db_currency_id": "8b88f182-ea39-4bd1-8520-a38e24c73890",
"db_currency_code": "sample string 10"
},
"company_type_id": "2cc370f8-56fd-4596-af2a-c60c62f20720",
"company_type_name": "sample string 32",
"company_type": {
"id": "77b8015e-3d25-47be-9259-460c23dbb972",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "68fb4fec-462f-428b-9d74-fcf51c4d0655",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2604ca4a-54bf-4348-a4ec-2abbe8d26a0c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7fee6a8b-a8f8-4be5-b9f9-b11d9c833ca1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1e3dce7b-4c29-4f87-be47-39627b32a847",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e61b9716-654c-4287-8054-7e9818134255",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-28T04:56:35.962889+00:00"
},
"company_sector_id": "e9aa0e16-9703-496f-8102-2bad589d6795",
"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": "c3f84b47-69c5-4ad3-a618-0d42bd5f0371",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "071cfbce-42ce-465b-8539-944e7ed682ea",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "93dd19aa-a408-42cf-8d20-78c9346a5af1",
"account_manager_user_code": "sample string 56",
"company_status_id": "b139477e-f00e-42dd-b88f-5add1829ff56",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-28T04:56:35.962889+00:00",
"id2": 60
},
"db_language_id": "cee5dac7-a0a1-49b7-bd01-c939300d956b",
"db_language_code": "sample string 7",
"db_title_id": "8d709ff7-e81b-4958-9823-0b87edb97796",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-28T04:56:35.962889+00:00",
"create_date": "2025-05-28T04:56:35.962889+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-05-28T04:56:35.962889+00:00"
}