Get Contact by Company Id
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| company_id | string |
Required |
Body Parameters :
None.
Response Information
Resource Description :
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": "4742f932-6ada-4f03-89c1-f8b79ccd5cc6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "078837d6-9c77-47e4-8552-1312a5a5f4f0",
"company_code": "sample string 5",
"company": {
"id": "ef2b4b36-f6b3-4955-b017-2972784061df",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-03-23T15:27:01.3325665+00:00",
"sales_territory_id": "7cc4f950-cdae-4642-9132-405d8adaf72c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "47d4242a-9f11-47af-8e01-0ca7b2af3e56",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "27951294-f8a3-4bf5-ac16-a459d03b7905",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d0090ce0-7918-4703-a235-90e0afb4a04d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bd1b254f-403f-4fe5-b938-a7a22ed765d1",
"db_currency_id": "fa981846-3b55-44d4-b50c-70606cb035b3",
"db_language_id": "13bd5726-cb59-46c1-842f-573d842551f6",
"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": "2023-03-23T15:27:01.3325665+00:00"
},
"modified_dateutc": "2023-03-23T15:27:01.3325665+00:00"
},
"marketing_segment_id": "f02c3616-55de-46bb-9222-37572969283a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "be664d01-6fb7-4360-94ee-80595dc7e50d",
"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": "60c8d45e-420f-44ba-b333-54384e5cc5ad",
"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": "03e2737d-ca86-4046-b4b4-58d10af867af",
"db_country_code": "sample string 28",
"feelist_id": "83062c51-273c-4fde-8aa9-49316a584116",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "87ad4155-5649-43d3-9cd9-780ec891de29",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8e31572f-eb01-41df-9c3d-09bbc3fffcc2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-03-23T15:27:01.3325665+00:00"
},
"company_type_id": "5dcddc97-516e-4d66-b9c5-25572b26b053",
"company_type_name": "sample string 32",
"company_type": {
"id": "f8d54bf7-3587-4189-9f38-a689ad888a6c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f91aa410-a027-4fa4-b428-449c6243fc4d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "926988e8-45bf-4201-aaec-680bf6367dee",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d7adc5df-7cfe-4e70-997d-b1714dea08a7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "073d40b3-84fd-4c3f-93df-78f723530e87",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "11da345f-21a1-468d-b5ef-25fa072af99e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-03-23T15:27:01.3325665+00:00"
},
"company_sector_id": "1f759701-b5bc-43c7-aeaa-53442bb6edfb",
"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": "6bbcb3f6-9e2b-4d05-a391-e5cccc0e9580",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "15276f19-b726-43d6-b09b-2b5e32860c2e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "84cedc38-a7ed-4592-b5bf-c1f8c0e0544a",
"account_manager_user_code": "sample string 56",
"company_status_id": "a8dad1b5-c9dc-47b0-9636-bc7a74aadc00",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-03-23T15:27:01.3325665+00:00",
"id2": 60
},
"db_language_id": "2d3245b3-b01b-4c44-a56a-368a6b7e1969",
"db_language_code": "sample string 7",
"db_title_id": "6c70abca-822a-40cd-8d66-90ffcfdd8b85",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-03-23T15:27:01.3325665+00:00",
"create_date": "2023-03-23T15:27:01.3325665+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": "2023-03-23T15:27:01.3325665+00:00"
}