PUT api/contract/{id}

This method is to update a specific Contract.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id The contract ID. integer

Required

Body Parameters

ContractModify
NameDescriptionTypeAdditional information
DisplayName The name of the Contract string

String length: inclusive between 0 and 100
CompanyID The ID of the company assgined to the contract integer

None.
StartDate The start date of the contract date

None.
ContractTerm The length of the contract integer

None.
AccountManagerID The ID of the Account Manager assigned to the contract integer

None.
AgentCompanyID The ID of the Agent Company assigned to the contract integer

None.
AgentContactID The ID of the Agent Contact assigned to the contract integer

None.
Cancelled Indicates whether the contract has been cancelled boolean

None.
CancelledDate The date the user requested to cancel the contract date

None.
TerminationDate The date the contract was terminated date

None.
ContractFilename The file name of the contract string

String length: inclusive between 0 and 255
EstimatedUsage Amount (in £) over any bundle on the contract decimal number

None.
EstimatedUsageMargin Amount of overspend that will be profit decimal number

None.
TechFundBalance Displays the technology Fund Balance decimal number

None.
Notes Displays any notes on the contract string

String length: inclusive between 0 and 2000
MaxCLIs The maximum number of CLIs on this contract integer

None.
NetworkProviderID The ID of the Network Provider integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "DisplayName": "sample string 1",
  "CompanyID": 2,
  "StartDate": "2025-04-25T02:03:31.333",
  "ContractTerm": 4,
  "AccountManagerID": 1,
  "AgentCompanyID": 1,
  "AgentContactID": 1,
  "Cancelled": true,
  "CancelledDate": "2025-04-25T02:03:31.333",
  "TerminationDate": "2025-04-25T02:03:31.333",
  "ContractFilename": "sample string 6",
  "EstimatedUsage": 1.0,
  "EstimatedUsageMargin": 1.1,
  "TechFundBalance": 1.0,
  "Notes": "sample string 7",
  "MaxCLIs": 1,
  "NetworkProviderID": 1
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.