Retrieves all the contracts
Request Information
URI Parameters :
None.
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": "f629195e-e6e2-4b88-aa7c-fb2899d50085",
"id2": 2,
"company_id": "d4ce1093-c5fe-4a9b-9d1b-18792b741ffd",
"company_code": "sample string 4",
"reference": "sample string 5",
"reference_back_office": "sample string 6",
"reference_customer": "sample string 7",
"date_start": "2025-11-13T16:50:48.5060341+00:00",
"date_end": "2025-11-13T16:50:48.5060341+00:00",
"date_cancel": "2025-11-13T16:50:48.5060341+00:00",
"date_last_invoiced": "2025-11-13T16:50:48.5060341+00:00",
"name": "sample string 12",
"description": "sample string 13",
"feelist_id": "7e72d26e-82c2-41ec-b003-3b36c21ebfc5",
"article_price_label_id": "ceaa1e1d-e367-4da8-92c4-b45804951d48",
"account_manager_user_id": "1327818a-83e2-4f23-8287-61621cbf85ac",
"account_manager_user": {
"id": "b1917867-d2be-47dd-abcd-004d91b3f7f9",
"db_language_id": "60fcf4da-667c-41ac-b452-46baa7bf4952",
"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-11-13T16:50:48.5060341+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dd8cda72-db3c-4895-a4d1-53be95163012",
"sales_organization": {
"id": "ff26cd20-44ff-4aff-a496-0582247d47b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74707545-34ad-49a5-8ebf-7c71f8462c27",
"db_currency_id": "16b2dce3-623d-4cc8-bde5-41902bcd70b3",
"db_language_id": "0a3111f2-2377-4f6c-ae27-d0622f937834",
"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-11-13T16:50:48.5060341+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ecf064b6-f492-4b96-8e34-e37ecc38da5f",
"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": "92833d70-7524-4b01-a225-3c0d5bf16087",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-13T16:50:48.5060341+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "30fbf2f5-d7dd-4229-b8d5-34c1faaf0253"
},
"account_manager_user_code": "sample string 17",
"modified_dateutc": "2025-11-13T16:50:48.5060341+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
}