Retrieves all the company contact
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
contactName | 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
{ "id": "c1de3b57-1d30-42e1-96df-a4c6064775a6", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "47bb4417-fc1e-4bb5-81a8-ca3678829ec1", "company_code": "sample string 5", "company": { "id": "57a27aab-582b-4f74-be3b-e1fb0f9c54c8", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-05-07T05:37:33.4071569+00:00", "sales_territory_id": "8e272a65-b6c6-4e2b-ba90-907237111485", "sales_territory_code": "sample string 9", "sales_territory": { "id": "21441c12-562d-4e4a-bb5e-87253d2a041f", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "ab4da823-1325-4248-b3f2-3487c85c7b6f", "sales_organization_code": "sample string 5", "sales_organization": { "id": "49fd8f50-ee89-45ab-b267-86b3b8dcc590", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "665a2274-0bdf-4d16-ae69-167ff0516b8c", "db_currency_id": "b092bd0a-2707-4e12-96f7-72d8a0b675b5", "db_language_id": "80a68193-5ac9-41c1-89f8-aa2d46bf37bc", "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": "2025-05-07T05:37:33.4071569+00:00" }, "modified_dateutc": "2025-05-07T05:37:33.4071569+00:00" }, "marketing_segment_id": "1a16e6f5-c722-482d-b1ca-e7e84a82952e", "marketing_segment_code": "sample string 11", "sales_organization_id": "13a374c8-18c5-46de-8522-c0c2a1869b08", "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": "c369f309-ec4c-4963-883b-a0058f4197a6", "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": "bc2d5b69-f9a2-4658-92f1-847b9290f0f2", "db_country_code": "sample string 28", "feelist_id": "295252a2-867f-4bc3-b117-04690a8a9684", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "7cc9cbd2-2a28-4e52-b0d5-c72439f97d62", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "7f9fb37f-11b5-42ea-85d3-fafb0d585689", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-05-07T05:37:33.4071569+00:00", "db_currency_id": "c6d16f37-5495-4f1c-8778-dd5a025f1c80", "db_currency_code": "sample string 10" }, "company_type_id": "6d6eae99-f377-4e58-b41f-47e036acb11c", "company_type_name": "sample string 32", "company_type": { "id": "0cc5ab4e-2ca4-4c06-817f-ebe9e97f34d3", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "0eed12a1-88a3-4f3b-ad03-c7551d803546", "sales_organization_code": "sample string 5" }, "db_language_id": "f61da10d-bb9c-4e32-bd35-b6516ade938e", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "c785e62b-c052-4e80-ad47-3accbedbdea2", "article_price_label_code": "sample string 37", "db_payment_method_id": "0eb57440-1356-4512-9d64-f5a301b3be5c", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "54fca980-440f-441d-be85-ca32c1d71786", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-05-07T05:37:33.4071569+00:00" }, "company_sector_id": "91e1c325-dd1a-43c1-b021-9970ba844879", "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": "cd6c33f7-3807-4e47-bcde-bfc684281edd", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "6f68cbef-6eac-4b66-bcc8-10afedb69b12", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "d4dd834c-d0b8-401b-be8c-4b55a5abb426", "account_manager_user_code": "sample string 56", "company_status_id": "9c61b02b-25a5-4249-b4a5-55557e93997a", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-05-07T05:37:33.4071569+00:00", "id2": 60 }, "db_language_id": "a18cd32b-4e79-4fa5-a7f5-3637c38c2070", "db_language_code": "sample string 7", "db_title_id": "e0528391-44b7-44a9-9942-c75f48f7f50b", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-05-07T05:37:33.4071569+00:00", "create_date": "2025-05-07T05:37:33.4071569+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": "2025-05-07T05:37:33.4071569+00:00" }