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": "30d7e62e-a947-4c67-ae78-70260cdc3d15",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c71e8980-5acb-40ca-85e0-90bb78b79878",
"company_code": "sample string 5",
"company": {
"id": "6b8b9ae1-1f6d-4060-81b7-f07f0b5a0f48",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-25T22:09:18.7456477+00:00",
"sales_territory_id": "b22a1fa9-2ffe-46e6-a8b8-ad0f77525ce4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "18902431-ce86-4836-a5a8-50135c47ca2a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1a6267f5-6331-4e8d-b3f5-d3bc700189f8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "17943570-e5ce-42a9-a482-6c58be5e2be5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85d32b16-5f2d-4468-8076-9d70d42a3a98",
"db_currency_id": "cc2c496e-e9c1-4af8-a7e1-76524298407f",
"db_language_id": "787f8a07-d7e0-4185-a24d-03112497d47a",
"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": "2024-12-25T22:09:18.7456477+00:00"
},
"modified_dateutc": "2024-12-25T22:09:18.7456477+00:00"
},
"marketing_segment_id": "8c6a907c-e12b-4c02-9575-0d7fe8ccf92f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "941a2aaf-58c5-4786-9564-0c5c3bbea222",
"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": "5ba238be-26a2-424d-837c-f7a94cd41670",
"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": "581914cd-7019-4626-bc5d-481d85ce7477",
"db_country_code": "sample string 28",
"feelist_id": "6924d98c-4764-4333-8e52-5d23c3afd3f4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5ac08835-3687-4ba0-88f3-79e6ab72fefe",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "48949810-cdfd-4c0f-bd40-288b05fcde60",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-25T22:09:18.7456477+00:00",
"db_currency_id": "30565eed-db91-498a-a1d2-828e1f74de19",
"db_currency_code": "sample string 10"
},
"company_type_id": "a498e333-bdfd-4122-bab5-2c77e1e67129",
"company_type_name": "sample string 32",
"company_type": {
"id": "f66a4ab8-5dd7-4e28-a0d8-8779ab7c432d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f17e29e9-8d82-4357-8d66-71fa1a362a34",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d3bfaf30-194a-4cd5-b563-bff4822389cd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "eb7be225-f4ce-4c25-8a98-c7d2b7d244a1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "62c26661-2145-4d43-8288-9b09a282046a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9fd9578c-e3ef-4dac-a185-433c6bca3fac",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-25T22:09:18.7456477+00:00"
},
"company_sector_id": "14962a66-dcad-4c1f-b1fa-a2ec9ad57771",
"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": "19c6ca95-f9ca-4cb3-9ba6-2a271d8431fe",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5a6bf117-d7f4-4d49-b843-41f95eaf3eed",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "69f7e58b-3789-4135-afbe-6f9a36ec1c8b",
"account_manager_user_code": "sample string 56",
"company_status_id": "fc62506b-8976-4a75-874c-977581e15f8e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-25T22:09:18.7456477+00:00",
"id2": 60
},
"db_language_id": "cd6127e1-3d63-4dc5-ab3b-ddbb3e15ae00",
"db_language_code": "sample string 7",
"db_title_id": "4da6d223-acdf-43b2-a13e-c9f2e8a41bed",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-25T22:09:18.7456477+00:00",
"create_date": "2024-12-25T22:09:18.7456477+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": "2024-12-25T22:09:18.7456477+00:00"
}