Retrieves all the contacts
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
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": "e126997d-4d4a-4ccb-a5b5-873c7367182c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2c75e8a6-15c5-4285-a9a3-912d5d75ce50",
"company_code": "sample string 5",
"company": {
"id": "57528185-eb06-4334-ac0f-ff4870e98eeb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-18T18:16:10.7907723+00:00",
"sales_territory_id": "0ac1158c-9733-4e52-bfd6-97fa6e026f23",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "593630ee-1482-4671-8ca6-ea1a8ddb23e9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "019c9f53-e26b-4173-bc7f-ab56a9f538f1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a7f43eef-2743-4c76-b822-d75956ab4263",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f230aae6-acaa-4dbe-9dec-db15345a129c",
"db_currency_id": "fdc12bef-3298-41d8-881d-f358c9294e7a",
"db_language_id": "5eb986d9-cdb6-4299-a02e-31bbcd6739be",
"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-18T18:16:10.7907723+00:00"
},
"modified_dateutc": "2024-11-18T18:16:10.7907723+00:00"
},
"marketing_segment_id": "ac3c2e3c-016b-4dd0-be37-be1d871ee102",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f2d2a055-9cb5-49aa-b41f-643a5f553959",
"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": "87b80163-96b1-4052-a522-6d81b51d5589",
"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": "641dd6d2-6b23-477a-a3ea-bfcf4b567d55",
"db_country_code": "sample string 28",
"feelist_id": "553f67c7-c15f-4b85-93c6-073714f12c2c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ff7bc825-aae2-4a27-8d41-947b1f105844",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5ea53658-ab4c-4f1d-913f-3eb2e4893dbe",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-18T18:16:10.7907723+00:00",
"db_currency_id": "b4c5b05d-c8b6-4247-873e-32fb8422265e",
"db_currency_code": "sample string 10"
},
"company_type_id": "8153cd67-d3ed-412c-9ec7-f99dd17bd54a",
"company_type_name": "sample string 32",
"company_type": {
"id": "159d05aa-6ac5-43f9-9d85-402c9d8c270a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e56e1124-4dd7-419f-889f-9b323d3ded51",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c9301c54-14d0-454b-b34e-77244622c361",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "eb0b4caa-0363-4740-bc2d-8f1aedd65eeb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "46208fa5-5fdc-4587-a0ac-8be6552df65b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3e61347c-1059-4ca6-af9e-b8e72ebfd6c2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-18T18:16:10.7907723+00:00"
},
"company_sector_id": "ba89d82b-a35c-429e-9ec5-fc8b941885c0",
"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": "018489d6-d8cb-48b9-9861-83c56150ea13",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3a2cc087-016e-4dfa-b2c9-40772c997cd4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a3846abf-f180-43a4-9d70-5a8ae92c27ef",
"account_manager_user_code": "sample string 56",
"company_status_id": "c88e6d13-2c8c-4c46-87ca-dd038d47721a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-18T18:16:10.7907723+00:00",
"id2": 60
},
"db_language_id": "0df4fde7-4fde-42d5-83d5-92ef0e32f9c0",
"db_language_code": "sample string 7",
"db_title_id": "e76d0370-41e4-47a4-bb25-384589282bca",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-18T18:16:10.7907723+00:00",
"create_date": "2024-11-18T18:16:10.7907723+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-18T18:16:10.7907723+00:00"
}