Retrieves the Contract with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

contract
NameDescriptionTypeAdditional 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

Sample:
{
  "id": "3614a640-526f-4150-8924-55e9714b9d4d",
  "id2": 2,
  "company_id": "98233a6c-bd33-4138-91ce-39b155e535ad",
  "company_code": "sample string 4",
  "reference": "sample string 5",
  "reference_back_office": "sample string 6",
  "reference_customer": "sample string 7",
  "date_start": "2024-05-19T15:41:24.2649547+00:00",
  "date_end": "2024-05-19T15:41:24.2649547+00:00",
  "date_cancel": "2024-05-19T15:41:24.2649547+00:00",
  "date_last_invoiced": "2024-05-19T15:41:24.2649547+00:00",
  "name": "sample string 12",
  "description": "sample string 13",
  "feelist_id": "b2af877a-2ce7-41c4-82b5-5eddf49e96c9",
  "article_price_label_id": "3f297728-cd77-4c3d-82ac-4de946065262",
  "account_manager_user_id": "1132bdf5-dd46-4012-97b9-f3038cc73ae0",
  "account_manager_user": {
    "id": "d0ab3dea-cd7f-451b-a583-6ec894d53b3c",
    "db_language_id": "29788d28-f67b-423b-9459-a868d556a333",
    "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": "2024-05-19T15:41:24.2649547+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "59a378df-bf8d-43ae-9ebb-0f79c06ba651",
    "sales_organization": {
      "id": "85ada4c6-bfa4-42ba-88eb-d201fddec5ed",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "5526b342-4d35-42f1-8b69-fb0f0258711b",
      "db_currency_id": "0278d422-a8f9-4266-87f2-17cf2e1413e5",
      "db_language_id": "88661e70-bf46-4dc5-91e7-4ae37a0c1b40",
      "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": "2024-05-19T15:41:24.2649547+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "54171001-3ff0-43c2-a32a-8ad2986e2e73",
    "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": "b21fa7de-e46f-4a26-affa-ed21e303717a",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2024-05-19T15:41:24.2649547+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "190611ef-cfdc-4828-83a0-335c19c83267"
  },
  "account_manager_user_code": "sample string 17",
  "modified_dateutc": "2024-05-19T15:41:24.2649547+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
}