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": "29dbdf71-b165-407d-bffd-fff6ea15986e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4f18fecb-6ac7-48d5-a4bd-000976b72d3d",
"company_code": "sample string 5",
"company": {
"id": "50d9008a-da8f-43a9-8e4f-d31fd032429c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-04T02:30:44.251041+00:00",
"sales_territory_id": "e65f476f-0833-4e7e-93e4-1a4154e70b51",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "66160805-7804-4ada-8ad8-d0e674ce1847",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4fc8fedb-a554-4ea5-9ac0-995551115845",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed834bb9-88a4-4945-8b3b-7defe3bda140",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b36aac4-40d3-48d2-87d9-b83a7b7f9e77",
"db_currency_id": "66aa8f9f-65a0-49f6-bff6-711d932e2ba0",
"db_language_id": "8045f354-afa1-46b6-87ba-986a165cb358",
"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-04-04T02:30:44.251041+00:00"
},
"modified_dateutc": "2025-04-04T02:30:44.251041+00:00"
},
"marketing_segment_id": "6052e697-8afc-4435-957e-ed94c34390ca",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9df20d36-66dc-4342-970c-e17dbce1880d",
"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": "c9f5ed83-c0a5-4db2-ae5b-70d83623fbcf",
"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": "dab897ea-8c9f-402e-88f1-a42dac027353",
"db_country_code": "sample string 28",
"feelist_id": "9f11807e-3bf3-4f45-9bcc-c0df726746b4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "08bbfb73-52df-4211-bab9-b31b026e8b55",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "59eb7351-4e0d-488f-91e3-395b3fd81eb7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-04T02:30:44.251041+00:00",
"db_currency_id": "8db63e7d-e9a5-4e13-a4ad-a20ac656fb01",
"db_currency_code": "sample string 10"
},
"company_type_id": "c247ee31-56aa-47d1-bc62-d10e2de0a579",
"company_type_name": "sample string 32",
"company_type": {
"id": "3db3aa7f-0724-4bde-a83f-28b9ead8de5b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9874f8f7-44e8-497a-a5f5-072f2365a532",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6fec25b0-a092-40a4-928e-0555400848de",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1f3cb2ec-2294-4f7c-bdb1-0de45b5b6482",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c4fdabca-08c7-4421-83cb-048291c0e914",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8a88cc50-8fc9-4d71-9eee-8a1a4757b06a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-04T02:30:44.251041+00:00"
},
"company_sector_id": "6c93c156-1f17-4f2c-8188-c8b905ec82b4",
"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": "09a53786-c8f9-48d6-8e4e-4b2e44765690",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1a5e873e-8501-40a0-a098-faae96637c72",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7c9720ba-c7d6-4040-9362-05a4afceec4d",
"account_manager_user_code": "sample string 56",
"company_status_id": "2aa50940-4512-4f76-9ab7-a532e8f3ce1f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-04T02:30:44.251041+00:00",
"id2": 60
},
"db_language_id": "35f36cb2-b6fe-4319-99d9-8d9fb15ba644",
"db_language_code": "sample string 7",
"db_title_id": "700ff8bf-b78f-4edb-912f-5a51e7088779",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-04T02:30:44.251041+00:00",
"create_date": "2025-04-04T02:30:44.251041+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-04-04T02:30:44.251041+00:00"
}