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": "4a3c8683-1b36-4c18-a6ff-c5da12c9345d",
"id2": 2,
"company_id": "cd0bf88d-13a1-4301-82ff-12f41f7c8aec",
"company_code": "sample string 4",
"reference": "sample string 5",
"reference_back_office": "sample string 6",
"reference_customer": "sample string 7",
"date_start": "2025-08-05T14:24:01.8729145+00:00",
"date_end": "2025-08-05T14:24:01.8729145+00:00",
"date_cancel": "2025-08-05T14:24:01.8729145+00:00",
"date_last_invoiced": "2025-08-05T14:24:01.8729145+00:00",
"name": "sample string 12",
"description": "sample string 13",
"feelist_id": "8c68bf75-4f24-42c3-a58d-25ff49caed4b",
"article_price_label_id": "b44f0524-03c6-48c2-9cdb-ea33e5eee015",
"account_manager_user_id": "bb3bd0b9-fb46-4b3d-a293-28414194ac0e",
"account_manager_user": {
"id": "b82ad063-1a55-4346-96f7-3beac41dabd3",
"db_language_id": "731731ce-5aa5-45ea-a58f-2cd6c7b5ca94",
"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-08-05T14:24:01.8729145+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cc5e2042-9a18-4b2a-a8e0-fd35ae9b074d",
"sales_organization": {
"id": "918f2e1e-1fab-44f8-abf2-18c1c368dbda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c4ef8b1-28a4-4fc3-8e11-9425dd870c44",
"db_currency_id": "bcf9c2c1-3877-44e8-9039-5def3062796b",
"db_language_id": "10f6ffc7-5ebe-4fb0-a296-be0360f75768",
"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-08-05T14:24:01.8729145+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "45e3379a-39c1-4927-a2d4-4366671f5579",
"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": "e5106280-107a-4cf2-bfb9-b338fb69a6e0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-08-05T14:24:01.8729145+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6886c35f-3aab-4864-b7c9-2a41fca107b1"
},
"account_manager_user_code": "sample string 17",
"modified_dateutc": "2025-08-05T14:24:01.8729145+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
}