GET api/contract/{id}

This API method returns details of the specified Contract by its ID

Error Messages
  • 404/Not Found - No contracts found with ID x - Specified ID is not linked to any contracts
  • 401/Unauthorised - Invalid company permissions - User does not have the permissions to use this method

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id The unique identifer for the contract being queried. integer

Required

Body Parameters

None.

Response Information

Resource Description

Company with the id requested

ContractView
NameDescriptionTypeAdditional information
ContractID The ID of the returned contract integer

None.

LastUpdated The date/time that the contract was last updated date

None.

DisplayName The display name of the returned contract string

String length: inclusive between 0 and 100

CompanyID The ID of the company to which this contract belongs integer

None.

StartDate The Start Date of the contract date

None.

ContractTerm The total duration of the contract term integer

None.

AccountManagerID The ID of the Account Manager related to the contract integer

None.

AgentCompanyID The ID of the Agent Company related to the contract integer

None.

AgentContactID The Agent Contract ID integer

None.

Cancelled Indicates whether the contract is cancelled boolean

None.

CancelledDate The date that the contract was cancelled date

None.

TerminationDate The termination date of the contract date

None.

ContractFilename The filename 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 of 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.