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
contract| Name | 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": "b0dd2c60-c61f-4b40-82d5-6199c49a60c3",
"id2": 2,
"company_id": "eb8ccc97-2dc1-4778-b53c-4ccd08ccc74f",
"company_code": "sample string 4",
"reference": "sample string 5",
"reference_back_office": "sample string 6",
"reference_customer": "sample string 7",
"date_start": "2026-03-06T03:00:20.2360678+00:00",
"date_end": "2026-03-06T03:00:20.2360678+00:00",
"date_cancel": "2026-03-06T03:00:20.2360678+00:00",
"date_last_invoiced": "2026-03-06T03:00:20.2360678+00:00",
"name": "sample string 12",
"description": "sample string 13",
"feelist_id": "14138929-340d-4366-b818-f8d8458906b7",
"article_price_label_id": "f1cdc3de-454a-4f32-84d0-e9fbbc949923",
"account_manager_user_id": "9925f9d5-9cb3-4d49-8a21-cc3fa5fbee87",
"account_manager_user": {
"id": "f996085f-2dab-4822-9604-50a96fd14f98",
"db_language_id": "377bf8c5-2fa8-4f52-aca9-ba6980cf8bac",
"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": "2026-03-06T03:00:20.2360678+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d1d33b4b-d200-4213-b1cd-06ec7eb84ed2",
"sales_organization": {
"id": "630ee81d-613d-45b8-8998-6049add44f29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7818c2b4-9b61-46c7-8ca9-05e39994e987",
"db_currency_id": "be3c773d-6b48-4f81-8aa4-de8813e1a8bc",
"db_language_id": "57251f26-c06f-40da-8e60-eae812863612",
"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": "2026-03-06T03:00:20.2360678+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "52860af8-8358-4336-9d4c-60bdca18b78a",
"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": "c70cb5e4-4475-4e35-b630-687604c3fe85",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-06T03:00:20.2360678+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "398000c0-95e0-4453-a108-53f4201427d3"
},
"account_manager_user_code": "sample string 17",
"modified_dateutc": "2026-03-06T03:00:20.2360678+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
}