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": "1b6f4021-a696-49fa-aa7c-dc89ba5efac4",
  "id2": 2,
  "company_id": "383f4242-4ef8-4c95-a604-781a7916899f",
  "company_code": "sample string 4",
  "reference": "sample string 5",
  "reference_back_office": "sample string 6",
  "reference_customer": "sample string 7",
  "date_start": "2022-12-02T20:26:48.8080789+01:00",
  "date_end": "2022-12-02T20:26:48.8080789+01:00",
  "date_cancel": "2022-12-02T20:26:48.8080789+01:00",
  "date_last_invoiced": "2022-12-02T20:26:48.8080789+01:00",
  "name": "sample string 12",
  "description": "sample string 13",
  "feelist_id": "fb32c9ed-bfaa-48e5-a68d-6e305b8fd379",
  "article_price_label_id": "6aee1a94-3484-4a23-8a7c-3b0f1fcaff2e",
  "account_manager_user_id": "4b18250b-4a89-4c20-8a39-17279ca91179",
  "account_manager_user": {
    "id": "eef7f432-ad89-4952-ac15-0ddde1e972cf",
    "db_language_id": "f94687bb-2e82-4ae6-b5dc-6e14e3a919fa",
    "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": "2022-12-02T20:26:48.8080789+01:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "b67c0112-64b1-414f-a8f9-630e3c14b399",
    "sales_organization": {
      "id": "64da9682-df47-482f-aa84-6dd78f961053",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "33824dd9-5fdb-4a76-9dd9-ec043f4f0dbf",
      "db_currency_id": "a28c3b17-e6c5-4b29-b551-a56ee27145bf",
      "db_language_id": "1ada732d-5041-417e-9c10-b54495fbc176",
      "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": "2022-12-02T20:26:48.8080789+01:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "3eb3fe9f-2a71-4062-af1d-a34e8e02d73b",
    "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": "177f9d91-0e98-4d28-a93c-cd24d08dd514",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2022-12-02T20:26:48.8080789+01:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "0ec9617d-eb88-4b79-be60-cfed6279b2be"
  },
  "account_manager_user_code": "sample string 17",
  "modified_dateutc": "2022-12-02T20:26:48.8080789+01: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
}