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": "6b0994f1-4bd3-4d7a-a663-977db706cef3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c55de6a8-5325-423b-b48a-7f67ebdae9c3",
"company_code": "sample string 5",
"company": {
"id": "3d92aeea-1aba-481d-acc5-ab38bb15facc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-21T09:29:39.0406425+00:00",
"sales_territory_id": "a698bb31-9b56-46f4-a70b-a8a575f364cf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9e607486-2f0e-4342-9e34-5714a883294f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f32b3e16-80c5-4bb2-ad7b-18ac6841d0d9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c5584916-ae75-40f4-a1bf-7d52e39f628f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "756549b5-76ac-4535-9881-1c2cc6be1384",
"db_currency_id": "ae95ee73-3806-4c09-9e93-cab65f6066f3",
"db_language_id": "20f37a23-e851-4c1c-b2a3-2edb065e398f",
"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-21T09:29:39.0406425+00:00"
},
"modified_dateutc": "2024-11-21T09:29:39.0406425+00:00"
},
"marketing_segment_id": "94b6e338-45e2-4f7d-839f-cc6b5dd7abe2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1b687dc1-3cd8-4455-9c46-5eb929e9f907",
"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": "2fee870a-ecb5-404f-9ab0-d3e782063b6a",
"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": "4d4d59ce-61ef-4cde-af13-efd569e96063",
"db_country_code": "sample string 28",
"feelist_id": "96e7d844-04f7-4210-aedb-5088a4b75b36",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2a36c4c2-eb97-49c0-a3d8-e67df16bf9ab",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ddfb1221-3579-42bd-b723-2e3179211eb8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-21T09:29:39.0406425+00:00",
"db_currency_id": "f9346816-85aa-420c-8d1d-6631a2b143de",
"db_currency_code": "sample string 10"
},
"company_type_id": "e7275d9e-cdcb-45d1-9e2d-3051a66475fe",
"company_type_name": "sample string 32",
"company_type": {
"id": "fa117ba9-4c16-4319-9856-2832749ef109",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e2315920-9024-4b4c-a524-c5b74c05211d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "677b82b0-716b-49d9-b5df-0da4d8e2b9b8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "22a7b3ba-04d1-47b2-ab82-2ce399e2fc31",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c6498436-24f6-4408-9da1-1f0ee2159e42",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f734358b-4128-4875-82b0-8670a7189522",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-21T09:29:39.0406425+00:00"
},
"company_sector_id": "4c838bcc-4e04-4e4d-9b79-ef2cbe00e3f0",
"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": "2efac1b6-7528-41af-accc-ea09b5f4b09c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "99f4137d-5105-4508-b98d-597773d92168",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b06e6128-ad91-4c70-a84b-0093d50d9ce8",
"account_manager_user_code": "sample string 56",
"company_status_id": "27d023b7-1eca-44b7-8f8e-af930b2e9cea",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-21T09:29:39.0406425+00:00",
"id2": 60
},
"db_language_id": "30478cf3-352f-4bdf-be33-a92242aece7a",
"db_language_code": "sample string 7",
"db_title_id": "65d6271b-6501-48ba-9d41-6e1dca16a93b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-21T09:29:39.0406425+00:00",
"create_date": "2024-11-21T09:29:39.0406425+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-21T09:29:39.0406425+00:00"
}