Creates a new contact object
Request Information
URI Parameters :
None.
Body Parameters :
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 |
Request Formats :
application/json, text/json
Sample:
{
"id": "2ee54a90-d6ef-415a-b81d-9de22a8acdd2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a22732cc-88ba-4b0b-b426-7e9c9dc7a0d5",
"company_code": "sample string 5",
"company": {
"id": "efacc85a-f115-4930-aea3-52b115b30ea3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2022-12-06T05:25:00.7451985+01:00",
"sales_territory_id": "a6c132a9-3728-4fca-bc11-318b6faae487",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e7e76eab-4ed1-49fe-8922-62f75c11f7ec",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4f1be0c6-7705-4a2b-aeaa-0121d373d822",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c1d9c034-5e3a-4418-91b4-045cfab1f29e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06bb2e83-52cc-4f72-bf45-b9af76c814c7",
"db_currency_id": "b662ac35-c408-48e3-8710-37e2f2c1e0ac",
"db_language_id": "0661e032-bb77-4b5d-a2a5-158bdba0ee87",
"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": "2022-12-06T05:25:00.7451985+01:00"
},
"modified_dateutc": "2022-12-06T05:25:00.7451985+01:00"
},
"marketing_segment_id": "f5b7e423-6eb0-4a66-b7fe-03728118306c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "24161b75-f428-4e62-a12e-0d39b2434c60",
"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": "23e17199-6a17-4cd6-843e-d495d43b1cdf",
"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": "28ff8c1b-ccf2-4111-95e7-2dfe067c8b19",
"db_country_code": "sample string 28",
"feelist_id": "f4c28a8e-5cff-4c27-a068-187eb15965b9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "54fdf848-45d4-486c-afb9-c835f8f37a55",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6f09ad3b-64d8-4288-ac86-b97ee8e0f29f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2022-12-06T05:25:00.7451985+01:00"
},
"company_type_id": "3dc3f4bf-a2ae-4cf0-b264-75881608fcc7",
"company_type_name": "sample string 32",
"company_type": {
"id": "99ff2804-dc85-4362-bc21-8a0387933656",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c728e54d-8dfc-40d2-97ab-cfbd17c8a00a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "af361749-ecfe-47ca-be8c-8bc9af3c55e9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "30387874-13a3-49c5-a487-f31499e7138b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ae63fa76-cd6d-4e93-a2ed-9c2704fe465b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "af2ff142-9240-495e-b9b3-ddc0b7e8a415",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2022-12-06T05:25:00.7451985+01:00"
},
"company_sector_id": "aaae70f2-b4ef-4b53-8fb3-233022e8fd5a",
"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": "66638f8b-11a4-4117-92cd-931450959942",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6142e567-956c-4f7d-b4a6-a1a8dfe411ce",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "01c0aad4-ee9b-4403-8e48-1d2ff8a05ec6",
"account_manager_user_code": "sample string 56",
"company_status_id": "6c18ecf2-a7fc-49e5-b8af-26db901c920c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2022-12-06T05:25:00.7451985+01:00",
"id2": 60
},
"db_language_id": "26a223f6-2373-495b-984f-f6efa80a934b",
"db_language_code": "sample string 7",
"db_title_id": "044788fa-ae91-49ae-bc7c-ed35c61badc8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2022-12-06T05:25:00.7451985+01:00",
"create_date": "2022-12-06T05:25:00.7451985+01: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": "2022-12-06T05:25:00.7451985+01:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.