Retrieves all the company contact
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": "2eb95ef7-3549-4a5a-8fc1-093e12b21d3f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "92735f81-5001-4003-8814-9fca7b111fc4",
"company_code": "sample string 5",
"company": {
"id": "fff0df11-9623-4deb-85b9-7da30b24664e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-21T17:03:11.4005603+00:00",
"sales_territory_id": "3194cb73-4d42-4914-86a6-2a50e65a656d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e4f268c4-f26a-4e51-a623-a727fa800dde",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7f234ca8-0ea0-4d13-93f8-bbd5ed068c48",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0938f9d8-97f3-4722-8e49-d1e7cedcf3db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1111a4e3-2386-4144-8d44-f978ef5a6ee7",
"db_currency_id": "e424f109-1ff2-4130-b497-3c9f828e9876",
"db_language_id": "1ab5fd59-f164-4538-a47d-e716a7107857",
"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-12-21T17:03:11.4005603+00:00"
},
"modified_dateutc": "2024-12-21T17:03:11.4005603+00:00"
},
"marketing_segment_id": "822891b5-095c-473f-8fc9-07cfb8f5be85",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bb58dbac-d62a-472a-9ee8-766ced7efcf3",
"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": "232053b2-3f9d-4fd2-8a16-006f5c7dea7e",
"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": "d27f0d99-c0a6-4a81-aabc-3daf2d7efd06",
"db_country_code": "sample string 28",
"feelist_id": "2771c2e8-e915-4126-b4c4-a6b7889e7216",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d490df3a-ddb7-466d-a5e9-839dd8a58ef2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c4e03f9d-b6c0-4437-89d5-e2832e133dea",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-21T17:03:11.4005603+00:00",
"db_currency_id": "048bf08b-cc05-411e-b8c8-9e77c76c702b",
"db_currency_code": "sample string 10"
},
"company_type_id": "23bb4d97-a321-4360-8245-28fb772a4b84",
"company_type_name": "sample string 32",
"company_type": {
"id": "881e9bff-bf9c-48db-a662-e36ef8030cec",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "21fda37f-253d-4c59-b744-5fdbf08680c8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0c32a08c-d21e-4a98-80cb-7b027388494f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8f01479b-9ad0-40a7-84b9-c9f171c2a942",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "23a17f26-6d5b-4f06-938d-2affc6ccae4a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ad25cc2c-1edf-4ff4-8c02-4e75cd406d1d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-21T17:03:11.4005603+00:00"
},
"company_sector_id": "73254304-8b8b-4d20-8c07-4b4c7246394f",
"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": "4e7c4226-c49b-4a73-907b-3153cbe2ea87",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "20d42968-eb75-40df-8bc5-b130e4b63dd3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2f5c73ff-f232-4ec4-ba8f-91e91c972634",
"account_manager_user_code": "sample string 56",
"company_status_id": "79973310-d1d9-4c5e-b3b0-51fdf54d08ee",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-21T17:03:11.4005603+00:00",
"id2": 60
},
"db_language_id": "1b5b76c3-623b-4bfa-b260-5d7879400fae",
"db_language_code": "sample string 7",
"db_title_id": "a7869ecb-3b16-4a2f-bf4c-b4628ff7fef0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-21T17:03:11.4005603+00:00",
"create_date": "2024-12-21T17:03:11.4005603+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-12-21T17:03:11.4005603+00:00"
}