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": "886119b6-c36c-4ee4-8edc-39e2d782e83c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3c9a311f-2260-4f58-b206-0cf7f505a0b3",
"company_code": "sample string 5",
"company": {
"id": "627a39c2-ccdc-4a3c-9ff7-63972c228845",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-03-31T22:24:20.0322182+00:00",
"sales_territory_id": "f16de138-290d-480f-b529-8dd660246abe",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d7984b2b-a615-4137-bc6d-a69d2957e9b0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f0703a39-5cad-4158-8e52-9b057b9ea4b2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e30f3e0d-4ed5-4705-baf5-a5d071c0bbf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09ebfc0b-df1c-4308-8290-9977e83b6885",
"db_currency_id": "ff910c81-798e-427d-a748-dbf4daa44a6b",
"db_language_id": "e8ca5023-3727-41b3-8df5-dec18959de99",
"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-03-31T22:24:20.0322182+00:00"
},
"modified_dateutc": "2023-03-31T22:24:20.0322182+00:00"
},
"marketing_segment_id": "682f6668-09f2-44b7-a72b-5e324beb6da6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "12320d0f-9192-4953-bea8-7b3f7637eca4",
"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": "2810894f-17f7-4aee-9434-0d59a4bf11cb",
"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": "ce43530f-87c8-4766-b323-06a738e6c7da",
"db_country_code": "sample string 28",
"feelist_id": "bf11cc4f-26dc-4b27-a3fa-cb346f3dd5c1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0869ea69-c493-4465-a1ae-de8f1445249d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "69346474-e266-4dca-8f78-bc49a1634bbb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-03-31T22:24:20.0322182+00:00"
},
"company_type_id": "63ccc0d5-6a1b-4bab-b5cf-2c397353167f",
"company_type_name": "sample string 32",
"company_type": {
"id": "db6a2398-69b4-487f-9b77-4484cee6225f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "092f0f8b-4b2b-4f2a-a14f-246a96ebbf09",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d45cf391-64fb-4ef2-8be8-334809c6b4d0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fc28b692-cec3-42f6-84b4-32443d34f90b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1357a3c1-e3c0-4059-a92d-96b5b84be229",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3f996039-a464-4849-9327-d5a22ab69ff7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-03-31T22:24:20.0322182+00:00"
},
"company_sector_id": "a10c3fdf-33af-4014-b340-aef3dd0b1066",
"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": "2d2b50f2-c138-42f5-87ca-2386d0547254",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cd4f3db8-1fdc-4cec-9153-1e401baf7ef3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "192d8e1b-3848-45a3-93aa-6c57a570ca61",
"account_manager_user_code": "sample string 56",
"company_status_id": "73986bbc-979d-4ef4-abf4-921771df6863",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-03-31T22:24:20.0322182+00:00",
"id2": 60
},
"db_language_id": "f19be6a1-4d46-4adc-82ce-d52df8f42ac0",
"db_language_code": "sample string 7",
"db_title_id": "3aa7dca1-79f8-4aa1-9843-6112d5485290",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-03-31T22:24:20.0322182+00:00",
"create_date": "2023-03-31T22:24:20.0322182+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-03-31T22:24:20.0322182+00:00"
}