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": "c14b5fc9-be17-4968-8906-e0d03f55750f", "id2": 2, "company_id": "bb49c2f9-24dd-4168-9d48-c174675e5234", "company_code": "sample string 4", "reference": "sample string 5", "reference_back_office": "sample string 6", "reference_customer": "sample string 7", "date_start": "2025-09-05T12:23:10.7482258+00:00", "date_end": "2025-09-05T12:23:10.7482258+00:00", "date_cancel": "2025-09-05T12:23:10.7482258+00:00", "date_last_invoiced": "2025-09-05T12:23:10.7482258+00:00", "name": "sample string 12", "description": "sample string 13", "feelist_id": "d279c13e-832c-462f-9521-70f85eb04b3a", "article_price_label_id": "05f6074a-7469-431b-a3d1-974cf55a8172", "account_manager_user_id": "e8956daf-f9b1-4db4-a00b-30d4166fc585", "account_manager_user": { "id": "a0750bcf-4de3-4a2e-894c-ce1bcb68f232", "db_language_id": "18ffba71-980b-4d40-8f80-44f9348e876f", "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-09-05T12:23:10.7482258+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "a76d86c4-5681-4900-9478-2765a5fa2bf7", "sales_organization": { "id": "9b7909db-3f7c-4da7-90e1-b2173ed4d47d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b4c2d40d-4604-4f4c-8b13-a8c99440650f", "db_currency_id": "64c91bfa-5014-4461-94c1-c701e4bb0b47", "db_language_id": "99bc689f-0cab-415e-962f-221af6618624", "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-09-05T12:23:10.7482258+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "00a7a7f1-9a90-4c7c-ae99-b33c8ed76c3b", "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": "1dc59c86-3e7c-41c9-9945-132a0428edad", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-09-05T12:23:10.763847+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "c5f6a658-9d7c-41c0-8dc4-cc5394fa3d8f" }, "account_manager_user_code": "sample string 17", "modified_dateutc": "2025-09-05T12:23:10.763847+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 }