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": "6466b3ec-77c9-41d7-b7a9-542407887ffa",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c57d2f85-2f7e-4e2c-8472-d2d2fcab112f",
"company_code": "sample string 5",
"company": {
"id": "58e8f526-e3d2-4217-9615-7495c486f960",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-27T15:54:27.7022187+00:00",
"sales_territory_id": "d497f906-dffe-442c-804b-8c3450a95943",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b4f5571b-30ef-49ad-9fa9-34754b5e8800",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ce456d4c-18fe-4095-a423-59b1d1c1380e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e9ca0c1b-edff-4faa-9e3d-d9f426f626cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f9521cd-4c6c-4e18-985c-2e55b32103bd",
"db_currency_id": "df86ab7a-095e-4f77-8cf9-950a2bfb4ff5",
"db_language_id": "1348fe11-b829-4caf-8faf-e7b408c16a0b",
"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-27T15:54:27.7022187+00:00"
},
"modified_dateutc": "2024-12-27T15:54:27.7022187+00:00"
},
"marketing_segment_id": "100ccd36-dd02-4a76-bc9c-64b26e2f3a7b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f310bf82-c211-4c92-b0ef-0bf95e9b49ec",
"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": "89667d3b-0e54-4f91-bc60-72698feed191",
"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": "4528abec-4dbe-4a7c-abf3-fe836805db2c",
"db_country_code": "sample string 28",
"feelist_id": "cf9cbfc6-2338-4c3d-b5b2-6c99439caf30",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "54e8b28b-dc0f-496b-b8c6-b43877f1cba8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "44390ea6-172b-4283-a057-7e06514d017b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-27T15:54:27.7022187+00:00",
"db_currency_id": "f5f2ce01-62fb-4917-a5e3-d05dd711b664",
"db_currency_code": "sample string 10"
},
"company_type_id": "85d0beab-ee7c-451e-acd6-056770ca417b",
"company_type_name": "sample string 32",
"company_type": {
"id": "4949ea3c-cf07-4cb2-8a5c-bb32e5a8c432",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6204010d-3198-45c6-9537-da0aeb6ea2c7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "51e011c3-37c4-40be-841d-e5f3cc835bb2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a1430b8c-a021-49c8-ab4b-be1ea37d4d4e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4be9f9b5-b49f-4cba-9c34-673a7e65663e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "592eca1e-7948-465f-b477-f176a3c43fcb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-27T15:54:27.7022187+00:00"
},
"company_sector_id": "0a311a81-bf77-4540-80c9-286969831bbb",
"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": "1ff9d209-e95a-47c0-a0d4-2060734e3b8a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8dadbd9c-f303-4a65-a2ab-95d7fc1b3b4f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "758905ea-3fd0-48f0-91b9-7d13c617d17a",
"account_manager_user_code": "sample string 56",
"company_status_id": "b1620b7c-63da-4151-86da-4b0fb43b1713",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-27T15:54:27.7022187+00:00",
"id2": 60
},
"db_language_id": "05562761-75f8-4884-985e-c974388b787c",
"db_language_code": "sample string 7",
"db_title_id": "34996b9f-c3c4-40c2-b706-23e4e5989fad",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-27T15:54:27.7022187+00:00",
"create_date": "2024-12-27T15:54:27.7022187+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-27T15:54:27.7022187+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.