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": "5be15c52-0279-42f3-a8ed-0e83a9a56695",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "73e9b8ec-33a0-45be-931f-202657fa820e",
"company_code": "sample string 5",
"company": {
"id": "9a2963e1-1614-440b-ac86-55ec0d60555c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-05T06:57:17.5045185+00:00",
"sales_territory_id": "fec50e93-bd51-4411-9b70-56325b236a7d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2995c736-081a-4e6e-ba18-08f2faccdc06",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0e195417-08f7-4d20-910e-d366191c10b9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "57b68994-df28-4b19-b240-98638204afa5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c27bf618-6694-41cc-b5bd-4e824a4f5c72",
"db_currency_id": "bc44ebf6-0676-4db9-8244-e6ae3d16d62a",
"db_language_id": "0efe242f-b475-41bc-bb36-73d922ba7bda",
"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-02-05T06:57:17.5045185+00:00"
},
"modified_dateutc": "2025-02-05T06:57:17.5045185+00:00"
},
"marketing_segment_id": "6ad6a086-dfc5-4043-8326-45044f04a7b7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0858361d-3990-441c-a3f1-6e5a8460b636",
"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": "799fe551-ee72-42ee-a109-46fc92f41315",
"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": "5039ce6c-2f76-4772-99a7-3ff9eb4bb802",
"db_country_code": "sample string 28",
"feelist_id": "777b50d2-5e8e-481e-80fe-33c73f54a9c3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6ef99588-ef6c-4a93-84a3-029719eebd8c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "191fe7a5-ff60-423f-afc0-833bb51fa526",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-05T06:57:17.5045185+00:00",
"db_currency_id": "c15d5715-da3e-4ebf-87ed-f2093ea3ac46",
"db_currency_code": "sample string 10"
},
"company_type_id": "a9efe924-20ea-4457-a14e-f658378b0c34",
"company_type_name": "sample string 32",
"company_type": {
"id": "062ad377-9dfe-4e23-805b-d1a1d7af4a7f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c8883c37-f95b-4b05-80e5-3600fb7ab9c2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "624dc282-fda6-4f09-b6b8-b18eb5e79332",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7259950b-bc27-448c-ab38-3ef74e2a7f03",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0ffef0b5-55b8-4a01-9de8-52eeadf736cb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0db88fc0-15ae-4736-8e85-9f316766e1e5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-05T06:57:17.5045185+00:00"
},
"company_sector_id": "ef65ae98-050d-47cf-bc92-8c7e714c91ed",
"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": "804d8aa4-4657-4e18-bb65-da056b9f4521",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1b8acad2-95c4-48d4-bab9-09624085988b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "28a5d0ed-d4a4-4769-98ba-1eeb749c9538",
"account_manager_user_code": "sample string 56",
"company_status_id": "2eb59599-13ba-4708-90af-f35a3c990a81",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-05T06:57:17.5045185+00:00",
"id2": 60
},
"db_language_id": "185a9dc8-7b4e-4729-b41a-b936d395ad90",
"db_language_code": "sample string 7",
"db_title_id": "d4150c68-a91d-4a26-a4b5-cda4197b219c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-05T06:57:17.5045185+00:00",
"create_date": "2025-02-05T06:57:17.5045185+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-02-05T06:57:17.5045185+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.