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": "f64ea5b3-da4d-4c68-b58b-11455f572b44",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7f2b4d1f-24df-4196-aba9-57960b771dd3",
"company_code": "sample string 5",
"company": {
"id": "c11d54a2-ec12-4f5e-81a5-ec4e6cb54905",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-01-30T10:49:51.9472824+00:00",
"sales_territory_id": "c6806b86-540f-4c37-9e64-e9ce6edd9fc3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a907e6eb-f6fd-44bb-9052-2b7d14dc2489",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "35171868-2bbc-4a91-b7b3-66e7b4ba0605",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d4716b44-8c34-43dc-a8a8-e2ae6e9a23e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e33eeaf0-1760-4a34-95fc-6876a01191e9",
"db_currency_id": "28769295-9211-4fbb-8176-d87e208bd76e",
"db_language_id": "4de9d9c8-8a84-43f5-91fa-99938d1e1a70",
"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-01-30T10:49:51.9629087+00:00"
},
"modified_dateutc": "2025-01-30T10:49:51.9629087+00:00"
},
"marketing_segment_id": "93a44a0b-d553-40e3-b21e-313aa6b7754d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9a43e6f0-6b20-4889-89a5-300766f2ad83",
"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": "967c0ae3-f61a-4755-a003-190603b5aa59",
"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": "edd1f344-bab1-4af2-a444-a8cd687033bb",
"db_country_code": "sample string 28",
"feelist_id": "39d001e6-1612-4ca6-bcc1-cb345c83d8f7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c6202f2d-c483-479e-bf01-2a4f1b40ac57",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f95b9a33-d526-4a87-a4b8-17b71929dbff",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-01-30T10:49:51.9629087+00:00",
"db_currency_id": "2669f990-bb3d-4185-a639-fbfa080a68aa",
"db_currency_code": "sample string 10"
},
"company_type_id": "d3f7b105-9f69-45d0-9142-dc39ddf17b4e",
"company_type_name": "sample string 32",
"company_type": {
"id": "dc074f2e-2857-4079-aab4-15b9a47f4677",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "570cd5ee-7d53-49ed-aef9-d63fac68d85d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "30e906f8-286f-4c7c-84c0-9ad519e7d757",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "30bd8d47-6b91-4753-a197-d71c05b371d0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "013662df-28d3-4685-9b75-8dee8dfe4189",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5d4fd22a-3a23-4730-836a-c7e4a502ca20",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-01-30T10:49:51.9629087+00:00"
},
"company_sector_id": "f166ca6f-4363-4201-a411-00385ab0156d",
"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": "81a14b8c-79c6-4bd5-a71d-5a27b70fe4e8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "53be6ce4-e6d8-43c2-907b-b1d7dc984eb3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6fc7b0b4-1d5b-443c-bad8-879942f15538",
"account_manager_user_code": "sample string 56",
"company_status_id": "d10e1940-4f57-45e7-8df1-4419d131c8c0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-01-30T10:49:51.9629087+00:00",
"id2": 60
},
"db_language_id": "9213181e-95c5-498d-88e8-b7a0d2cbaf46",
"db_language_code": "sample string 7",
"db_title_id": "faa4a13f-adf7-4770-aaa9-3a647b108397",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-01-30T10:49:51.9629087+00:00",
"create_date": "2025-01-30T10:49:51.9629087+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-01-30T10:49:51.9629087+00:00"
}