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": "59d0eee9-fc97-4b94-b4ba-ce91e87244e5",
"id2": 2,
"company_id": "604d879d-2dd8-434c-81ff-88c9f5347487",
"company_code": "sample string 4",
"reference": "sample string 5",
"reference_back_office": "sample string 6",
"reference_customer": "sample string 7",
"date_start": "2025-06-27T16:32:36.7275078+00:00",
"date_end": "2025-06-27T16:32:36.7275078+00:00",
"date_cancel": "2025-06-27T16:32:36.7275078+00:00",
"date_last_invoiced": "2025-06-27T16:32:36.7275078+00:00",
"name": "sample string 12",
"description": "sample string 13",
"feelist_id": "e1a22abd-6883-45ca-927e-a42e5fcf5190",
"article_price_label_id": "8e74c310-90d3-4199-8ef4-dd4986b5dc75",
"account_manager_user_id": "53a84180-01fd-488e-a9a5-9a8e79e867f3",
"account_manager_user": {
"id": "180a7bbe-1d83-4eb8-ad24-eabca510af4f",
"db_language_id": "91cc872d-f55a-40a1-8b9f-911fde3e6fec",
"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-27T16:32:36.7275078+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "272ad8c8-f85f-4eeb-b693-0ad4414895ed",
"sales_organization": {
"id": "ff357c18-0dea-4764-bf42-ac14a8b5193a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0ebb47d-5629-42c5-93f5-b1765a62068e",
"db_currency_id": "3ccd460a-d130-4cb0-98a9-60288098f79f",
"db_language_id": "6e40e47c-7fc8-47cb-949f-df0fbeff5bac",
"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-27T16:32:36.7275078+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a696211d-6c84-4c63-8d44-1f624adb3e5b",
"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": "db1470ba-22d4-416a-a9ab-92f541f936eb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-27T16:32:36.7275078+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "396eadb7-453a-4d8c-9e7d-d4deb7cd9a7f"
},
"account_manager_user_code": "sample string 17",
"modified_dateutc": "2025-06-27T16:32:36.7275078+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
}