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": "6cca2dc2-4b87-4beb-8ea7-be2efb236ca4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0c8bd437-6921-44b0-9880-a07169d61d5b",
"company_code": "sample string 5",
"company": {
"id": "664ce4bb-736c-4dff-8260-c9e2fc866c52",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-21T16:48:53.0675338+00:00",
"sales_territory_id": "bbefc5c6-8e55-4c80-90f5-1287ca16706c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f5888a98-fc42-4dc3-ab3f-4c2cb65e1683",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3d950e87-e3e6-445e-9a83-aa3ee0fb6af9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b1a18327-7778-4281-9cc4-c654a9fc6054",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a191de5-dbe7-4615-a098-cc8743b08b82",
"db_currency_id": "5e0d6c9e-2f72-4132-b87f-f9b7102f8f9e",
"db_language_id": "93f048b6-2aac-4f1a-a116-764e9fe7dc95",
"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-21T16:48:53.0675338+00:00"
},
"modified_dateutc": "2024-12-21T16:48:53.0675338+00:00"
},
"marketing_segment_id": "3d83fe00-15bc-4fa3-89d8-6e3260c136c4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8e261106-b76c-4982-ac1e-f28310709b6e",
"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": "f3e6d53c-6283-4ae1-a3b6-ebca03ce1a97",
"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": "c229c0b5-061d-4d53-a74c-7e6a8f310adb",
"db_country_code": "sample string 28",
"feelist_id": "c251d0be-a0dc-4a1c-9d54-64a1691acb20",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "17b4b2a6-78d6-4bdc-a067-58a62a98c467",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bfd619b0-0220-4282-86d8-3b13fcea6440",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-21T16:48:53.0675338+00:00",
"db_currency_id": "cf2d17a6-d8f3-4898-9875-2c5f75fca12f",
"db_currency_code": "sample string 10"
},
"company_type_id": "cef8530a-61bd-44d8-9e49-d3c8de6430a5",
"company_type_name": "sample string 32",
"company_type": {
"id": "87cff5fc-05d0-4094-8536-b167b11c54f4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ae9a7ffc-7178-4288-9a47-ce9a8998d543",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2140b1ae-2371-4f1b-914f-f3b3ec261e38",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5956c1f1-18ca-4537-b797-449d3f187cdc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "43ea5c98-977e-4262-b8b6-39be1662f8b9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f6f17394-1cd1-432b-9a47-8aecad6e2dbc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-21T16:48:53.0675338+00:00"
},
"company_sector_id": "f8b1c4e7-2188-427c-99ef-a5246de2c937",
"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": "f31e9eb2-396d-4c50-bbe8-1920154d609f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1314a02a-fb65-4884-bcbf-d29958eb6a00",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ddc03709-c6c8-4415-999a-06b3faaefe4a",
"account_manager_user_code": "sample string 56",
"company_status_id": "82e1019f-a45d-41d9-819e-2ae5d362d78c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-21T16:48:53.0675338+00:00",
"id2": 60
},
"db_language_id": "abcf144e-7af8-428a-8b4f-81bf2cdae4f2",
"db_language_code": "sample string 7",
"db_title_id": "f9938439-ec20-4be6-be5a-4cdb4969917d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-21T16:48:53.0675338+00:00",
"create_date": "2024-12-21T16:48:53.0675338+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-21T16:48:53.0675338+00:00"
}