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": "61f174d6-505f-466d-8104-b96368b9a8d2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a8dcd78a-a8b0-4c43-b8bc-001d00859857",
"company_code": "sample string 5",
"company": {
"id": "ad0fc9d7-0004-4453-bd09-acb11813d1e6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-11-03T16:48:11.0989657+00:00",
"sales_territory_id": "f275c6ed-fd80-44aa-a12e-7294d757bb7a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3565f6a1-3496-4f29-b680-6e7a810fc51f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7c0ab062-f7b3-488a-a3bd-3429e2417c59",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "11fdb0ef-3503-4ab7-abd9-03f0590731fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c0e3ab9-f0c7-4eeb-806b-5ab6ee546949",
"db_currency_id": "869d56d0-63f8-4c23-afc6-e493468c29cd",
"db_language_id": "2b9ec1db-c007-41cc-b33d-b4770de164bd",
"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-11-03T16:48:11.0989657+00:00"
},
"modified_dateutc": "2023-11-03T16:48:11.0989657+00:00"
},
"marketing_segment_id": "ba30d6b8-9fc5-471e-a72c-128bcf9845a6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "35fe5255-9d6e-4a43-8573-2e70bf55b8b4",
"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": "0e1a672c-7817-43a7-a3a9-eba12a6eb25e",
"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": "626f1547-3ddd-43e7-8b58-9d8ce4d1e95f",
"db_country_code": "sample string 28",
"feelist_id": "fb7e67ff-ddaa-45c7-acb6-e2e28dadc518",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3267883e-e11f-40cc-bf2f-5b0cbdce5da9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7083f657-133f-4057-9dc5-8d6c087af06c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-11-03T16:48:11.0989657+00:00",
"db_currency_id": "1688f760-b3e6-42cb-b681-fc176f0ec0ed",
"db_currency_code": "sample string 10"
},
"company_type_id": "87af8288-7762-4b95-9157-da34c38da206",
"company_type_name": "sample string 32",
"company_type": {
"id": "7af7d722-f3df-4714-9f36-70547065c36d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "36f11b01-4b43-4b7b-818c-67e38690fec8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b0f17d2c-6eb2-4d56-a27f-31cc6c62da69",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2eccbd3f-a35a-4c40-b227-be087f16bbf3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "06aebe85-1d01-431e-bb23-35a511c25d32",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f348cf4c-6082-4231-96a8-2a593027dbf2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-11-03T16:48:11.0989657+00:00"
},
"company_sector_id": "2a1f87ac-cf68-45f7-9c4d-8dd1571e4e33",
"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": "d01ea1bd-52ef-4235-8d2d-162c6f89d514",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "87210167-b381-4916-bf8f-87747074d18a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9150f3ef-e62b-4903-a4d6-faf90e12c985",
"account_manager_user_code": "sample string 56",
"company_status_id": "6c4eef4d-e259-4414-9efd-b4461a282c1e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-11-03T16:48:11.0989657+00:00",
"id2": 60
},
"db_language_id": "89f7a6b9-dd12-4292-a91b-51319a44caf0",
"db_language_code": "sample string 7",
"db_title_id": "9b09e75c-fe30-42d7-a6e1-8fad751e85db",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-11-03T16:48:11.0989657+00:00",
"create_date": "2023-11-03T16:48:11.0989657+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-11-03T16:48:11.0989657+00:00"
}