GET request/contract/{Id}/byid

Returns a specific Contract information for MultiMeter

Request Information

URI Parameters

Name	Description	Type	Additional information
Id		integer	Required

Body Parameters

None.

Response Information

Resource Description

MultiContract

Name	Type	Additional 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.
CreatedDate	date	None.
DocusignGuideRef	string	None.
EstimatedCommission	decimal number	None.
FuelType	string	None.
InstantResultGroupId	integer	None.
SiteAddress	string	None.
sitemeters	Collection of SiteMeterDetails	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,
  "instantResultGroupId": 2,
  "contractTemplateId": 3,
  "contractStatusId": 4,
  "contractURL": "sample string 5",
  "siteName": "sample string 6",
  "companyName": "sample string 7",
  "supplierName": "sample string 8",
  "siteAddress": "sample string 9",
  "fuelType": "sample string 10",
  "commission": 11.0,
  "createdDate": "2025-06-26T10:23:17.1743941+00:00",
  "docusignGuideRef": "sample string 13",
  "status": "sample string 14",
  "buyerNotes": "sample string 15",
  "verbalContract": true,
  "supplierNotes": "sample string 17",
  "contractConsumption": 1.0,
  "agentName": "sample string 18",
  "sitePostcode": "sample string 19",
  "contractStartDate": "2025-06-26T10:23:17.1900192+00:00",
  "estimatedCommission": 1.0,
  "sitemeters": [
    {
      "siteAddress": "sample string 1",
      "mpanMprn": "sample string 2"
    },
    {
      "siteAddress": "sample string 1",
      "mpanMprn": "sample string 2"
    }
  ]
}

text/html

Sample:

{"contractId":1,"contractDetailId":1,"instantResultGroupId":2,"contractTemplateId":3,"contractStatusId":4,"contractURL":"sample string 5","siteName":"sample string 6","companyName":"sample string 7","supplierName":"sample string 8","siteAddress":"sample string 9","fuelType":"sample string 10","commission":11.0,"createdDate":"2025-06-26T10:23:17.1743941+00:00","docusignGuideRef":"sample string 13","status":"sample string 14","buyerNotes":"sample string 15","verbalContract":true,"supplierNotes":"sample string 17","contractConsumption":1.0,"agentName":"sample string 18","sitePostcode":"sample string 19","contractStartDate":"2025-06-26T10:23:17.1900192+00:00","estimatedCommission":1.0,"sitemeters":[{"siteAddress":"sample string 1","mpanMprn":"sample string 2"},{"siteAddress":"sample string 1","mpanMprn":"sample string 2"}]}

application/xml, text/xml

Sample:

<MultiContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.QuoteDto">
  <AgentName>sample string 18</AgentName>
  <BuyerNotes>sample string 15</BuyerNotes>
  <Commission>11</Commission>
  <CompanyName>sample string 7</CompanyName>
  <ContractConsumption>1</ContractConsumption>
  <ContractDetailId>1</ContractDetailId>
  <ContractId>1</ContractId>
  <ContractStartDate>2025-06-26T10:23:17.1900192+00:00</ContractStartDate>
  <ContractStatusId>4</ContractStatusId>
  <ContractTemplateId>3</ContractTemplateId>
  <ContractURL>sample string 5</ContractURL>
  <CreatedDate>2025-06-26T10:23:17.1743941+00:00</CreatedDate>
  <DocusignGuideRef>sample string 13</DocusignGuideRef>
  <EstimatedCommission>1</EstimatedCommission>
  <FuelType>sample string 10</FuelType>
  <InstantResultGroupId>2</InstantResultGroupId>
  <SiteAddress>sample string 9</SiteAddress>
  <SiteName>sample string 6</SiteName>
  <SitePostcode>sample string 19</SitePostcode>
  <Status>sample string 14</Status>
  <SupplierName>sample string 8</SupplierName>
  <SupplierNotes>sample string 17</SupplierNotes>
  <VerbalContract>true</VerbalContract>
  <sitemeters>
    <SiteMeterDetails>
      <MpanMprn>sample string 2</MpanMprn>
      <SiteAddress>sample string 1</SiteAddress>
    </SiteMeterDetails>
    <SiteMeterDetails>
      <MpanMprn>sample string 2</MpanMprn>
      <SiteAddress>sample string 1</SiteAddress>
    </SiteMeterDetails>
  </sitemeters>
</MultiContract>