GET request/contract/all
Returns all Contracts info available for logged in user.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
MultiContractList| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | ContractHeader |
None. |
|
| MultiContracts | Collection of MultiContracts |
None. |
Response Formats
application/json, text/json
Sample:
{
"header": {
"gasContractSend": 1,
"electicityContractSend": 2
},
"multiContracts": [
{
"contractId": 1,
"contractTemplateId": 1,
"contractURL": "sample string 2",
"supplierName": "sample string 3",
"companyName": "sample string 4",
"fuelType": "sample string 5",
"commission": 6.0,
"dateCreated": "2025-06-28T03:23:10.8309128+00:00",
"docusignGuideRef": "sample string 7",
"status": "sample string 8",
"contractStatusId": 9,
"agentName": "sample string 10",
"contractStartDate": "2025-06-28T03:23:10.8309128+00:00",
"fixedContractEndDate": "2025-06-28T03:23:10.8309128+00:00",
"channelName": "sample string 11",
"contactName": "sample string 12",
"contractEndDate": "2025-06-28T03:23:10.8309128+00:00",
"quoteId": 1,
"quoteRaisedDate": "2025-06-28T03:23:10.8309128+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
},
{
"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
}
],
"createdBy": "sample string 14"
},
{
"contractId": 1,
"contractTemplateId": 1,
"contractURL": "sample string 2",
"supplierName": "sample string 3",
"companyName": "sample string 4",
"fuelType": "sample string 5",
"commission": 6.0,
"dateCreated": "2025-06-28T03:23:10.8309128+00:00",
"docusignGuideRef": "sample string 7",
"status": "sample string 8",
"contractStatusId": 9,
"agentName": "sample string 10",
"contractStartDate": "2025-06-28T03:23:10.8309128+00:00",
"fixedContractEndDate": "2025-06-28T03:23:10.8309128+00:00",
"channelName": "sample string 11",
"contactName": "sample string 12",
"contractEndDate": "2025-06-28T03:23:10.8309128+00:00",
"quoteId": 1,
"quoteRaisedDate": "2025-06-28T03:23:10.8309128+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
},
{
"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
}
],
"createdBy": "sample string 14"
}
]
}
text/html
Sample:
{"header":{"gasContractSend":1,"electicityContractSend":2},"multiContracts":[{"contractId":1,"contractTemplateId":1,"contractURL":"sample string 2","supplierName":"sample string 3","companyName":"sample string 4","fuelType":"sample string 5","commission":6.0,"dateCreated":"2025-06-28T03:23:10.8309128+00:00","docusignGuideRef":"sample string 7","status":"sample string 8","contractStatusId":9,"agentName":"sample string 10","contractStartDate":"2025-06-28T03:23:10.8309128+00:00","fixedContractEndDate":"2025-06-28T03:23:10.8309128+00:00","channelName":"sample string 11","contactName":"sample string 12","contractEndDate":"2025-06-28T03:23:10.8309128+00:00","quoteId":1,"quoteRaisedDate":"2025-06-28T03:23:10.8309128+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},{"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}],"createdBy":"sample string 14"},{"contractId":1,"contractTemplateId":1,"contractURL":"sample string 2","supplierName":"sample string 3","companyName":"sample string 4","fuelType":"sample string 5","commission":6.0,"dateCreated":"2025-06-28T03:23:10.8309128+00:00","docusignGuideRef":"sample string 7","status":"sample string 8","contractStatusId":9,"agentName":"sample string 10","contractStartDate":"2025-06-28T03:23:10.8309128+00:00","fixedContractEndDate":"2025-06-28T03:23:10.8309128+00:00","channelName":"sample string 11","contactName":"sample string 12","contractEndDate":"2025-06-28T03:23:10.8309128+00:00","quoteId":1,"quoteRaisedDate":"2025-06-28T03:23:10.8309128+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},{"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}],"createdBy":"sample string 14"}]}
application/xml, text/xml
Sample:
<MultiContractList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.QuoteDto">
<Header>
<ElecticityContractSend>2</ElecticityContractSend>
<GasContractSend>1</GasContractSend>
</Header>
<MultiContracts>
<MultiContracts>
<AgentName>sample string 10</AgentName>
<ChannelName>sample string 11</ChannelName>
<Commission>6</Commission>
<CompanyName>sample string 4</CompanyName>
<ContactName>sample string 12</ContactName>
<ContractEndDate>2025-06-28T03:23:10.8309128+00:00</ContractEndDate>
<ContractId>1</ContractId>
<ContractStartDate>2025-06-28T03:23:10.8309128+00:00</ContractStartDate>
<ContractStatusId>9</ContractStatusId>
<ContractTemplateId>1</ContractTemplateId>
<ContractURL>sample string 2</ContractURL>
<CreatedBy>sample string 14</CreatedBy>
<DateCreated>2025-06-28T03:23:10.8309128+00:00</DateCreated>
<DocusignGuideRef>sample string 7</DocusignGuideRef>
<FixedContractEndDate>2025-06-28T03:23:10.8309128+00:00</FixedContractEndDate>
<FuelType>sample string 5</FuelType>
<QuoteId>1</QuoteId>
<QuoteRaisedDate>2025-06-28T03:23:10.8309128+00:00</QuoteRaisedDate>
<Sites>
<MultiContractSites>
<BuyerNotes>sample string 10</BuyerNotes>
<Consumption>1</Consumption>
<ContractDetailId>12</ContractDetailId>
<ContractId>1</ContractId>
<ContractStatusId>2</ContractStatusId>
<DayConsumption3Format>1</DayConsumption3Format>
<DayRate>1</DayRate>
<DayUnitRate>1</DayUnitRate>
<EveningConsumption3Format>1</EveningConsumption3Format>
<EveningWeekendRate>1</EveningWeekendRate>
<EveningWeekendUnitRate>1</EveningWeekendUnitRate>
<MPXN>sample string 8</MPXN>
<MeterNotes>sample string 11</MeterNotes>
<NightConsumption3Format>1</NightConsumption3Format>
<NightRate>1</NightRate>
<NightUnitRate>1</NightUnitRate>
<RateType>Single</RateType>
<SingleUnitRate>1</SingleUnitRate>
<SiteAddress>sample string 5</SiteAddress>
<SiteName>sample string 3</SiteName>
<SitePostcode>sample string 7</SitePostcode>
<Status>sample string 6</Status>
<SupplierName>sample string 4</SupplierName>
<SupplierNotes>sample string 9</SupplierNotes>
<TotalCostExclVat>13</TotalCostExclVat>
<UnitConsumption>1</UnitConsumption>
<WeekdayRate>1</WeekdayRate>
<WeekendRate>1</WeekendRate>
<dayConsumption>1</dayConsumption>
<eveningWeekendConsumption>1</eveningWeekendConsumption>
<nightConsumption>1</nightConsumption>
<standingCharge>1</standingCharge>
<weekdayConsumption>1</weekdayConsumption>
<weekendConsumption>1</weekendConsumption>
</MultiContractSites>
<MultiContractSites>
<BuyerNotes>sample string 10</BuyerNotes>
<Consumption>1</Consumption>
<ContractDetailId>12</ContractDetailId>
<ContractId>1</ContractId>
<ContractStatusId>2</ContractStatusId>
<DayConsumption3Format>1</DayConsumption3Format>
<DayRate>1</DayRate>
<DayUnitRate>1</DayUnitRate>
<EveningConsumption3Format>1</EveningConsumption3Format>
<EveningWeekendRate>1</EveningWeekendRate>
<EveningWeekendUnitRate>1</EveningWeekendUnitRate>
<MPXN>sample string 8</MPXN>
<MeterNotes>sample string 11</MeterNotes>
<NightConsumption3Format>1</NightConsumption3Format>
<NightRate>1</NightRate>
<NightUnitRate>1</NightUnitRate>
<RateType>Single</RateType>
<SingleUnitRate>1</SingleUnitRate>
<SiteAddress>sample string 5</SiteAddress>
<SiteName>sample string 3</SiteName>
<SitePostcode>sample string 7</SitePostcode>
<Status>sample string 6</Status>
<SupplierName>sample string 4</SupplierName>
<SupplierNotes>sample string 9</SupplierNotes>
<TotalCostExclVat>13</TotalCostExclVat>
<UnitConsumption>1</UnitConsumption>
<WeekdayRate>1</WeekdayRate>
<WeekendRate>1</WeekendRate>
<dayConsumption>1</dayConsumption>
<eveningWeekendConsumption>1</eveningWeekendConsumption>
<nightConsumption>1</nightConsumption>
<standingCharge>1</standingCharge>
<weekdayConsumption>1</weekdayConsumption>
<weekendConsumption>1</weekendConsumption>
</MultiContractSites>
</Sites>
<Status>sample string 8</Status>
<SupplierName>sample string 3</SupplierName>
</MultiContracts>
<MultiContracts>
<AgentName>sample string 10</AgentName>
<ChannelName>sample string 11</ChannelName>
<Commission>6</Commission>
<CompanyName>sample string 4</CompanyName>
<ContactName>sample string 12</ContactName>
<ContractEndDate>2025-06-28T03:23:10.8309128+00:00</ContractEndDate>
<ContractId>1</ContractId>
<ContractStartDate>2025-06-28T03:23:10.8309128+00:00</ContractStartDate>
<ContractStatusId>9</ContractStatusId>
<ContractTemplateId>1</ContractTemplateId>
<ContractURL>sample string 2</ContractURL>
<CreatedBy>sample string 14</CreatedBy>
<DateCreated>2025-06-28T03:23:10.8309128+00:00</DateCreated>
<DocusignGuideRef>sample string 7</DocusignGuideRef>
<FixedContractEndDate>2025-06-28T03:23:10.8309128+00:00</FixedContractEndDate>
<FuelType>sample string 5</FuelType>
<QuoteId>1</QuoteId>
<QuoteRaisedDate>2025-06-28T03:23:10.8309128+00:00</QuoteRaisedDate>
<Sites>
<MultiContractSites>
<BuyerNotes>sample string 10</BuyerNotes>
<Consumption>1</Consumption>
<ContractDetailId>12</ContractDetailId>
<ContractId>1</ContractId>
<ContractStatusId>2</ContractStatusId>
<DayConsumption3Format>1</DayConsumption3Format>
<DayRate>1</DayRate>
<DayUnitRate>1</DayUnitRate>
<EveningConsumption3Format>1</EveningConsumption3Format>
<EveningWeekendRate>1</EveningWeekendRate>
<EveningWeekendUnitRate>1</EveningWeekendUnitRate>
<MPXN>sample string 8</MPXN>
<MeterNotes>sample string 11</MeterNotes>
<NightConsumption3Format>1</NightConsumption3Format>
<NightRate>1</NightRate>
<NightUnitRate>1</NightUnitRate>
<RateType>Single</RateType>
<SingleUnitRate>1</SingleUnitRate>
<SiteAddress>sample string 5</SiteAddress>
<SiteName>sample string 3</SiteName>
<SitePostcode>sample string 7</SitePostcode>
<Status>sample string 6</Status>
<SupplierName>sample string 4</SupplierName>
<SupplierNotes>sample string 9</SupplierNotes>
<TotalCostExclVat>13</TotalCostExclVat>
<UnitConsumption>1</UnitConsumption>
<WeekdayRate>1</WeekdayRate>
<WeekendRate>1</WeekendRate>
<dayConsumption>1</dayConsumption>
<eveningWeekendConsumption>1</eveningWeekendConsumption>
<nightConsumption>1</nightConsumption>
<standingCharge>1</standingCharge>
<weekdayConsumption>1</weekdayConsumption>
<weekendConsumption>1</weekendConsumption>
</MultiContractSites>
<MultiContractSites>
<BuyerNotes>sample string 10</BuyerNotes>
<Consumption>1</Consumption>
<ContractDetailId>12</ContractDetailId>
<ContractId>1</ContractId>
<ContractStatusId>2</ContractStatusId>
<DayConsumption3Format>1</DayConsumption3Format>
<DayRate>1</DayRate>
<DayUnitRate>1</DayUnitRate>
<EveningConsumption3Format>1</EveningConsumption3Format>
<EveningWeekendRate>1</EveningWeekendRate>
<EveningWeekendUnitRate>1</EveningWeekendUnitRate>
<MPXN>sample string 8</MPXN>
<MeterNotes>sample string 11</MeterNotes>
<NightConsumption3Format>1</NightConsumption3Format>
<NightRate>1</NightRate>
<NightUnitRate>1</NightUnitRate>
<RateType>Single</RateType>
<SingleUnitRate>1</SingleUnitRate>
<SiteAddress>sample string 5</SiteAddress>
<SiteName>sample string 3</SiteName>
<SitePostcode>sample string 7</SitePostcode>
<Status>sample string 6</Status>
<SupplierName>sample string 4</SupplierName>
<SupplierNotes>sample string 9</SupplierNotes>
<TotalCostExclVat>13</TotalCostExclVat>
<UnitConsumption>1</UnitConsumption>
<WeekdayRate>1</WeekdayRate>
<WeekendRate>1</WeekendRate>
<dayConsumption>1</dayConsumption>
<eveningWeekendConsumption>1</eveningWeekendConsumption>
<nightConsumption>1</nightConsumption>
<standingCharge>1</standingCharge>
<weekdayConsumption>1</weekdayConsumption>
<weekendConsumption>1</weekendConsumption>
</MultiContractSites>
</Sites>
<Status>sample string 8</Status>
<SupplierName>sample string 3</SupplierName>
</MultiContracts>
</MultiContracts>
</MultiContractList>