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": "26144449-bf57-4069-acbe-92dd84ed9d6d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "59b8f773-9222-404b-a03e-239c99dd5d3e",
"company_code": "sample string 5",
"company": {
"id": "c60532d6-6725-435b-80fd-f2c254e1ac00",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-20T11:14:12.7760144+00:00",
"sales_territory_id": "35fc79fe-9ebc-4258-986c-7b664b72ab60",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6391fedb-e1f1-48d9-a651-8a0348175956",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1cee24e1-2632-4c44-afd7-6af143890bec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "59540d4a-07a5-4cdf-b1ea-de7b735cfc1b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de51acf1-fed8-4012-a363-3bdef0545633",
"db_currency_id": "73f00e18-3886-48b2-b3f7-eb80445d254c",
"db_language_id": "e7ab4586-bb36-4b3c-bd47-ba65ca16f9ee",
"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-11-20T11:14:12.7760144+00:00"
},
"modified_dateutc": "2024-11-20T11:14:12.7760144+00:00"
},
"marketing_segment_id": "d3567bde-8322-4715-b9e3-95a6282f64b3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "97211aa5-2b16-4828-a362-a876f1d9c902",
"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": "7391c8d8-0407-411b-8d9e-dfe05c667f35",
"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": "57226d3b-7e1e-46c2-adf2-faecb37b41f5",
"db_country_code": "sample string 28",
"feelist_id": "3aa0a48d-c512-4f66-a43a-f0c8c143afb6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bec10808-8f84-4314-a6e2-fa10f00b7c84",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "434b1cac-8e81-4e01-89b1-08db9d1a2100",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-20T11:14:12.7760144+00:00",
"db_currency_id": "f1df3972-1ecf-4a6d-8454-ed74a91ebf33",
"db_currency_code": "sample string 10"
},
"company_type_id": "6cd00461-ca61-4f08-a994-4bd7599ccb70",
"company_type_name": "sample string 32",
"company_type": {
"id": "6f71cd2d-5fb9-431d-84de-f9b79d499ecb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f06c14a5-3fe4-43dc-b445-92ac21535069",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f3a7508c-6124-4bd8-91c8-eb08136c63e3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4c571ac7-1f0d-4301-9409-af622364e004",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a6b28c07-2bd3-4f18-aed5-1c56c3f98a03",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e6df7b64-7143-4d2f-a8ca-3e7840f874da",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-20T11:14:12.7760144+00:00"
},
"company_sector_id": "4008bbb8-e508-459d-adce-4a31875a428c",
"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": "8c978003-917f-460e-9fea-00e22d2397e0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1a96b6f0-1e30-4a0e-9240-6b49a785b58b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "49534ea7-6b57-4c39-af5f-0f441819eaca",
"account_manager_user_code": "sample string 56",
"company_status_id": "fd07a451-4344-4ea8-bfe2-22ab323f5173",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-20T11:14:12.7760144+00:00",
"id2": 60
},
"db_language_id": "bb3c9eb2-0295-4d24-8c96-21a8f79c4a68",
"db_language_code": "sample string 7",
"db_title_id": "39dfdddf-599e-43d4-962b-22dc08d95e3e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-20T11:14:12.7760144+00:00",
"create_date": "2024-11-20T11:14:12.7760144+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-11-20T11:14:12.7760144+00:00"
}