Retrieves the contract with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The contract id. |
globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the contract, or 404 Not Found if it doesn't exist.
contract| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| id2 |
id2 |
integer |
Required |
| reference_back_office |
Backoffice reference |
string | |
| name |
Name of the contract |
string | |
| company_id |
Foreign key of the company this contract belongs to. |
globally unique identifier | |
| contract_type_id |
Foreign key of the contract's type (see ). |
globally unique identifier | |
| contract_status_id |
Foreign key of the contract's current status. |
globally unique identifier | |
| internal_remark |
Internal remark about the contract, not shown to the customer. |
string | |
| date_start |
Date and time from which the contract is valid. |
date | |
| date_end |
Date and time until which the contract remains valid. |
date | |
| hours_free_for_preventive_jobs |
Hours free for preventive jobs |
boolean | |
| feelist_id |
Feelist id |
globally unique identifier | |
| article_price_label_id |
Article price label id |
globally unique identifier | |
| travel_fee_fix_discount |
Fixed discount amount applied to travel fees billed under this contract. |
decimal number | |
| articles_free_for_preventive_jobs |
Indicates that articles used on preventive jobs are free of charge under this contract. |
boolean | |
| reference |
Free-text reference for this contract. |
string | |
| discount |
Default discount percentage applied to billable lines under this contract. |
decimal number | |
| company_discount_family_id |
Foreign key of the discount family this contract's pricing follows, when scoped by discount family. |
globally unique identifier | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{
"id": "727220ee-d696-41a8-947f-7b1d8e323868",
"id2": 2,
"reference_back_office": "sample string 3",
"name": "sample string 4",
"company_id": "23e9ed3b-39d0-4765-8242-fb09dedc12de",
"contract_type_id": "8e6969b1-3171-438e-a48b-0ca93d7f6f29",
"contract_status_id": "9cb9caf1-e825-4827-b967-fafe647de35b",
"internal_remark": "sample string 8",
"date_start": "2026-11-12T14:28:34.7287958+00:00",
"date_end": "2026-11-12T14:28:34.7287958+00:00",
"hours_free_for_preventive_jobs": true,
"feelist_id": "dc9cfac3-cf73-47c6-82cd-3d58658cdf2f",
"article_price_label_id": "3b0d7821-0665-4e69-96cb-00ac86d116bc",
"travel_fee_fix_discount": 14.0,
"articles_free_for_preventive_jobs": true,
"reference": "sample string 16",
"discount": 17.0,
"company_discount_family_id": "2c841cbc-eb44-4a58-9340-d54a13924e13",
"modified_dateutc": "2026-11-12T14:28:34.7287958+00:00"
}
application/xml, text/xml
<contract xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <article_price_label_id>3b0d7821-0665-4e69-96cb-00ac86d116bc</article_price_label_id> <articles_free_for_preventive_jobs>true</articles_free_for_preventive_jobs> <company_discount_family_id>2c841cbc-eb44-4a58-9340-d54a13924e13</company_discount_family_id> <company_id>23e9ed3b-39d0-4765-8242-fb09dedc12de</company_id> <contract_status_id>9cb9caf1-e825-4827-b967-fafe647de35b</contract_status_id> <contract_type_id>8e6969b1-3171-438e-a48b-0ca93d7f6f29</contract_type_id> <date_end>2026-11-12T14:28:34.728Z</date_end> <date_start>2026-11-12T14:28:34.728Z</date_start> <discount>17</discount> <feelist_id>dc9cfac3-cf73-47c6-82cd-3d58658cdf2f</feelist_id> <hours_free_for_preventive_jobs>true</hours_free_for_preventive_jobs> <id>727220ee-d696-41a8-947f-7b1d8e323868</id> <id2>2</id2> <internal_remark>sample string 8</internal_remark> <modified_dateutc>2026-11-12T14:28:34.728Z</modified_dateutc> <name>sample string 4</name> <reference>sample string 16</reference> <reference_back_office>sample string 3</reference_back_office> <travel_fee_fix_discount>14</travel_fee_fix_discount> </contract>