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": "c862ab57-5f67-4e89-82b5-e50dc7ff683e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e666aee7-c2e3-4097-8327-88bfd623641d",
"company_code": "sample string 5",
"company": {
"id": "f1408bbf-edb7-4d1e-859c-093d2e6d3ad1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2022-12-02T20:35:33.1314431+01:00",
"sales_territory_id": "c667520c-95c3-4935-94f4-cfc1ac7c0562",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5cc988e7-66bd-4634-82ac-f4ebe05fd298",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "19b296e1-abf5-45e8-9eb9-6f9268f9dd8e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1acbb00d-711e-4be6-8f2a-6b507d298e89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7be9a1a0-ee12-40b0-815c-68ba613f3278",
"db_currency_id": "79d439f3-aeb6-497b-b60a-ca31f53250ad",
"db_language_id": "df3b5537-9103-4a00-b42f-505fbd7ee015",
"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": "2022-12-02T20:35:33.1314431+01:00"
},
"modified_dateutc": "2022-12-02T20:35:33.1314431+01:00"
},
"marketing_segment_id": "bdd627ce-36e9-49cf-baf4-12e651e6232e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0db7414f-2673-431e-8228-671848c40013",
"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": "d47d8d94-2678-4935-978c-1fc447d1d194",
"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": "25d6d40b-71ab-42a6-83fb-e53282d7d82d",
"db_country_code": "sample string 28",
"feelist_id": "dfad1de3-03b8-4ef8-b10c-442c47666845",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f6eb9721-9259-4804-839b-11c640d0b85b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ab513854-50b0-4d4f-ae07-40e8ff8a1dfa",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2022-12-02T20:35:33.1314431+01:00"
},
"company_type_id": "2fd89b21-7567-4f08-9412-c456340a115f",
"company_type_name": "sample string 32",
"company_type": {
"id": "1a5612cc-e0a2-4a79-bd6c-33428e73f3a1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a8f3cf65-15ff-432d-b741-abbb279fba9a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2384671b-b9c1-4119-9fe4-df95772dbe98",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c40fd7a4-6168-436a-ba2d-54b9afb55ff4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b4cf33ce-8a74-4124-b8ff-99ecd247d2d0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "91cbb186-457f-4140-8a01-328b3513c05e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2022-12-02T20:35:33.1314431+01:00"
},
"company_sector_id": "32eb25e1-e82a-4eb4-ac11-359e8f991be0",
"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": "76e66db0-7c68-4a88-bef4-dc2b064bfb7a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d916d67a-d017-42d7-a74e-1c074aa980d3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a0833469-db72-480a-bd93-8da31262ed03",
"account_manager_user_code": "sample string 56",
"company_status_id": "cfa8f8cf-04a2-461c-947f-fa4b20dbcf2b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2022-12-02T20:35:33.1314431+01:00",
"id2": 60
},
"db_language_id": "a648dcc7-c252-42bf-8809-8d0a1b385241",
"db_language_code": "sample string 7",
"db_title_id": "a898a6d4-70d8-4097-934b-a53c367393bd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2022-12-02T20:35:33.1314431+01:00",
"create_date": "2022-12-02T20:35:33.1314431+01: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": "2022-12-02T20:35:33.1314431+01:00"
}