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": "b5321b2f-2873-4ee6-9735-4fb13b96c130",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8c14c604-977e-4e6e-b53d-47ee475b1ca3",
"company_code": "sample string 5",
"company": {
"id": "3510399e-d650-4013-b106-003c05062c05",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-03-31T22:35:38.6403492+00:00",
"sales_territory_id": "b8f4360c-0137-4448-915a-518076e17992",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ed0a7dbc-f711-4890-a50a-0a0f6d6985b1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "50421c3d-fb6e-44c7-a312-e2942336a837",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dac6d971-4c99-4c17-81c2-14c23ecd2b16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6df19fd3-9f99-4854-86d1-72fac52d2866",
"db_currency_id": "1efb0a5f-8529-448c-86af-d99f302235b6",
"db_language_id": "6fd6983b-b0b9-4853-95d9-d39af8a9a6c7",
"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-31T22:35:38.6403492+00:00"
},
"modified_dateutc": "2023-03-31T22:35:38.6403492+00:00"
},
"marketing_segment_id": "bb023478-b23b-4c9d-81c1-25d2060d02b6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f3f6549b-2a20-48ba-9e63-56fa1c9a27b4",
"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": "fbdf4b3a-e5c0-4626-af50-31fc6cb2187f",
"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": "7698db1e-46f5-4c80-8b70-827c6f054b3d",
"db_country_code": "sample string 28",
"feelist_id": "d38d806e-b4ea-4e7e-9f82-2d7a1541d219",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bd902d1b-b164-413e-bb83-f0911d11950a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "338ba01b-e8bc-4804-aedc-376ba917ebd1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-03-31T22:35:38.6403492+00:00"
},
"company_type_id": "ebb6ffbd-64c2-4caa-85dc-b1b0576aa83e",
"company_type_name": "sample string 32",
"company_type": {
"id": "9ca28bab-7c85-4429-9903-4a83d7e6c95f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eb6269eb-74d2-4ccd-b1f1-363ff583d405",
"sales_organization_code": "sample string 5"
},
"db_language_id": "17834410-8ac1-42d5-9138-5719753d5677",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e7b2be0f-c8b7-4e39-987b-475258e63e55",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0bd04242-97a5-4915-a8e3-1f4d00991ab0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c07a83da-32b6-45e7-bd64-08e1e54421f6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-03-31T22:35:38.6403492+00:00"
},
"company_sector_id": "0801da38-c8b3-40ae-ba81-b1ae9266cfcf",
"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": "5a701999-45b4-4168-a196-b1bf76ce68c2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e6b992a0-36d4-44fc-b093-1a8567d5ccf5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c5cef218-896a-468c-ac41-9701671065dd",
"account_manager_user_code": "sample string 56",
"company_status_id": "e091dd75-88ac-4cac-8053-4226b3766fdb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-03-31T22:35:38.6403492+00:00",
"id2": 60
},
"db_language_id": "836418eb-5c7b-452d-ba69-9baa879e2f90",
"db_language_code": "sample string 7",
"db_title_id": "ae9b29b2-c937-4d10-ae55-581698a422c5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-03-31T22:35:38.6403492+00:00",
"create_date": "2023-03-31T22:35:38.6403492+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-31T22:35:38.6403492+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.