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": "56466e43-19cb-4d2d-b998-aef082d46efc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "faeb055e-35c2-4434-9f90-289c5099ae97",
"company_code": "sample string 5",
"company": {
"id": "39b10cdd-d9e6-4e49-ba00-f69f7100dea0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-25T04:58:22.6295871+00:00",
"sales_territory_id": "9be16eb3-73a0-4bb4-af4d-bf9f34202014",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2859eba3-1b20-419a-800e-cc17d1d2b49e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b764a30-452c-4284-84af-42f8b5d78172",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4d2eeea7-ee98-4ad9-9ebc-c0f721198f9d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fcd39b39-1dab-41da-beff-81078b97fc28",
"db_currency_id": "0fa82089-8759-4256-a49a-bff12e38a8aa",
"db_language_id": "b15327de-52b8-42b9-a094-3787c440f082",
"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-04-25T04:58:22.6295871+00:00"
},
"modified_dateutc": "2025-04-25T04:58:22.6295871+00:00"
},
"marketing_segment_id": "4b03cc62-d0a6-41d0-8008-14cbd54f8a70",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6a704043-aa21-41f5-a316-096a6e657160",
"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": "9cefffbe-abd1-4b48-ab5f-61866eb91df9",
"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": "ce22babd-cebc-4ccd-a6b7-9b08c9aa78db",
"db_country_code": "sample string 28",
"feelist_id": "2a667333-cba3-4e9a-954e-72068f098ac6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5da29847-7ca3-4051-a170-0922ff8da3f9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "426eb2f9-82a9-4eef-b25e-4279c4e70f9f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-25T04:58:22.6295871+00:00",
"db_currency_id": "a4a2e508-9d60-4115-bb5f-1d4fdd7c893d",
"db_currency_code": "sample string 10"
},
"company_type_id": "26cee333-bc60-40c2-b4d4-4737979eecaf",
"company_type_name": "sample string 32",
"company_type": {
"id": "707b8255-3867-4ebf-a0c9-23692466b190",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "443a2c6e-3ece-4a23-aaf3-f1f7cdbae03b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "05e06e7c-cdcd-4e61-9b1d-6335a8fd366a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f6c55ccd-8d2e-419e-8ac6-aa2c83254caf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d0fd667c-91f5-4240-8484-894e3f5984c8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "01bd1ba0-d5c9-4820-9c36-10ef761d60a8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-25T04:58:22.6295871+00:00"
},
"company_sector_id": "d79b3f37-b834-4283-b421-ce08d2e0a911",
"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": "578b83cc-d709-4f81-a4e9-4df7e9508a5d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c3653303-b01d-4796-8062-b07e847f3a8c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9567a267-1415-4e49-93de-247381a81d26",
"account_manager_user_code": "sample string 56",
"company_status_id": "9d2383e5-8682-4fd8-8824-650240946afe",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-25T04:58:22.6295871+00:00",
"id2": 60
},
"db_language_id": "4090edc5-ddc3-4793-aed2-c2ea11733e1c",
"db_language_code": "sample string 7",
"db_title_id": "6026c6a7-261e-4e48-a132-28880b08dd7d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-25T04:58:22.6295871+00:00",
"create_date": "2025-04-25T04:58:22.6295871+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-04-25T04:58:22.6295871+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.