GET request/water/contract/{id}

Displays WaterContracts inforamtion for a specific Contract.

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

WaterContract

Name	Type	Additional information
CompanyName	string	None.
ContractEndDate	date	None.
ContractStartDate	date	None.
ContractStatusId	integer	None.
ContractStatusName	string	None.
ContractSubmittedDate	date	None.
ContractTemplateId	integer	None.
ContractURL	string	None.
CreatedDate	date	None.
CreatedUserId	integer	None.
CurrContractEndDate	date	None.
DisplayName	string	None.
DocusignGuidRef	string	None.
englandOrScotland	byte	None.
MugContractId	integer	None.
RegAddress	string	None.
RegisteredAddress	string	None.
SICCode	string	None.
SICCodeDesc	string	None.
sites	Collection of WaterContractSite	None.
SupplierNotes	string	None.
WaveSignature	string	None.
WaveSignatureDate	string	None.
WaveSignatureName	string	None.
WaveSignatureRole	string	None.
WaveSignatureTitle	string	None.

Response Formats

application/json, text/json

Sample:

{
  "mugContractId": 1,
  "contractTemplateId": 1,
  "contractStatusId": 1,
  "contractStatusName": "sample string 1",
  "companyName": "sample string 2",
  "displayName": "sample string 3",
  "registeredAddress": "sample string 4",
  "regAddress": "sample string 5",
  "contractURL": "sample string 6",
  "docusignGuidRef": "sample string 7",
  "createdDate": "2025-06-26T07:06:46.3668201+00:00",
  "englandOrScotland": 64,
  "sites": [
    {
      "mugSiteId": 1,
      "mugResultSiteID": 2,
      "mugResultID": 3,
      "mugQuoteID": 4,
      "mugQuoteSiteID": 5,
      "mugContractSiteID": 6,
      "statusId": 7,
      "statusName": "sample string 8",
      "spid": "sample string 9",
      "sspid": "sample string 10",
      "wCustomer": "sample string 11",
      "sCustomer": "sample string 12",
      "address": "sample string 13",
      "line1": "sample string 14",
      "line2": "sample string 15",
      "city": "sample string 16",
      "county": "sample string 17",
      "postcode": "sample string 18",
      "totalConsumption": 19.0,
      "waterFixed": 20.0,
      "sewerageFixed": 21.0,
      "totalWaterVolumetric": 22.0,
      "totalHighWayDrainage": 23.0,
      "totalSurfaceWaterDrainage": 24.0,
      "totalWholeSale": 25.0,
      "totalDefaultRetailPrice": 26.0,
      "wavePrice": 27.0,
      "totalSewerageVolumetric": 28.0,
      "targetContractStartDate": "sample string 29",
      "targetContractEndDate": "sample string 30",
      "contractEndDate": "sample string 31",
      "waterWholesalerName": "sample string 32",
      "sewerageWholesalerName": "sample string 33",
      "waterRetailerName": "sample string 34",
      "sewerageRetailerName": "sample string 35",
      "buyerNotes": "sample string 36",
      "supplierNotes": "sample string 37",
      "rejectNotes": "sample string 38",
      "spidStatusId": 1,
      "spidStatusName": "sample string 39",
      "sSpidStatusId": 1,
      "sSpidStatusName": "sample string 40"
    },
    {
      "mugSiteId": 1,
      "mugResultSiteID": 2,
      "mugResultID": 3,
      "mugQuoteID": 4,
      "mugQuoteSiteID": 5,
      "mugContractSiteID": 6,
      "statusId": 7,
      "statusName": "sample string 8",
      "spid": "sample string 9",
      "sspid": "sample string 10",
      "wCustomer": "sample string 11",
      "sCustomer": "sample string 12",
      "address": "sample string 13",
      "line1": "sample string 14",
      "line2": "sample string 15",
      "city": "sample string 16",
      "county": "sample string 17",
      "postcode": "sample string 18",
      "totalConsumption": 19.0,
      "waterFixed": 20.0,
      "sewerageFixed": 21.0,
      "totalWaterVolumetric": 22.0,
      "totalHighWayDrainage": 23.0,
      "totalSurfaceWaterDrainage": 24.0,
      "totalWholeSale": 25.0,
      "totalDefaultRetailPrice": 26.0,
      "wavePrice": 27.0,
      "totalSewerageVolumetric": 28.0,
      "targetContractStartDate": "sample string 29",
      "targetContractEndDate": "sample string 30",
      "contractEndDate": "sample string 31",
      "waterWholesalerName": "sample string 32",
      "sewerageWholesalerName": "sample string 33",
      "waterRetailerName": "sample string 34",
      "sewerageRetailerName": "sample string 35",
      "buyerNotes": "sample string 36",
      "supplierNotes": "sample string 37",
      "rejectNotes": "sample string 38",
      "spidStatusId": 1,
      "spidStatusName": "sample string 39",
      "sSpidStatusId": 1,
      "sSpidStatusName": "sample string 40"
    }
  ],
  "createdUserId": 9,
  "sicCode": "sample string 10",
  "sicCodeDesc": "sample string 11",
  "currContractEndDate": "2025-06-26T07:06:46.3668201+00:00",
  "contractStartDate": "2025-06-26T07:06:46.3668201+00:00",
  "contractEndDate": "2025-06-26T07:06:46.3668201+00:00",
  "supplierNotes": "sample string 12",
  "waveSignature": "sample string 13",
  "waveSignatureName": "sample string 14",
  "waveSignatureDate": "sample string 15",
  "waveSignatureTitle": "sample string 16",
  "waveSignatureRole": "sample string 17",
  "contractSubmittedDate": "2025-06-26T07:06:46.3668201+00:00"
}

text/html

Sample:

{"mugContractId":1,"contractTemplateId":1,"contractStatusId":1,"contractStatusName":"sample string 1","companyName":"sample string 2","displayName":"sample string 3","registeredAddress":"sample string 4","regAddress":"sample string 5","contractURL":"sample string 6","docusignGuidRef":"sample string 7","createdDate":"2025-06-26T07:06:46.3668201+00:00","englandOrScotland":64,"sites":[{"mugSiteId":1,"mugResultSiteID":2,"mugResultID":3,"mugQuoteID":4,"mugQuoteSiteID":5,"mugContractSiteID":6,"statusId":7,"statusName":"sample string 8","spid":"sample string 9","sspid":"sample string 10","wCustomer":"sample string 11","sCustomer":"sample string 12","address":"sample string 13","line1":"sample string 14","line2":"sample string 15","city":"sample string 16","county":"sample string 17","postcode":"sample string 18","totalConsumption":19.0,"waterFixed":20.0,"sewerageFixed":21.0,"totalWaterVolumetric":22.0,"totalHighWayDrainage":23.0,"totalSurfaceWaterDrainage":24.0,"totalWholeSale":25.0,"totalDefaultRetailPrice":26.0,"wavePrice":27.0,"totalSewerageVolumetric":28.0,"targetContractStartDate":"sample string 29","targetContractEndDate":"sample string 30","contractEndDate":"sample string 31","waterWholesalerName":"sample string 32","sewerageWholesalerName":"sample string 33","waterRetailerName":"sample string 34","sewerageRetailerName":"sample string 35","buyerNotes":"sample string 36","supplierNotes":"sample string 37","rejectNotes":"sample string 38","spidStatusId":1,"spidStatusName":"sample string 39","sSpidStatusId":1,"sSpidStatusName":"sample string 40"},{"mugSiteId":1,"mugResultSiteID":2,"mugResultID":3,"mugQuoteID":4,"mugQuoteSiteID":5,"mugContractSiteID":6,"statusId":7,"statusName":"sample string 8","spid":"sample string 9","sspid":"sample string 10","wCustomer":"sample string 11","sCustomer":"sample string 12","address":"sample string 13","line1":"sample string 14","line2":"sample string 15","city":"sample string 16","county":"sample string 17","postcode":"sample string 18","totalConsumption":19.0,"waterFixed":20.0,"sewerageFixed":21.0,"totalWaterVolumetric":22.0,"totalHighWayDrainage":23.0,"totalSurfaceWaterDrainage":24.0,"totalWholeSale":25.0,"totalDefaultRetailPrice":26.0,"wavePrice":27.0,"totalSewerageVolumetric":28.0,"targetContractStartDate":"sample string 29","targetContractEndDate":"sample string 30","contractEndDate":"sample string 31","waterWholesalerName":"sample string 32","sewerageWholesalerName":"sample string 33","waterRetailerName":"sample string 34","sewerageRetailerName":"sample string 35","buyerNotes":"sample string 36","supplierNotes":"sample string 37","rejectNotes":"sample string 38","spidStatusId":1,"spidStatusName":"sample string 39","sSpidStatusId":1,"sSpidStatusName":"sample string 40"}],"createdUserId":9,"sicCode":"sample string 10","sicCodeDesc":"sample string 11","currContractEndDate":"2025-06-26T07:06:46.3668201+00:00","contractStartDate":"2025-06-26T07:06:46.3668201+00:00","contractEndDate":"2025-06-26T07:06:46.3668201+00:00","supplierNotes":"sample string 12","waveSignature":"sample string 13","waveSignatureName":"sample string 14","waveSignatureDate":"sample string 15","waveSignatureTitle":"sample string 16","waveSignatureRole":"sample string 17","contractSubmittedDate":"2025-06-26T07:06:46.3668201+00:00"}

application/xml, text/xml

Sample:

<WaterContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.WaterContract">
  <CompanyName>sample string 2</CompanyName>
  <ContractEndDate>2025-06-26T07:06:46.3668201+00:00</ContractEndDate>
  <ContractStartDate>2025-06-26T07:06:46.3668201+00:00</ContractStartDate>
  <ContractStatusId>1</ContractStatusId>
  <ContractStatusName>sample string 1</ContractStatusName>
  <ContractSubmittedDate>2025-06-26T07:06:46.3668201+00:00</ContractSubmittedDate>
  <ContractTemplateId>1</ContractTemplateId>
  <ContractURL>sample string 6</ContractURL>
  <CreatedDate>2025-06-26T07:06:46.3668201+00:00</CreatedDate>
  <CreatedUserId>9</CreatedUserId>
  <CurrContractEndDate>2025-06-26T07:06:46.3668201+00:00</CurrContractEndDate>
  <DisplayName>sample string 3</DisplayName>
  <DocusignGuidRef>sample string 7</DocusignGuidRef>
  <MugContractId>1</MugContractId>
  <RegAddress>sample string 5</RegAddress>
  <RegisteredAddress>sample string 4</RegisteredAddress>
  <SICCode>sample string 10</SICCode>
  <SICCodeDesc>sample string 11</SICCodeDesc>
  <SupplierNotes>sample string 12</SupplierNotes>
  <WaveSignature>sample string 13</WaveSignature>
  <WaveSignatureDate>sample string 15</WaveSignatureDate>
  <WaveSignatureName>sample string 14</WaveSignatureName>
  <WaveSignatureRole>sample string 17</WaveSignatureRole>
  <WaveSignatureTitle>sample string 16</WaveSignatureTitle>
  <englandOrScotland>64</englandOrScotland>
  <sites>
    <WaterContractSite>
      <Address>sample string 13</Address>
      <BuyerNotes>sample string 36</BuyerNotes>
      <City>sample string 16</City>
      <ContractEndDate>sample string 31</ContractEndDate>
      <County>sample string 17</County>
      <Line1>sample string 14</Line1>
      <Line2>sample string 15</Line2>
      <MugContractSiteID>6</MugContractSiteID>
      <MugQuoteID>4</MugQuoteID>
      <MugQuoteSiteID>5</MugQuoteSiteID>
      <MugResultID>3</MugResultID>
      <MugResultSiteID>2</MugResultSiteID>
      <MugSiteId>1</MugSiteId>
      <Postcode>sample string 18</Postcode>
      <RejectNotes>sample string 38</RejectNotes>
      <SCustomer>sample string 12</SCustomer>
      <SPID>sample string 9</SPID>
      <SSPID>sample string 10</SSPID>
      <SSpidStatusId>1</SSpidStatusId>
      <SSpidStatusName>sample string 40</SSpidStatusName>
      <SewerageFixed>21</SewerageFixed>
      <SewerageRetailerName>sample string 35</SewerageRetailerName>
      <SewerageWholesalerName>sample string 33</SewerageWholesalerName>
      <SpidStatusId>1</SpidStatusId>
      <SpidStatusName>sample string 39</SpidStatusName>
      <StatusId>7</StatusId>
      <StatusName>sample string 8</StatusName>
      <SupplierNotes>sample string 37</SupplierNotes>
      <TargetContractEndDate>sample string 30</TargetContractEndDate>
      <TargetContractStartDate>sample string 29</TargetContractStartDate>
      <TotalConsumption>19</TotalConsumption>
      <TotalDefaultRetailPrice>26</TotalDefaultRetailPrice>
      <TotalHighWayDrainage>23</TotalHighWayDrainage>
      <TotalSewerageVolumetric>28</TotalSewerageVolumetric>
      <TotalSurfaceWaterDrainage>24</TotalSurfaceWaterDrainage>
      <TotalWaterVolumetric>22</TotalWaterVolumetric>
      <TotalWholeSale>25</TotalWholeSale>
      <WCustomer>sample string 11</WCustomer>
      <WaterFixed>20</WaterFixed>
      <WaterRetailerName>sample string 34</WaterRetailerName>
      <WaterWholesalerName>sample string 32</WaterWholesalerName>
      <WavePrice>27</WavePrice>
    </WaterContractSite>
    <WaterContractSite>
      <Address>sample string 13</Address>
      <BuyerNotes>sample string 36</BuyerNotes>
      <City>sample string 16</City>
      <ContractEndDate>sample string 31</ContractEndDate>
      <County>sample string 17</County>
      <Line1>sample string 14</Line1>
      <Line2>sample string 15</Line2>
      <MugContractSiteID>6</MugContractSiteID>
      <MugQuoteID>4</MugQuoteID>
      <MugQuoteSiteID>5</MugQuoteSiteID>
      <MugResultID>3</MugResultID>
      <MugResultSiteID>2</MugResultSiteID>
      <MugSiteId>1</MugSiteId>
      <Postcode>sample string 18</Postcode>
      <RejectNotes>sample string 38</RejectNotes>
      <SCustomer>sample string 12</SCustomer>
      <SPID>sample string 9</SPID>
      <SSPID>sample string 10</SSPID>
      <SSpidStatusId>1</SSpidStatusId>
      <SSpidStatusName>sample string 40</SSpidStatusName>
      <SewerageFixed>21</SewerageFixed>
      <SewerageRetailerName>sample string 35</SewerageRetailerName>
      <SewerageWholesalerName>sample string 33</SewerageWholesalerName>
      <SpidStatusId>1</SpidStatusId>
      <SpidStatusName>sample string 39</SpidStatusName>
      <StatusId>7</StatusId>
      <StatusName>sample string 8</StatusName>
      <SupplierNotes>sample string 37</SupplierNotes>
      <TargetContractEndDate>sample string 30</TargetContractEndDate>
      <TargetContractStartDate>sample string 29</TargetContractStartDate>
      <TotalConsumption>19</TotalConsumption>
      <TotalDefaultRetailPrice>26</TotalDefaultRetailPrice>
      <TotalHighWayDrainage>23</TotalHighWayDrainage>
      <TotalSewerageVolumetric>28</TotalSewerageVolumetric>
      <TotalSurfaceWaterDrainage>24</TotalSurfaceWaterDrainage>
      <TotalWaterVolumetric>22</TotalWaterVolumetric>
      <TotalWholeSale>25</TotalWholeSale>
      <WCustomer>sample string 11</WCustomer>
      <WaterFixed>20</WaterFixed>
      <WaterRetailerName>sample string 34</WaterRetailerName>
      <WaterWholesalerName>sample string 32</WaterWholesalerName>
      <WavePrice>27</WavePrice>
    </WaterContractSite>
  </sites>
</WaterContract>