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": "30894ef4-5118-455c-bbf1-641172851def",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1ce3b748-8879-4262-9dbb-ced8c8111334",
"company_code": "sample string 5",
"company": {
"id": "366697e4-6e3a-452c-8f7f-bf2718e095d6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-28T13:12:21.1862525+00:00",
"sales_territory_id": "6e8a0976-2789-4220-8d6d-ef0f1647ce09",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9e70751f-c696-475a-90df-7ae9184b61f2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b65548d9-d392-44a2-ac52-7bc920ff37ab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7f769f4b-d976-4085-980a-2d3f89487b57",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f722d521-4b74-437e-b179-c3569c21fbcf",
"db_currency_id": "84551b90-dbe2-408c-bc09-8fbd62e3a1b0",
"db_language_id": "5acb93aa-8c8d-4371-8a66-299f97f92523",
"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-03-28T13:12:21.1862525+00:00"
},
"modified_dateutc": "2025-03-28T13:12:21.1862525+00:00"
},
"marketing_segment_id": "9824e754-0228-4c2c-aea4-57a737568ac6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "57e6832f-0fa7-44bc-8252-4aa813737ec2",
"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": "28e05529-852b-4a1c-80b6-014c113fbfc8",
"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": "53a7f7a6-52b2-47ab-a1b0-2636548f5d54",
"db_country_code": "sample string 28",
"feelist_id": "cc1be814-1fd4-4491-be8e-91604019cd92",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "34d980e2-e947-45c5-86a2-329a129c9dd1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "acf50e72-0ec5-4723-9fa2-c82980ad6f59",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-28T13:12:21.1862525+00:00",
"db_currency_id": "82d6ec8a-4243-459f-8cb3-7c136d4c0d0c",
"db_currency_code": "sample string 10"
},
"company_type_id": "8ccdc01f-82e3-4697-b48b-7ec3545220fa",
"company_type_name": "sample string 32",
"company_type": {
"id": "365e5ca9-7dfe-431f-a606-55b9cbd2a0c2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4ce15a5a-095a-4aa0-9fa2-63b294070997",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1f452f00-3c8d-4de3-adc3-39fe246d6309",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f55ebb9e-225e-4896-83de-bc7e7089bcad",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "097667f4-9b5c-458f-86b3-dbb6ef8e5e0c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "254ec0e4-a73f-41ba-a1c9-7d91b1707b93",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-28T13:12:21.1862525+00:00"
},
"company_sector_id": "a5e9aa0b-5a7d-4547-ba84-1a3aaedbd2ac",
"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": "a56f142c-8e06-4806-b19e-e1d1b8cc43f6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f077695c-9f58-473b-9762-d4c03fb16252",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9ab7055a-7294-44c6-98ed-b58053bb91bc",
"account_manager_user_code": "sample string 56",
"company_status_id": "d25a7bae-77f7-4c00-8c62-403f82557fb0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-28T13:12:21.1862525+00:00",
"id2": 60
},
"db_language_id": "a218e3d3-8060-4d10-bad1-3f4c6c7226ab",
"db_language_code": "sample string 7",
"db_title_id": "3fb105a3-ba23-474f-9c14-e38ea1f39226",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-28T13:12:21.1862525+00:00",
"create_date": "2025-03-28T13:12:21.1862525+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-03-28T13:12:21.1862525+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.