GET request/contract/{Id}

Returns a specific Contract information

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Contract
NameDescriptionTypeAdditional information
AgentName

string

None.

BuyerNotes

string

None.

Commission

decimal number

None.

CompanyName

string

None.

ContractConsumption

decimal number

None.

ContractDetailId

integer

None.

ContractId

integer

None.

ContractStartDate

date

None.

ContractStatusId

integer

None.

ContractTemplateId

integer

None.

ContractURL

string

None.

DateCreated

date

None.

DocusignGuideRef

string

None.

EstimatedCommission

decimal number

None.

FuelType

string

None.

SiteAddress

string

None.

SiteName

string

None.

SitePostcode

string

None.

Status

string

None.

SupplierName

string

None.

SupplierNotes

string

None.

VerbalContract

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "contractId": 1,
  "contractDetailId": 1,
  "contractTemplateId": 2,
  "contractStatusId": 3,
  "contractURL": "sample string 4",
  "siteName": "sample string 5",
  "companyName": "sample string 6",
  "supplierName": "sample string 7",
  "siteAddress": "sample string 8",
  "fuelType": "sample string 9",
  "commission": 10.0,
  "dateCreated": "2025-06-28T03:23:16.4468413+00:00",
  "docusignGuideRef": "sample string 12",
  "status": "sample string 13",
  "buyerNotes": "sample string 14",
  "verbalContract": true,
  "supplierNotes": "sample string 16",
  "contractConsumption": 1.0,
  "agentName": "sample string 17",
  "sitePostcode": "sample string 18",
  "contractStartDate": "2025-06-28T03:23:16.4468413+00:00",
  "estimatedCommission": 1.0
}

text/html

Sample:
{"contractId":1,"contractDetailId":1,"contractTemplateId":2,"contractStatusId":3,"contractURL":"sample string 4","siteName":"sample string 5","companyName":"sample string 6","supplierName":"sample string 7","siteAddress":"sample string 8","fuelType":"sample string 9","commission":10.0,"dateCreated":"2025-06-28T03:23:16.4468413+00:00","docusignGuideRef":"sample string 12","status":"sample string 13","buyerNotes":"sample string 14","verbalContract":true,"supplierNotes":"sample string 16","contractConsumption":1.0,"agentName":"sample string 17","sitePostcode":"sample string 18","contractStartDate":"2025-06-28T03:23:16.4468413+00:00","estimatedCommission":1.0}

application/xml, text/xml

Sample:
<Contract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.QuoteDto">
  <AgentName>sample string 17</AgentName>
  <BuyerNotes>sample string 14</BuyerNotes>
  <Commission>10</Commission>
  <CompanyName>sample string 6</CompanyName>
  <ContractConsumption>1</ContractConsumption>
  <ContractDetailId>1</ContractDetailId>
  <ContractId>1</ContractId>
  <ContractStartDate>2025-06-28T03:23:16.4468413+00:00</ContractStartDate>
  <ContractStatusId>3</ContractStatusId>
  <ContractTemplateId>2</ContractTemplateId>
  <ContractURL>sample string 4</ContractURL>
  <DateCreated>2025-06-28T03:23:16.4468413+00:00</DateCreated>
  <DocusignGuideRef>sample string 12</DocusignGuideRef>
  <EstimatedCommission>1</EstimatedCommission>
  <FuelType>sample string 9</FuelType>
  <SiteAddress>sample string 8</SiteAddress>
  <SiteName>sample string 5</SiteName>
  <SitePostcode>sample string 18</SitePostcode>
  <Status>sample string 13</Status>
  <SupplierName>sample string 7</SupplierName>
  <SupplierNotes>sample string 16</SupplierNotes>
  <VerbalContract>true</VerbalContract>
</Contract>