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": "18d94853-e27d-4541-a6dd-9c3ff81f2d3c", "id2": 2, "company_id": "b0c29fb1-91ce-4563-b916-4842807f3857", "company_code": "sample string 4", "reference": "sample string 5", "reference_back_office": "sample string 6", "reference_customer": "sample string 7", "date_start": "2025-03-31T21:18:04.2446342+00:00", "date_end": "2025-03-31T21:18:04.2446342+00:00", "date_cancel": "2025-03-31T21:18:04.2446342+00:00", "date_last_invoiced": "2025-03-31T21:18:04.2446342+00:00", "name": "sample string 12", "description": "sample string 13", "feelist_id": "93dfedfd-f243-4aa8-927c-8a93bd933671", "article_price_label_id": "41a569ec-a2f7-4889-89dd-b46ce18216a1", "account_manager_user_id": "2923511c-3830-4fc6-86db-95c9f1433e27", "account_manager_user": { "id": "eb730857-2fd7-4dd8-ba9e-a2a6e0b5e319", "db_language_id": "c111b423-57a6-4098-a9e7-cee2820eda65", "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-03-31T21:18:04.2446342+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "0cddf2b8-d605-4ea3-9b66-b68319078966", "sales_organization": { "id": "c941fc5b-7f00-4640-b670-13380abe23eb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a8340f0a-a2c7-4297-ad73-027fe5429628", "db_currency_id": "b73b0bac-b53c-41f3-89fd-9aa1dd15b0d0", "db_language_id": "0a163955-1ec0-4c76-bfa8-b03021da61b8", "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-03-31T21:18:04.2446342+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "959551fa-8292-445a-9693-3203ec5d99f2", "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": "60e4fa11-07f8-4462-a782-c85fd0083867", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-03-31T21:18:04.2446342+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "f7c2d88c-e94b-4547-a50f-44ff0cc2a635" }, "account_manager_user_code": "sample string 17", "modified_dateutc": "2025-03-31T21:18:04.2446342+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.