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": "5a5a6600-fe89-4cca-b455-d466737719ce",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "037d95fc-5477-4475-a5e7-e45561e942f1",
"company_code": "sample string 5",
"company": {
"id": "ef13cc97-a098-4dfb-9039-6e116a1a01da",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-09-16T08:12:42.2321702+00:00",
"sales_territory_id": "48960759-c744-405f-9981-2ccf191b8a3d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3adb75e2-f672-44a7-beaa-48598e848f3d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9a8ebb52-058d-4019-a1c1-cc051f436dd5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "315833ff-5bb7-4cd7-9155-7d9c3e732dd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afb8f6d0-bce9-4cd7-871e-558e51f7bbcd",
"db_currency_id": "224fb80c-1dfb-410d-a224-06f7ac930826",
"db_language_id": "1d7b652a-b736-4424-977b-be8705afeb9c",
"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-09-16T08:12:42.2321702+00:00"
},
"modified_dateutc": "2023-09-16T08:12:42.2321702+00:00"
},
"marketing_segment_id": "cceb6784-5ac1-4ec1-bc1d-56d1208a26fc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "663ed572-e7f8-4cdb-b5d2-7cd4bf73bb7d",
"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": "2fd99e35-a19e-499c-8c71-db9504d37800",
"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": "8714e782-3e7e-41db-8174-226588cc8d82",
"db_country_code": "sample string 28",
"feelist_id": "37c66115-9cc7-4020-be04-2217abc23c0a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "066d029d-60e1-41e5-a606-86b21ee4674d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0830c170-71ec-42a8-afc7-8857aa2555ad",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-09-16T08:12:42.2321702+00:00",
"db_currency_id": "46c208c7-9a4c-4dd4-bc1a-94854120266b",
"db_currency_code": "sample string 10"
},
"company_type_id": "394afaac-8110-4aac-83fd-574a29a114cf",
"company_type_name": "sample string 32",
"company_type": {
"id": "385bdd0b-5eb0-44ca-9b17-88b079ccc578",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a68e4bd2-479b-4fcc-aee2-8591dc6a69be",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ed6602f3-c316-413d-975d-21980c0dacfe",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "760c3d80-9067-4039-ae95-72ba704b6e2e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "48fbbf72-f65b-4f4c-926a-7638d71fbe7a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7a423184-f8d7-400d-9aa4-bcdb086fbf3c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-09-16T08:12:42.2321702+00:00"
},
"company_sector_id": "1d66ad9e-3e32-4f70-9bfb-291336d2a71e",
"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": "a17b317f-235f-48aa-8295-d8e420381cf0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a6581dd1-d9f1-4ef5-a811-7f0d1da6c70c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a42303f5-5648-4ba9-8334-e774c7a15517",
"account_manager_user_code": "sample string 56",
"company_status_id": "f277aafc-9585-45b0-9eb6-47da5394d3ea",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-09-16T08:12:42.2321702+00:00",
"id2": 60
},
"db_language_id": "4b75b98d-e279-4116-a77e-04a8d68d04d8",
"db_language_code": "sample string 7",
"db_title_id": "b3bab7ff-ee77-478d-9bbb-d8990de4ad20",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-09-16T08:12:42.2321702+00:00",
"create_date": "2023-09-16T08:12:42.2321702+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-09-16T08:12:42.2321702+00:00"
}