Wello Web API - POST api/Contract

Creates a new Contract object

Request Information

URI Parameters :

None.

Body Parameters :

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
bill_to_company_id	Company id for bill	globally unique identifier

Request Formats :

application/json, text/json

Sample:

{
  "id": "63de4b2f-a3f4-4c27-bed1-f77861b4fe9b",
  "id2": 2,
  "company_id": "3100baf3-e379-4f46-9e5f-aae52d8c0094",
  "company_code": "sample string 4",
  "reference": "sample string 5",
  "reference_back_office": "sample string 6",
  "reference_customer": "sample string 7",
  "date_start": "2025-01-18T10:51:14.4054382+00:00",
  "date_end": "2025-01-18T10:51:14.4054382+00:00",
  "date_cancel": "2025-01-18T10:51:14.4054382+00:00",
  "date_last_invoiced": "2025-01-18T10:51:14.4054382+00:00",
  "name": "sample string 12",
  "description": "sample string 13",
  "feelist_id": "1d858366-08ed-468b-83f5-7e6c2e9a64b1",
  "article_price_label_id": "729d9d7f-01ff-44c5-99aa-dcc504345872",
  "account_manager_user_id": "81c2c3e0-364f-4b8f-964e-854b844c0400",
  "account_manager_user": {
    "id": "2af63ff6-1eb1-4fcf-8544-b9c9778b12a2",
    "db_language_id": "97bf41f4-452d-4520-a394-f8792acdc8da",
    "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-01-18T10:51:14.4054382+00:00",
    "skype": "sample string 16",
    "notes": "sample string 17",
    "sales_organization_id": "c09a5d31-0084-4ee4-bfb4-7ce72c6b6d1a",
    "sales_organization": {
      "id": "2db01307-500e-4834-81c3-eb1873dda0c3",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "f1100da3-dd9f-409e-ad60-0d596ebdbcaf",
      "db_currency_id": "1f779b2f-b2fd-4d81-b6a9-afe0ba530b95",
      "db_language_id": "2f619053-7315-4ec0-b723-d8b13b443de8",
      "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-01-18T10:51:14.4054382+00:00"
    },
    "sales_organization_code": "sample string 19",
    "is_team_leader": true,
    "team_leader_user_id": "ea47e3ce-5220-440c-b8d0-84db423c78c4",
    "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": "35ca6c94-3b8e-45c5-9c39-f75f8e67bdc5",
    "private_db_country_code": "sample string 35",
    "modified_dateutc": "2025-01-18T10:51:14.4054382+00:00",
    "allow_hero_app": true,
    "allow_sales_app": true,
    "allow_service_app": true,
    "user_group_id": "a56f5533-abbc-4f1a-b9e7-bf72cbc89e00",
    "udf1": "sample string 41",
    "udf2": "sample string 42",
    "udf3": "sample string 43",
    "udf4": "sample string 44",
    "udf5": "sample string 45",
    "udf6": "sample string 46",
    "udf7": "sample string 47",
    "udf8": "sample string 48",
    "udf9": "sample string 49",
    "udf10": "sample string 50",
    "udf11": "sample string 51",
    "udf12": "sample string 52",
    "udf13": "sample string 53",
    "udf14": "sample string 54",
    "udf15": "sample string 55",
    "udf16": "sample string 56",
    "udf17": "sample string 57",
    "udf18": "sample string 58",
    "udf19": "sample string 59",
    "udf20": "sample string 60",
    "udf21": "sample string 61",
    "udf22": "sample string 62",
    "udf23": "sample string 63",
    "udf24": "sample string 64",
    "udf25": "sample string 65",
    "udf26": "sample string 66",
    "udf27": "sample string 67",
    "udf28": "sample string 68",
    "udf29": "sample string 69",
    "udf30": "sample string 70",
    "udf31": "sample string 71",
    "udf32": "sample string 72",
    "udf33": "sample string 73",
    "udf34": "sample string 74",
    "udf35": "sample string 75",
    "udf36": "sample string 76",
    "udf37": "sample string 77",
    "udf38": "sample string 78",
    "udf39": "sample string 79",
    "udf40": "sample string 80",
    "udf41": "sample string 81",
    "udf42": "sample string 82",
    "udf43": "sample string 83",
    "udf44": "sample string 84",
    "udf45": "sample string 85",
    "udf46": "sample string 86",
    "udf47": "sample string 87",
    "udf48": "sample string 88",
    "udf49": "sample string 89",
    "udf50": "sample string 90",
    "udf51": "sample string 91",
    "udf52": "sample string 92",
    "udf53": "sample string 93",
    "udf54": "sample string 94",
    "udf55": "sample string 95",
    "udf56": "sample string 96",
    "udf57": "sample string 97",
    "udf58": "sample string 98",
    "udf59": "sample string 99",
    "udf60": "sample string 100",
    "udf61": "sample string 101",
    "udf62": "sample string 102",
    "udf63": "sample string 103",
    "udf64": "sample string 104",
    "udf65": "sample string 105",
    "udf66": "sample string 106",
    "udf67": "sample string 107",
    "udf68": "sample string 108",
    "udf69": "sample string 109",
    "udf70": "sample string 110",
    "udf71": "sample string 111",
    "udf72": "sample string 112",
    "udf73": "sample string 113",
    "udf74": "sample string 114",
    "udf75": "sample string 115",
    "udf76": "sample string 116",
    "udf77": "sample string 117",
    "udf78": "sample string 118",
    "udf79": "sample string 119",
    "udf80": "sample string 120",
    "udf81": "sample string 121",
    "udf82": "sample string 122",
    "udf83": "sample string 123",
    "udf84": "sample string 124",
    "udf85": "sample string 125",
    "udf86": "sample string 126",
    "udf87": "sample string 127",
    "udf88": "sample string 128",
    "udf89": "sample string 129",
    "udf90": "sample string 130",
    "udf91": "sample string 131",
    "udf92": "sample string 132",
    "udf93": "sample string 133",
    "udf94": "sample string 134",
    "udf95": "sample string 135",
    "udf96": "sample string 136",
    "udf97": "sample string 137",
    "udf98": "sample string 138",
    "udf99": "sample string 139",
    "udf100": "sample string 140"
  },
  "account_manager_user_code": "sample string 17",
  "modified_dateutc": "2025-01-18T10:51:14.4054382+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,
  "bill_to_company_id": "9a2a4cbb-243c-4145-84cf-bdf6cae05a44"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.

API User Guide

Wello Web API - POST api/Contract

Request Information

URI Parameters :

Body Parameters :

Request Formats :

application/json, text/json

Response Information

Resource Description :

Response Formats

application/json, text/json