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": "f6f7e58b-8bec-47e9-8cfb-2f6ce90e2b90",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e6186943-0c55-4809-863f-f6c25a6f69a1",
"company_code": "sample string 5",
"company": {
"id": "1073dc98-ad4d-4716-b8ae-7c97b0913230",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-04T01:40:24.3197857+00:00",
"sales_territory_id": "5b30577f-da4f-4010-a6d5-676524f7dc79",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "98d9e787-05ec-4a80-9f71-4bd511cc6fd1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d1bab8b6-a865-40a9-b6ec-7be1cdb0bec8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dbeb20cd-e1f3-41b4-b61b-416b7eb58088",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac03f0f0-edd2-4227-af3b-b184b9211561",
"db_currency_id": "c4534cbf-136c-44ca-8bd0-a8bff4f512a5",
"db_language_id": "e9541f4d-4b21-4d30-abbc-1cc6cc3da316",
"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-04T01:40:24.3197857+00:00"
},
"modified_dateutc": "2025-04-04T01:40:24.3197857+00:00"
},
"marketing_segment_id": "b64b3686-1433-4d08-9ecf-3c85412ff44f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f72b2702-c40b-4304-b538-39a4780c69e7",
"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": "9afa9a4d-fa9f-4657-b831-0d547b49b58e",
"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": "31624b58-f144-4032-a54f-fcd18e583f3f",
"db_country_code": "sample string 28",
"feelist_id": "0f3445ba-edde-4524-a6e2-d1cbe6897544",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "93b0c8d3-e8c6-4031-a2df-d41f98ef28f6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "db593ac1-07dd-480f-9280-f6dfef7f2fc9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-04T01:40:24.335128+00:00",
"db_currency_id": "6ff80084-c9a7-42c4-a98c-b238321ae678",
"db_currency_code": "sample string 10"
},
"company_type_id": "91e88341-2612-4c65-8e3b-08811770ec03",
"company_type_name": "sample string 32",
"company_type": {
"id": "a8c60386-a5f0-45c7-a8e5-48d32ecd3619",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "81334133-f092-4459-981c-5e6f1d0f8111",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1db87361-a180-4737-8a10-5f3fe39aaa12",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d34fc4ae-1611-4d51-b7d3-dc7890024c56",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "59445a7d-7b40-45aa-b386-68e79f80b317",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d8f20a0b-f99c-426f-b8c4-d9e4bf55eab5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-04T01:40:24.335128+00:00"
},
"company_sector_id": "3a040609-566a-416b-ac44-7d6d87f4377b",
"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": "9e99b405-a770-4cf2-928f-d701fb87dd38",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "65b809c8-0570-4de4-b7f3-e87912095698",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "27a7492c-9440-47c0-b402-92cb86d47d2e",
"account_manager_user_code": "sample string 56",
"company_status_id": "d5fa1d68-1c79-4498-a7e0-12bd09e538f3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-04T01:40:24.335128+00:00",
"id2": 60
},
"db_language_id": "7a9f9b9d-2148-48b4-bc9e-8c94a3e7adfa",
"db_language_code": "sample string 7",
"db_title_id": "74777fd8-eaed-436c-8d05-b265a4f535fd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-04T01:40:24.335128+00:00",
"create_date": "2025-04-04T01:40:24.335128+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-04T01:40:24.335128+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.