POST request/contract/query

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
contract	MultiContracts	None.
email	string	None.
firstName	string	None.
lastName	string	None.
message	string	None.
title	string	None.
type	string	None.

Request Formats

application/json, text/json

Sample:

{
  "contract": {
    "contractId": 1,
    "contractTemplateId": 1,
    "contractURL": "sample string 2",
    "supplierName": "sample string 3",
    "companyName": "sample string 4",
    "fuelType": "sample string 5",
    "commission": 6.0,
    "dateCreated": "2026-01-18T07:24:59.2955494+00:00",
    "docusignGuideRef": "sample string 7",
    "status": "sample string 8",
    "contractStatusId": 9,
    "agentName": "sample string 10",
    "agentId": 1,
    "contractStartDate": "2026-01-18T07:24:59.2955494+00:00",
    "fixedContractEndDate": "2026-01-18T07:24:59.2955494+00:00",
    "channelName": "sample string 11",
    "contactName": "sample string 12",
    "contractEndDate": "2026-01-18T07:24:59.2955494+00:00",
    "quoteId": 1,
    "quoteRaisedDate": "2026-01-18T07:24:59.2955494+00:00",
    "sites": [
      {
        "contractId": 1,
        "contractStatusId": 2,
        "siteName": "sample string 3",
        "supplierName": "sample string 4",
        "siteAddress": "sample string 5",
        "status": "sample string 6",
        "consumption": 1.0,
        "sitePostcode": "sample string 7",
        "mpxn": "sample string 8",
        "supplierNotes": "sample string 9",
        "buyerNotes": "sample string 10",
        "meterNotes": "sample string 11",
        "contractDetailId": 12,
        "totalCostExclVat": 13.0,
        "rateType": "Single",
        "standingCharge": 1.0,
        "singleUnitRate": 1.0,
        "dayRate": 1.0,
        "nightRate": 1.0,
        "weekdayRate": 1.0,
        "eveningWeekendRate": 1.0,
        "weekendRate": 1.0,
        "unitConsumption": 1,
        "dayConsumption": 1,
        "nightConsumption": 1,
        "eveningWeekendConsumption": 1,
        "weekdayConsumption": 1,
        "weekendConsumption": 1,
        "dayUnitRate": 1.0,
        "nightUnitRate": 1.0,
        "eveningWeekendUnitRate": 1.0,
        "dayConsumption3Format": 1.0,
        "nightConsumption3Format": 1.0,
        "eveningConsumption3Format": 1.0,
        "hasStandingChargeCommission": true,
        "isCommissionPercent": true,
        "instantCommissionPercent": 1.0,
        "contractDuration": 64,
        "totalContractCommission": 1.0,
        "totalContractBrokerCommission": 1.0,
        "totalCommission": 1.0,
        "totalContractAnnualCost": 1.0,
        "contractSigned": "2026-01-18T07:24:59.2955494+00:00"
      },
      {
        "contractId": 1,
        "contractStatusId": 2,
        "siteName": "sample string 3",
        "supplierName": "sample string 4",
        "siteAddress": "sample string 5",
        "status": "sample string 6",
        "consumption": 1.0,
        "sitePostcode": "sample string 7",
        "mpxn": "sample string 8",
        "supplierNotes": "sample string 9",
        "buyerNotes": "sample string 10",
        "meterNotes": "sample string 11",
        "contractDetailId": 12,
        "totalCostExclVat": 13.0,
        "rateType": "Single",
        "standingCharge": 1.0,
        "singleUnitRate": 1.0,
        "dayRate": 1.0,
        "nightRate": 1.0,
        "weekdayRate": 1.0,
        "eveningWeekendRate": 1.0,
        "weekendRate": 1.0,
        "unitConsumption": 1,
        "dayConsumption": 1,
        "nightConsumption": 1,
        "eveningWeekendConsumption": 1,
        "weekdayConsumption": 1,
        "weekendConsumption": 1,
        "dayUnitRate": 1.0,
        "nightUnitRate": 1.0,
        "eveningWeekendUnitRate": 1.0,
        "dayConsumption3Format": 1.0,
        "nightConsumption3Format": 1.0,
        "eveningConsumption3Format": 1.0,
        "hasStandingChargeCommission": true,
        "isCommissionPercent": true,
        "instantCommissionPercent": 1.0,
        "contractDuration": 64,
        "totalContractCommission": 1.0,
        "totalContractBrokerCommission": 1.0,
        "totalCommission": 1.0,
        "totalContractAnnualCost": 1.0,
        "contractSigned": "2026-01-18T07:24:59.2955494+00:00"
      }
    ],
    "createdBy": "sample string 14",
    "totalContractCommission": 1.0,
    "totalContractBrokerCommission": 1.0,
    "totalCommission": 1.0,
    "totalContractAnnualCost": 1.0,
    "contractSigned": "2026-01-18T07:24:59.2955494+00:00",
    "contractConsumption": 1.0,
    "contractDuration": 64
  },
  "type": "sample string 1",
  "email": "sample string 2",
  "title": "sample string 3",
  "firstName": "sample string 4",
  "lastName": "sample string 5",
  "message": "sample string 6"
}

text/html

Sample:

{"contract":{"contractId":1,"contractTemplateId":1,"contractURL":"sample string 2","supplierName":"sample string 3","companyName":"sample string 4","fuelType":"sample string 5","commission":6.0,"dateCreated":"2026-01-18T07:24:59.2955494+00:00","docusignGuideRef":"sample string 7","status":"sample string 8","contractStatusId":9,"agentName":"sample string 10","agentId":1,"contractStartDate":"2026-01-18T07:24:59.2955494+00:00","fixedContractEndDate":"2026-01-18T07:24:59.2955494+00:00","channelName":"sample string 11","contactName":"sample string 12","contractEndDate":"2026-01-18T07:24:59.2955494+00:00","quoteId":1,"quoteRaisedDate":"2026-01-18T07:24:59.2955494+00:00","sites":[{"contractId":1,"contractStatusId":2,"siteName":"sample string 3","supplierName":"sample string 4","siteAddress":"sample string 5","status":"sample string 6","consumption":1.0,"sitePostcode":"sample string 7","mpxn":"sample string 8","supplierNotes":"sample string 9","buyerNotes":"sample string 10","meterNotes":"sample string 11","contractDetailId":12,"totalCostExclVat":13.0,"rateType":"Single","standingCharge":1.0,"singleUnitRate":1.0,"dayRate":1.0,"nightRate":1.0,"weekdayRate":1.0,"eveningWeekendRate":1.0,"weekendRate":1.0,"unitConsumption":1,"dayConsumption":1,"nightConsumption":1,"eveningWeekendConsumption":1,"weekdayConsumption":1,"weekendConsumption":1,"dayUnitRate":1.0,"nightUnitRate":1.0,"eveningWeekendUnitRate":1.0,"dayConsumption3Format":1.0,"nightConsumption3Format":1.0,"eveningConsumption3Format":1.0,"hasStandingChargeCommission":true,"isCommissionPercent":true,"instantCommissionPercent":1.0,"contractDuration":64,"totalContractCommission":1.0,"totalContractBrokerCommission":1.0,"totalCommission":1.0,"totalContractAnnualCost":1.0,"contractSigned":"2026-01-18T07:24:59.2955494+00:00"},{"contractId":1,"contractStatusId":2,"siteName":"sample string 3","supplierName":"sample string 4","siteAddress":"sample string 5","status":"sample string 6","consumption":1.0,"sitePostcode":"sample string 7","mpxn":"sample string 8","supplierNotes":"sample string 9","buyerNotes":"sample string 10","meterNotes":"sample string 11","contractDetailId":12,"totalCostExclVat":13.0,"rateType":"Single","standingCharge":1.0,"singleUnitRate":1.0,"dayRate":1.0,"nightRate":1.0,"weekdayRate":1.0,"eveningWeekendRate":1.0,"weekendRate":1.0,"unitConsumption":1,"dayConsumption":1,"nightConsumption":1,"eveningWeekendConsumption":1,"weekdayConsumption":1,"weekendConsumption":1,"dayUnitRate":1.0,"nightUnitRate":1.0,"eveningWeekendUnitRate":1.0,"dayConsumption3Format":1.0,"nightConsumption3Format":1.0,"eveningConsumption3Format":1.0,"hasStandingChargeCommission":true,"isCommissionPercent":true,"instantCommissionPercent":1.0,"contractDuration":64,"totalContractCommission":1.0,"totalContractBrokerCommission":1.0,"totalCommission":1.0,"totalContractAnnualCost":1.0,"contractSigned":"2026-01-18T07:24:59.2955494+00:00"}],"createdBy":"sample string 14","totalContractCommission":1.0,"totalContractBrokerCommission":1.0,"totalCommission":1.0,"totalContractAnnualCost":1.0,"contractSigned":"2026-01-18T07:24:59.2955494+00:00","contractConsumption":1.0,"contractDuration":64},"type":"sample string 1","email":"sample string 2","title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","message":"sample string 6"}

application/xml, text/xml

Sample:

<BrokerHelpQuestion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
  <contract xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.QuoteDto">
    <d2p1:AgentId>1</d2p1:AgentId>
    <d2p1:AgentName>sample string 10</d2p1:AgentName>
    <d2p1:ChannelName>sample string 11</d2p1:ChannelName>
    <d2p1:Commission>6</d2p1:Commission>
    <d2p1:CompanyName>sample string 4</d2p1:CompanyName>
    <d2p1:ContactName>sample string 12</d2p1:ContactName>
    <d2p1:ContractConsumption>1</d2p1:ContractConsumption>
    <d2p1:ContractDuration>64</d2p1:ContractDuration>
    <d2p1:ContractEndDate>2026-01-18T07:24:59.2955494+00:00</d2p1:ContractEndDate>
    <d2p1:ContractId>1</d2p1:ContractId>
    <d2p1:ContractSigned>2026-01-18T07:24:59.2955494+00:00</d2p1:ContractSigned>
    <d2p1:ContractStartDate>2026-01-18T07:24:59.2955494+00:00</d2p1:ContractStartDate>
    <d2p1:ContractStatusId>9</d2p1:ContractStatusId>
    <d2p1:ContractTemplateId>1</d2p1:ContractTemplateId>
    <d2p1:ContractURL>sample string 2</d2p1:ContractURL>
    <d2p1:CreatedBy>sample string 14</d2p1:CreatedBy>
    <d2p1:DateCreated>2026-01-18T07:24:59.2955494+00:00</d2p1:DateCreated>
    <d2p1:DocusignGuideRef>sample string 7</d2p1:DocusignGuideRef>
    <d2p1:FixedContractEndDate>2026-01-18T07:24:59.2955494+00:00</d2p1:FixedContractEndDate>
    <d2p1:FuelType>sample string 5</d2p1:FuelType>
    <d2p1:QuoteId>1</d2p1:QuoteId>
    <d2p1:QuoteRaisedDate>2026-01-18T07:24:59.2955494+00:00</d2p1:QuoteRaisedDate>
    <d2p1:Sites>
      <d2p1:MultiContractSites>
        <d2p1:BuyerNotes>sample string 10</d2p1:BuyerNotes>
        <d2p1:Consumption>1</d2p1:Consumption>
        <d2p1:ContractDetailId>12</d2p1:ContractDetailId>
        <d2p1:ContractDuration>64</d2p1:ContractDuration>
        <d2p1:ContractId>1</d2p1:ContractId>
        <d2p1:ContractSigned>2026-01-18T07:24:59.2955494+00:00</d2p1:ContractSigned>
        <d2p1:ContractStatusId>2</d2p1:ContractStatusId>
        <d2p1:DayConsumption3Format>1</d2p1:DayConsumption3Format>
        <d2p1:DayRate>1</d2p1:DayRate>
        <d2p1:DayUnitRate>1</d2p1:DayUnitRate>
        <d2p1:EveningConsumption3Format>1</d2p1:EveningConsumption3Format>
        <d2p1:EveningWeekendRate>1</d2p1:EveningWeekendRate>
        <d2p1:EveningWeekendUnitRate>1</d2p1:EveningWeekendUnitRate>
        <d2p1:HasStandingChargeCommission>true</d2p1:HasStandingChargeCommission>
        <d2p1:InstantCommissionPercent>1</d2p1:InstantCommissionPercent>
        <d2p1:IsCommissionPercent>true</d2p1:IsCommissionPercent>
        <d2p1:MPXN>sample string 8</d2p1:MPXN>
        <d2p1:MeterNotes>sample string 11</d2p1:MeterNotes>
        <d2p1:NightConsumption3Format>1</d2p1:NightConsumption3Format>
        <d2p1:NightRate>1</d2p1:NightRate>
        <d2p1:NightUnitRate>1</d2p1:NightUnitRate>
        <d2p1:RateType>Single</d2p1:RateType>
        <d2p1:SingleUnitRate>1</d2p1:SingleUnitRate>
        <d2p1:SiteAddress>sample string 5</d2p1:SiteAddress>
        <d2p1:SiteName>sample string 3</d2p1:SiteName>
        <d2p1:SitePostcode>sample string 7</d2p1:SitePostcode>
        <d2p1:Status>sample string 6</d2p1:Status>
        <d2p1:SupplierName>sample string 4</d2p1:SupplierName>
        <d2p1:SupplierNotes>sample string 9</d2p1:SupplierNotes>
        <d2p1:TotalCommission>1</d2p1:TotalCommission>
        <d2p1:TotalContractAnnualCost>1</d2p1:TotalContractAnnualCost>
        <d2p1:TotalContractBrokerCommission>1</d2p1:TotalContractBrokerCommission>
        <d2p1:TotalContractCommission>1</d2p1:TotalContractCommission>
        <d2p1:TotalCostExclVat>13</d2p1:TotalCostExclVat>
        <d2p1:UnitConsumption>1</d2p1:UnitConsumption>
        <d2p1:WeekdayRate>1</d2p1:WeekdayRate>
        <d2p1:WeekendRate>1</d2p1:WeekendRate>
        <d2p1:dayConsumption>1</d2p1:dayConsumption>
        <d2p1:eveningWeekendConsumption>1</d2p1:eveningWeekendConsumption>
        <d2p1:nightConsumption>1</d2p1:nightConsumption>
        <d2p1:standingCharge>1</d2p1:standingCharge>
        <d2p1:weekdayConsumption>1</d2p1:weekdayConsumption>
        <d2p1:weekendConsumption>1</d2p1:weekendConsumption>
      </d2p1:MultiContractSites>
      <d2p1:MultiContractSites>
        <d2p1:BuyerNotes>sample string 10</d2p1:BuyerNotes>
        <d2p1:Consumption>1</d2p1:Consumption>
        <d2p1:ContractDetailId>12</d2p1:ContractDetailId>
        <d2p1:ContractDuration>64</d2p1:ContractDuration>
        <d2p1:ContractId>1</d2p1:ContractId>
        <d2p1:ContractSigned>2026-01-18T07:24:59.2955494+00:00</d2p1:ContractSigned>
        <d2p1:ContractStatusId>2</d2p1:ContractStatusId>
        <d2p1:DayConsumption3Format>1</d2p1:DayConsumption3Format>
        <d2p1:DayRate>1</d2p1:DayRate>
        <d2p1:DayUnitRate>1</d2p1:DayUnitRate>
        <d2p1:EveningConsumption3Format>1</d2p1:EveningConsumption3Format>
        <d2p1:EveningWeekendRate>1</d2p1:EveningWeekendRate>
        <d2p1:EveningWeekendUnitRate>1</d2p1:EveningWeekendUnitRate>
        <d2p1:HasStandingChargeCommission>true</d2p1:HasStandingChargeCommission>
        <d2p1:InstantCommissionPercent>1</d2p1:InstantCommissionPercent>
        <d2p1:IsCommissionPercent>true</d2p1:IsCommissionPercent>
        <d2p1:MPXN>sample string 8</d2p1:MPXN>
        <d2p1:MeterNotes>sample string 11</d2p1:MeterNotes>
        <d2p1:NightConsumption3Format>1</d2p1:NightConsumption3Format>
        <d2p1:NightRate>1</d2p1:NightRate>
        <d2p1:NightUnitRate>1</d2p1:NightUnitRate>
        <d2p1:RateType>Single</d2p1:RateType>
        <d2p1:SingleUnitRate>1</d2p1:SingleUnitRate>
        <d2p1:SiteAddress>sample string 5</d2p1:SiteAddress>
        <d2p1:SiteName>sample string 3</d2p1:SiteName>
        <d2p1:SitePostcode>sample string 7</d2p1:SitePostcode>
        <d2p1:Status>sample string 6</d2p1:Status>
        <d2p1:SupplierName>sample string 4</d2p1:SupplierName>
        <d2p1:SupplierNotes>sample string 9</d2p1:SupplierNotes>
        <d2p1:TotalCommission>1</d2p1:TotalCommission>
        <d2p1:TotalContractAnnualCost>1</d2p1:TotalContractAnnualCost>
        <d2p1:TotalContractBrokerCommission>1</d2p1:TotalContractBrokerCommission>
        <d2p1:TotalContractCommission>1</d2p1:TotalContractCommission>
        <d2p1:TotalCostExclVat>13</d2p1:TotalCostExclVat>
        <d2p1:UnitConsumption>1</d2p1:UnitConsumption>
        <d2p1:WeekdayRate>1</d2p1:WeekdayRate>
        <d2p1:WeekendRate>1</d2p1:WeekendRate>
        <d2p1:dayConsumption>1</d2p1:dayConsumption>
        <d2p1:eveningWeekendConsumption>1</d2p1:eveningWeekendConsumption>
        <d2p1:nightConsumption>1</d2p1:nightConsumption>
        <d2p1:standingCharge>1</d2p1:standingCharge>
        <d2p1:weekdayConsumption>1</d2p1:weekdayConsumption>
        <d2p1:weekendConsumption>1</d2p1:weekendConsumption>
      </d2p1:MultiContractSites>
    </d2p1:Sites>
    <d2p1:Status>sample string 8</d2p1:Status>
    <d2p1:SupplierName>sample string 3</d2p1:SupplierName>
    <d2p1:TotalCommission>1</d2p1:TotalCommission>
    <d2p1:TotalContractAnnualCost>1</d2p1:TotalContractAnnualCost>
    <d2p1:TotalContractBrokerCommission>1</d2p1:TotalContractBrokerCommission>
    <d2p1:TotalContractCommission>1</d2p1:TotalContractCommission>
  </contract>
  <email>sample string 2</email>
  <firstName>sample string 4</firstName>
  <lastName>sample string 5</lastName>
  <message>sample string 6</message>
  <title>sample string 3</title>
  <type>sample string 1</type>
</BrokerHelpQuestion>

Response Information

Resource Description

Collection of ContractRole

Name	Description	Type	Additional information
Id		integer	None.
Name		string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 2"
  },
  {
    "id": 1,
    "name": "sample string 2"
  }
]

text/html

Sample:

[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}]

application/xml, text/xml

Sample:

<ArrayOfContractRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
  <ContractRole>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </ContractRole>
  <ContractRole>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </ContractRole>
</ArrayOfContractRole>