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": "996b5d33-4195-433a-a500-bc20e34b67f1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "02930b0c-4230-4b5b-b735-df780c8e584e",
"company_code": "sample string 5",
"company": {
"id": "2c5d6bbc-6b8e-4723-be67-8b843763a411",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-21T11:57:37.145815+00:00",
"sales_territory_id": "58cc402a-75d8-4c03-b359-669562eaaeba",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "08e668bb-46ac-41d3-b3e8-8fed7774e1fe",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "756b6958-b77a-4ded-a3da-0f93c86a8845",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1c12a040-ab9a-4247-8a04-cd89d9feedd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c901dbab-5f8e-4ade-a2b0-5ce16c995261",
"db_currency_id": "3741c774-f982-4a8e-b549-3d624853b46b",
"db_language_id": "853fff29-cc99-48ad-b8a3-6c172c1aba82",
"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-06-21T11:57:37.145815+00:00"
},
"modified_dateutc": "2025-06-21T11:57:37.145815+00:00"
},
"marketing_segment_id": "06c4da16-52b4-4229-be3a-cdda87f34106",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3e9252d6-ef0f-4b9f-a351-6aee22861b34",
"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": "316b7f0b-57e6-49cb-b850-13e773b4c606",
"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": "dd6471dc-4dba-436a-ade9-7cbdce58da27",
"db_country_code": "sample string 28",
"feelist_id": "62c75ff2-46a3-4ed3-a72a-5e186420d29b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ccded0b0-b026-4dc7-8564-50aef1fd7b3e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1685ab87-b112-4afd-b13a-d28319a55cdd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-21T11:57:37.145815+00:00",
"db_currency_id": "a3e36762-5091-430f-885f-391e32969c5e",
"db_currency_code": "sample string 10"
},
"company_type_id": "96b1c9a3-e71f-4d2b-bb1a-c754659f1b1a",
"company_type_name": "sample string 32",
"company_type": {
"id": "c871603c-e25a-4ce4-b165-4108b694ce7a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4eb5fe89-c705-4404-9cec-127bd3fd8ced",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e020dabc-9250-46ed-9d7d-8e99219ea6d1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4294702b-c5ae-4ae8-b3c7-155af8c0977e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cc3a3c30-234f-4540-9868-14fdbbb05b6d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5e4f6e54-e7b2-4b92-b71c-a8b64afb08ca",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-21T11:57:37.145815+00:00"
},
"company_sector_id": "12dec9da-4345-4c5b-ad59-54360f506419",
"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": "7981b1d4-1898-4e6f-8a2b-4ddaa39af613",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2625db6e-4c64-4000-b70c-7385715c6d89",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "be07b0ae-0816-4429-8f9e-8800b20495e4",
"account_manager_user_code": "sample string 56",
"company_status_id": "0346ea05-639f-4c88-b9cc-39cc681818c1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-21T11:57:37.145815+00:00",
"id2": 60
},
"db_language_id": "a65521d9-4445-4f72-8f81-383fe26444a9",
"db_language_code": "sample string 7",
"db_title_id": "c0fc9aa5-bb95-44cd-9e70-2149a091eecb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-21T11:57:37.145815+00:00",
"create_date": "2025-06-21T11:57:37.145815+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-06-21T11:57:37.145815+00:00"
}