Creates a new Contract object
Request Information
URI Parameters :
None.
Body Parameters :
contractName | Description | Type | Additional information |
---|---|---|---|
id |
Primary key |
globally unique identifier |
Required |
id2 |
id2 |
integer |
Required |
company_id |
The company owner of this contract |
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 contract |
string |
Optionally required : company_id, company_code or company must be provided |
company |
Embedded entity "company" when adding/updating contract |
company |
Optionally required : company_id, company_code or company must be provided |
reference |
Reference |
string | |
reference_back_office |
Backoffice reference |
string | |
reference_customer |
Customer Reference |
string | |
date_start |
Start Date of the contract |
date | |
date_end |
Contract End date |
date | |
date_cancel |
Readonly , date +time when the contract goes in status Cancelled |
date | |
date_last_invoiced |
Readonly contains the last date an invoice has been generated for this contract |
date | |
name |
Name of the contract |
string | |
description |
Description of Contract |
string | |
feelist_id |
Feelist ID |
globally unique identifier | |
article_price_label_id |
Article Price Llabel Id |
globally unique identifier | |
account_manager_user_id |
FK of Account manager user |
globally unique identifier | |
account_manager_user |
Embedded entity "account_manager_user" using ERP PK when adding/updating account_manager_user |
user | |
account_manager_user_code |
Embedded entity "account_manager_user" using ERP PK when adding/updating account_manager_user |
string | |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
renewal_term_months |
Renewal Term Months |
integer |
Range: inclusive between 0 and 1000000 |
feelist_warranty_discount |
Feelist Warranty Discount |
decimal number |
Range: inclusive between 0 and 100 |
price_label_warranty_discount |
Price Label Warranty Discount |
decimal number |
Range: inclusive between 0 and 100 |
driving_distance |
Distance in km that are used to invoice the travel |
decimal number | |
travel_fee_fix_discount |
Discount applied when computing the fee for travel |
decimal number |
Request Formats :
application/json, text/json
{ "id": "ba916daf-1cf9-4179-951f-b1d98b80d1f1", "id2": 2, "company_id": "be92b385-0402-4fac-83ff-a1f1f493dc93", "company_code": "sample string 4", "reference": "sample string 5", "reference_back_office": "sample string 6", "reference_customer": "sample string 7", "date_start": "2025-06-07T22:43:16.6843987+00:00", "date_end": "2025-06-07T22:43:16.6843987+00:00", "date_cancel": "2025-06-07T22:43:16.6843987+00:00", "date_last_invoiced": "2025-06-07T22:43:16.6843987+00:00", "name": "sample string 12", "description": "sample string 13", "feelist_id": "e4c7a2ea-40fb-4f08-a6a7-2d72973d9aee", "article_price_label_id": "1507e2ee-b579-4522-9905-60e031ea3032", "account_manager_user_id": "f9d95d3d-ceee-4dd4-8ef6-c0d255764568", "account_manager_user": { "id": "b2249831-294c-433f-ac96-72b42948861b", "db_language_id": "5bab76fd-6be8-4144-a29f-6e73adebdb7d", "username": "sample string 3", "firstname": "sample string 4", "lastname": "sample string 5", "code": "sample string 6", "archived": true, "disabled": true, "emergency_contact": "sample string 9", "bankaccount": "sample string 10", "social_security": "sample string 11", "place_of_birth": "sample string 12", "nationality": "sample string 13", "functions": "sample string 14", "birthdate": "2025-06-07T22:43:16.6843987+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "a3611429-cd9c-45d9-8546-ec61899d2427", "sales_organization": { "id": "6e28d776-e824-4f4e-bd5e-a91211cf87a0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ccc6adcc-c5f0-4bc5-845e-65d35f0a0741", "db_currency_id": "26d7c4f0-7e0d-487e-a4c0-12b2944b1acf", "db_language_id": "77c05429-138b-4276-ad28-aac8751ed159", "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-06-07T22:43:16.6843987+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "b0df836c-86e6-4485-b5d8-400f0b3c2c9b", "email": "sample string 22", "phone": "sample string 23", "fax": "sample string 24", "mobile": "sample string 25", "private_email": "sample string 26", "private_phone": "sample string 27", "private_fax": "sample string 28", "private_mobile": "sample string 29", "private_street": "sample string 30", "private_street_number": "sample string 31", "private_city": "sample string 32", "private_zip": "sample string 33", "private_db_country_id": "4a26fe1c-17fa-4f07-800c-457c6b4d01e1", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-06-07T22:43:16.6843987+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "86a5c14f-9f4a-48af-af55-ef1df279666f" }, "account_manager_user_code": "sample string 17", "modified_dateutc": "2025-06-07T22:43:16.6843987+00:00", "renewal_term_months": 19, "feelist_warranty_discount": 20.0, "price_label_warranty_discount": 21.0, "driving_distance": 22.0, "travel_fee_fix_discount": 23.0 }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.