Retrieves the Contract with the specified key
Request Information
URI Parameters :
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
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 |
Response Formats
application/json, text/json
{ "id": "058b4007-7a79-4dc8-a94e-75157d5207e1", "id2": 2, "company_id": "28c99491-4311-4a01-8a26-c3af136c4188", "company_code": "sample string 4", "reference": "sample string 5", "reference_back_office": "sample string 6", "reference_customer": "sample string 7", "date_start": "2025-07-07T22:55:54.9054883+00:00", "date_end": "2025-07-07T22:55:54.9054883+00:00", "date_cancel": "2025-07-07T22:55:54.9054883+00:00", "date_last_invoiced": "2025-07-07T22:55:54.9054883+00:00", "name": "sample string 12", "description": "sample string 13", "feelist_id": "0f84f8e2-805f-44db-8772-e1733e652c40", "article_price_label_id": "0770c545-baa2-494b-aaea-d84d9e331c3b", "account_manager_user_id": "a60084ff-9653-4669-b2d1-a3dd579a9d7b", "account_manager_user": { "id": "64326ab3-3c52-41a5-bad1-a875b4460e54", "db_language_id": "88775e25-ee50-43cc-b27e-40c84fde8929", "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-07-07T22:55:54.9054883+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "81a2a4c3-17cd-4d43-b430-847cce4b1c6e", "sales_organization": { "id": "e357ace2-c422-4c5e-b994-02706b8b4fa3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a6970a7d-b7aa-4278-a1cf-b21461df7f12", "db_currency_id": "7b0ff007-6cd4-48e1-a1df-4feb0f2212b5", "db_language_id": "381c5c91-b3ba-40a4-ab54-7f3f508d6d7b", "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-07-07T22:55:54.9054883+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "0139115e-b8d9-4277-b940-653e41df58ae", "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": "0e3cef39-ab52-4175-bd4e-2ec56bcc54b6", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-07T22:55:54.9054883+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "66fdc481-9024-49b1-8337-2f812c1b2630" }, "account_manager_user_code": "sample string 17", "modified_dateutc": "2025-07-07T22:55:54.9054883+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 }