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": "68c2046c-05ec-4a6a-9c95-c7b64300b4cc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bc3bf705-9083-4e5a-9397-4c02c9e923b9",
"company_code": "sample string 5",
"company": {
"id": "28a49f8c-6410-40f6-8676-21124605ef0f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-09-30T15:09:02.7760743+00:00",
"sales_territory_id": "2c4c471c-49ad-4163-8ef0-ca5a1a12c82e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "58e0873f-e365-4679-b538-6271433bf176",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "29e1038c-09b9-4a42-b41f-fab1a016db10",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a9ba2ecd-b869-4947-9ab9-05a16cf662ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a15b0aa-afd2-4754-82d7-5f35be04927a",
"db_currency_id": "2d40235e-b616-4ded-89a9-ede2229dae60",
"db_language_id": "926bde86-1cc2-4645-b386-7a3fd7f46215",
"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": "2023-09-30T15:09:02.7760743+00:00"
},
"modified_dateutc": "2023-09-30T15:09:02.7760743+00:00"
},
"marketing_segment_id": "47449f8a-2d3d-44df-98ae-529aab4475f0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "30b7f30b-e01f-4f0d-add3-5df9eda64344",
"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": "fbd83424-93ce-45b7-81dc-a61b06bbee51",
"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": "b0351a7d-c714-405e-8512-4685e0bd3928",
"db_country_code": "sample string 28",
"feelist_id": "9fdfd300-5933-4422-8210-d7dc95722f3b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "599cb17d-780d-4a8a-9941-c6ef0838502d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "075d85bd-ad14-47c3-aefe-306c0bf19d40",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-09-30T15:09:02.7760743+00:00",
"db_currency_id": "90af1f39-fb52-4cd2-9797-ba8e9ef22c19",
"db_currency_code": "sample string 10"
},
"company_type_id": "84c6b4e7-6369-4719-9aa0-0851f73a41c6",
"company_type_name": "sample string 32",
"company_type": {
"id": "120a5055-7633-470a-bf29-8b0031d812ef",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8b2a3469-f323-45a7-b901-97872f0f8c06",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ff1fce1c-ea01-4570-ad95-8b7dd06f4810",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3af8f0d6-88f2-4035-9db1-cd863a1e1e4e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7608b366-6e90-40ea-a823-54e742538d76",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a10e78dd-dd2c-4439-a762-63f2a392532f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-09-30T15:09:02.7760743+00:00"
},
"company_sector_id": "ed3c9209-af2a-42e1-9561-d6210090a74a",
"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": "8af91e8e-7ceb-4b85-a127-88d37b11b693",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "223962fe-fc72-4fb4-9315-0b026043c59f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "db43fbd9-574a-4fa6-a058-da2c605224d6",
"account_manager_user_code": "sample string 56",
"company_status_id": "83e55acd-f9cb-40b1-8756-52d85446ec17",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-09-30T15:09:02.7760743+00:00",
"id2": 60
},
"db_language_id": "cda8b275-f2c8-4c69-be1f-45640235e7e8",
"db_language_code": "sample string 7",
"db_title_id": "e503bab5-1e15-4c2c-b2c0-8f36f3512104",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-09-30T15:09:02.7760743+00:00",
"create_date": "2023-09-30T15:09:02.7760743+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": "2023-09-30T15:09:02.7760743+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.