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": "83547db8-2f54-4161-9592-2600497450b0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bd635cfa-d0c3-44ee-b139-4c406882112f",
"company_code": "sample string 5",
"company": {
"id": "f400011b-5a46-48f1-a5b3-09361a122db8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-03-18T22:42:42.5259692+00:00",
"sales_territory_id": "362ae903-46a8-481d-a870-5b2fcfa382ca",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9669db0c-d528-446b-afe4-bc51a22fdf4e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8bec6463-4674-4eff-904d-2dcdc5c5bdfc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dff890e1-3961-4969-a864-8c25a1040fd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea5d02bb-ca67-4168-844c-60d7466397f1",
"db_currency_id": "97e93619-b833-45bc-9d4e-e585cfa0167c",
"db_language_id": "7d681925-7ea7-428a-ae16-603e8cd246ca",
"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-03-18T22:42:42.5259692+00:00"
},
"modified_dateutc": "2023-03-18T22:42:42.5259692+00:00"
},
"marketing_segment_id": "64b46189-13ed-4ef7-ac66-37c08562d78f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "190f2f21-d2a3-4c41-8edd-3dc2a6ba757d",
"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": "ff82793e-6ac3-4679-90a6-8e47b8771fdd",
"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": "376faa95-d074-47df-beb4-0270b3ddc542",
"db_country_code": "sample string 28",
"feelist_id": "d26bde4b-3d1c-418f-a735-227f9da3eb9d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "906711e2-073c-4fbf-9bae-5b51053d4671",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0c15abba-e7ea-45ac-ab3f-0cd68bca6f5f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-03-18T22:42:42.5259692+00:00"
},
"company_type_id": "206233d3-1c88-449f-b858-26a01517fa6e",
"company_type_name": "sample string 32",
"company_type": {
"id": "7da06462-9a0f-474c-951b-6ff2c7a0b388",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "60359797-7f34-4715-8e53-5eb53d8b9c05",
"sales_organization_code": "sample string 5"
},
"db_language_id": "af506676-febb-43d2-8f96-9c416d0255e2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9c16a6bc-6a5a-49bb-9572-4060cd9c2b82",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e5013595-7e76-4f58-ab9c-fad8699bf574",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "706181d9-ae8e-4c5b-abc3-7d6561c49bef",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-03-18T22:42:42.5259692+00:00"
},
"company_sector_id": "a0dfe387-4e74-4f0d-a31a-5692780a8110",
"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": "f953d892-6334-4e15-8db3-18cbec4f83a7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7d8d7877-a1e5-469c-bb14-62a3fdf605cb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1db6c80b-45f8-45ec-ad13-1c8cd14cd29a",
"account_manager_user_code": "sample string 56",
"company_status_id": "89ac1068-ad3c-4edb-906b-d1398cf181f6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-03-18T22:42:42.5259692+00:00",
"id2": 60
},
"db_language_id": "6d169e46-c995-4893-a522-8ddef3eac72c",
"db_language_code": "sample string 7",
"db_title_id": "345773d3-52e2-4df3-bd63-a681ec07af0d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-03-18T22:42:42.5259692+00:00",
"create_date": "2023-03-18T22:42:42.5259692+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-03-18T22:42:42.5259692+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.