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": "5324dc71-ce87-4cc5-8555-ae5e81051546",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d01b479e-a090-4db8-82d2-db0556151172",
"company_code": "sample string 5",
"company": {
"id": "23765d34-8796-4c4e-935a-5c10c8820c1e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-01-19T16:41:14.9126116+00:00",
"sales_territory_id": "ddf675f8-c0ee-44ed-aeb7-eb5fda7c04be",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "44c9216a-fce3-411d-8736-ec477f0e121b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b1ed1680-ee9c-4a3c-a90a-bdde4e2d7982",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0a97471a-e7a2-4b7c-a01e-a09a95d4dfe3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "919368e6-872a-4a6e-bc93-b3ca1ca4cd1f",
"db_currency_id": "d92d9248-b8a3-409f-8cf1-9f6e9f011bc7",
"db_language_id": "71807df6-5a99-46b7-98dd-71aeb194bb71",
"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-01-19T16:41:14.9126116+00:00"
},
"modified_dateutc": "2025-01-19T16:41:14.9126116+00:00"
},
"marketing_segment_id": "6634d9db-b483-4c50-bf93-d885854ce973",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b3fb7cec-0d79-4c72-bf0a-80672c8aebe0",
"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": "246eefc6-f46a-42c6-a838-a68bd73bfe5b",
"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": "2cd8ca4c-64a9-4c7c-9e09-0d1e9f7d53b5",
"db_country_code": "sample string 28",
"feelist_id": "baf397c8-ebe0-4740-b825-fcc26aeddbad",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0edf8439-0f0d-4486-9c2d-a36ad7ca5e1a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "acf019ba-ba0b-4fd0-9d20-153b74f5c39a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-01-19T16:41:14.9126116+00:00",
"db_currency_id": "76824110-8367-4a1b-9c9e-baaf2f6c78c6",
"db_currency_code": "sample string 10"
},
"company_type_id": "6cc9d2f5-b80c-4da0-8fee-287c0e923ac9",
"company_type_name": "sample string 32",
"company_type": {
"id": "f63c8153-e826-42e2-85fe-b7ff968361e8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0260d3a9-a341-40bb-98e1-cce96c10e68c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e458c8ff-1459-41fe-8d4d-c4fe52fe5c73",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d94df8dc-7d34-4b23-a6e0-1543f4cc60de",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ca20e235-d3ed-404e-9c79-f937de27a6b0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bc37fde8-52dc-47ab-bd6d-778f940c1d0c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-01-19T16:41:14.9126116+00:00"
},
"company_sector_id": "8bbdb9fc-7f2a-45e0-a606-ab1bc5ea7f8b",
"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": "175f3204-12a3-4b3d-b39b-232547f413cc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "076abd73-df2b-4ecf-bd4b-76c8408e0edd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4026b009-bdc5-4624-8f78-3e0bc6a97b51",
"account_manager_user_code": "sample string 56",
"company_status_id": "52d41f6c-a9f7-4b59-8e8f-f0cf5b8a9c12",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-01-19T16:41:14.9126116+00:00",
"id2": 60
},
"db_language_id": "3b982b56-7636-4215-a704-944527e28e6b",
"db_language_code": "sample string 7",
"db_title_id": "46231c5b-a968-4240-ab56-f8b1e9e8231e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-01-19T16:41:14.9126116+00:00",
"create_date": "2025-01-19T16:41:14.9126116+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-01-19T16:41:14.9126116+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.