GET request/contract/live

Provides Live Contracts information

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ContractsInProgress

Name	Type	Additional information
BrandId	integer	None.
BrandName	string	None.
Buyer	string	None.
Commission	decimal number	None.
ContractConsumption	decimal number	None.
ContractId	integer	None.
ContractTemplateId	integer	None.
ContractURL	string	None.
CreatedDate	date	None.
DateSigned	date	None.
FormattedDateSigned	string	None.
FuelId	byte	None.
FuelTypeId	byte	None.
IsBespokeQuote	boolean	None.
JourneyStatusRefId	integer	None.
MeterDetailsList	Collection of MeterDetails	None.
MeterNotes	string	None.
MpanMprn	string	None.
NoOfSites	integer	None.
QuoteType	string	None.
ShowOwnersDetails	boolean	None.
SignedContractUrl	string	None.
SignedSummaryContractUrl	string	None.
SiteAddress	string	None.
SiteName	string	None.
StartDate	date	None.
Status	string	None.
StatusId	integer	None.
SupplierId	byte	None.
SupplierName	string	None.
Type	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "contractId": 1,
    "contractTemplateId": 1,
    "journeyStatusRefId": 1,
    "siteName": "sample string 1",
    "fuelTypeId": 64,
    "supplierId": 64,
    "supplierName": "sample string 3",
    "siteAddress": "sample string 4",
    "commission": 1.0,
    "contractURL": "sample string 5",
    "meterNotes": "sample string 6",
    "mpanMprn": "sample string 7",
    "fuelId": 64,
    "createdDate": "2025-07-02T16:30:51.0213754+00:00",
    "dateSigned": "2025-07-02T16:30:51.0213754+00:00",
    "formattedDateSigned": "sample string 8",
    "buyer": "sample string 9",
    "startDate": "2025-07-02T16:30:51.0213754+00:00",
    "quoteType": "sample string 10",
    "noOfSites": 11,
    "statusId": 12,
    "status": "sample string 13",
    "signedContractUrl": "sample string 14",
    "signedSummaryContractUrl": "sample string 15",
    "type": "sample string 16",
    "isBespokeQuote": true,
    "showOwnersDetails": true,
    "brandId": 18,
    "brandName": "sample string 19",
    "meterDetailsList": [
      {
        "siteName": "sample string 1",
        "mpanMprn": "sample string 2",
        "resultId": 1,
        "statusId": 1,
        "status": "sample string 3",
        "contractId": 1,
        "quoteId": 4,
        "type": "sample string 5",
        "contractDetailId": 1,
        "dayConsumption": 1,
        "nightConsumption": 1,
        "otherConsumption": 1,
        "contractStartDate": "2025-07-02T16:30:51.0213754+00:00"
      },
      {
        "siteName": "sample string 1",
        "mpanMprn": "sample string 2",
        "resultId": 1,
        "statusId": 1,
        "status": "sample string 3",
        "contractId": 1,
        "quoteId": 4,
        "type": "sample string 5",
        "contractDetailId": 1,
        "dayConsumption": 1,
        "nightConsumption": 1,
        "otherConsumption": 1,
        "contractStartDate": "2025-07-02T16:30:51.0213754+00:00"
      }
    ],
    "contractConsumption": 20.0
  },
  {
    "contractId": 1,
    "contractTemplateId": 1,
    "journeyStatusRefId": 1,
    "siteName": "sample string 1",
    "fuelTypeId": 64,
    "supplierId": 64,
    "supplierName": "sample string 3",
    "siteAddress": "sample string 4",
    "commission": 1.0,
    "contractURL": "sample string 5",
    "meterNotes": "sample string 6",
    "mpanMprn": "sample string 7",
    "fuelId": 64,
    "createdDate": "2025-07-02T16:30:51.0213754+00:00",
    "dateSigned": "2025-07-02T16:30:51.0213754+00:00",
    "formattedDateSigned": "sample string 8",
    "buyer": "sample string 9",
    "startDate": "2025-07-02T16:30:51.0213754+00:00",
    "quoteType": "sample string 10",
    "noOfSites": 11,
    "statusId": 12,
    "status": "sample string 13",
    "signedContractUrl": "sample string 14",
    "signedSummaryContractUrl": "sample string 15",
    "type": "sample string 16",
    "isBespokeQuote": true,
    "showOwnersDetails": true,
    "brandId": 18,
    "brandName": "sample string 19",
    "meterDetailsList": [
      {
        "siteName": "sample string 1",
        "mpanMprn": "sample string 2",
        "resultId": 1,
        "statusId": 1,
        "status": "sample string 3",
        "contractId": 1,
        "quoteId": 4,
        "type": "sample string 5",
        "contractDetailId": 1,
        "dayConsumption": 1,
        "nightConsumption": 1,
        "otherConsumption": 1,
        "contractStartDate": "2025-07-02T16:30:51.0213754+00:00"
      },
      {
        "siteName": "sample string 1",
        "mpanMprn": "sample string 2",
        "resultId": 1,
        "statusId": 1,
        "status": "sample string 3",
        "contractId": 1,
        "quoteId": 4,
        "type": "sample string 5",
        "contractDetailId": 1,
        "dayConsumption": 1,
        "nightConsumption": 1,
        "otherConsumption": 1,
        "contractStartDate": "2025-07-02T16:30:51.0213754+00:00"
      }
    ],
    "contractConsumption": 20.0
  }
]

text/html

Sample:

[{"contractId":1,"contractTemplateId":1,"journeyStatusRefId":1,"siteName":"sample string 1","fuelTypeId":64,"supplierId":64,"supplierName":"sample string 3","siteAddress":"sample string 4","commission":1.0,"contractURL":"sample string 5","meterNotes":"sample string 6","mpanMprn":"sample string 7","fuelId":64,"createdDate":"2025-07-02T16:30:51.0213754+00:00","dateSigned":"2025-07-02T16:30:51.0213754+00:00","formattedDateSigned":"sample string 8","buyer":"sample string 9","startDate":"2025-07-02T16:30:51.0213754+00:00","quoteType":"sample string 10","noOfSites":11,"statusId":12,"status":"sample string 13","signedContractUrl":"sample string 14","signedSummaryContractUrl":"sample string 15","type":"sample string 16","isBespokeQuote":true,"showOwnersDetails":true,"brandId":18,"brandName":"sample string 19","meterDetailsList":[{"siteName":"sample string 1","mpanMprn":"sample string 2","resultId":1,"statusId":1,"status":"sample string 3","contractId":1,"quoteId":4,"type":"sample string 5","contractDetailId":1,"dayConsumption":1,"nightConsumption":1,"otherConsumption":1,"contractStartDate":"2025-07-02T16:30:51.0213754+00:00"},{"siteName":"sample string 1","mpanMprn":"sample string 2","resultId":1,"statusId":1,"status":"sample string 3","contractId":1,"quoteId":4,"type":"sample string 5","contractDetailId":1,"dayConsumption":1,"nightConsumption":1,"otherConsumption":1,"contractStartDate":"2025-07-02T16:30:51.0213754+00:00"}],"contractConsumption":20.0},{"contractId":1,"contractTemplateId":1,"journeyStatusRefId":1,"siteName":"sample string 1","fuelTypeId":64,"supplierId":64,"supplierName":"sample string 3","siteAddress":"sample string 4","commission":1.0,"contractURL":"sample string 5","meterNotes":"sample string 6","mpanMprn":"sample string 7","fuelId":64,"createdDate":"2025-07-02T16:30:51.0213754+00:00","dateSigned":"2025-07-02T16:30:51.0213754+00:00","formattedDateSigned":"sample string 8","buyer":"sample string 9","startDate":"2025-07-02T16:30:51.0213754+00:00","quoteType":"sample string 10","noOfSites":11,"statusId":12,"status":"sample string 13","signedContractUrl":"sample string 14","signedSummaryContractUrl":"sample string 15","type":"sample string 16","isBespokeQuote":true,"showOwnersDetails":true,"brandId":18,"brandName":"sample string 19","meterDetailsList":[{"siteName":"sample string 1","mpanMprn":"sample string 2","resultId":1,"statusId":1,"status":"sample string 3","contractId":1,"quoteId":4,"type":"sample string 5","contractDetailId":1,"dayConsumption":1,"nightConsumption":1,"otherConsumption":1,"contractStartDate":"2025-07-02T16:30:51.0213754+00:00"},{"siteName":"sample string 1","mpanMprn":"sample string 2","resultId":1,"statusId":1,"status":"sample string 3","contractId":1,"quoteId":4,"type":"sample string 5","contractDetailId":1,"dayConsumption":1,"nightConsumption":1,"otherConsumption":1,"contractStartDate":"2025-07-02T16:30:51.0213754+00:00"}],"contractConsumption":20.0}]

application/xml, text/xml

Sample:

<ArrayOfContractsInProgress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.CustomerUpdate">
  <ContractsInProgress>
    <BrandId>18</BrandId>
    <BrandName>sample string 19</BrandName>
    <Buyer>sample string 9</Buyer>
    <Commission>1</Commission>
    <ContractConsumption>20</ContractConsumption>
    <ContractId>1</ContractId>
    <ContractTemplateId>1</ContractTemplateId>
    <ContractURL>sample string 5</ContractURL>
    <CreatedDate>2025-07-02T16:30:51.0213754+00:00</CreatedDate>
    <DateSigned>2025-07-02T16:30:51.0213754+00:00</DateSigned>
    <FormattedDateSigned>sample string 8</FormattedDateSigned>
    <FuelId>64</FuelId>
    <FuelTypeId>64</FuelTypeId>
    <IsBespokeQuote>true</IsBespokeQuote>
    <JourneyStatusRefId>1</JourneyStatusRefId>
    <MeterDetailsList>
      <MeterDetails>
        <ContractDetailId>1</ContractDetailId>
        <ContractId>1</ContractId>
        <ContractStartDate>2025-07-02T16:30:51.0213754+00:00</ContractStartDate>
        <DayConsumption>1</DayConsumption>
        <MpanMprn>sample string 2</MpanMprn>
        <NightConsumption>1</NightConsumption>
        <OtherConsumption>1</OtherConsumption>
        <QuoteId>4</QuoteId>
        <ResultId>1</ResultId>
        <SiteName>sample string 1</SiteName>
        <Status>sample string 3</Status>
        <StatusId>1</StatusId>
        <Type>sample string 5</Type>
      </MeterDetails>
      <MeterDetails>
        <ContractDetailId>1</ContractDetailId>
        <ContractId>1</ContractId>
        <ContractStartDate>2025-07-02T16:30:51.0213754+00:00</ContractStartDate>
        <DayConsumption>1</DayConsumption>
        <MpanMprn>sample string 2</MpanMprn>
        <NightConsumption>1</NightConsumption>
        <OtherConsumption>1</OtherConsumption>
        <QuoteId>4</QuoteId>
        <ResultId>1</ResultId>
        <SiteName>sample string 1</SiteName>
        <Status>sample string 3</Status>
        <StatusId>1</StatusId>
        <Type>sample string 5</Type>
      </MeterDetails>
    </MeterDetailsList>
    <MeterNotes>sample string 6</MeterNotes>
    <MpanMprn>sample string 7</MpanMprn>
    <NoOfSites>11</NoOfSites>
    <QuoteType>sample string 10</QuoteType>
    <ShowOwnersDetails>true</ShowOwnersDetails>
    <SignedContractUrl>sample string 14</SignedContractUrl>
    <SignedSummaryContractUrl>sample string 15</SignedSummaryContractUrl>
    <SiteAddress>sample string 4</SiteAddress>
    <SiteName>sample string 1</SiteName>
    <StartDate>2025-07-02T16:30:51.0213754+00:00</StartDate>
    <Status>sample string 13</Status>
    <StatusId>12</StatusId>
    <SupplierId>64</SupplierId>
    <SupplierName>sample string 3</SupplierName>
    <Type>sample string 16</Type>
  </ContractsInProgress>
  <ContractsInProgress>
    <BrandId>18</BrandId>
    <BrandName>sample string 19</BrandName>
    <Buyer>sample string 9</Buyer>
    <Commission>1</Commission>
    <ContractConsumption>20</ContractConsumption>
    <ContractId>1</ContractId>
    <ContractTemplateId>1</ContractTemplateId>
    <ContractURL>sample string 5</ContractURL>
    <CreatedDate>2025-07-02T16:30:51.0213754+00:00</CreatedDate>
    <DateSigned>2025-07-02T16:30:51.0213754+00:00</DateSigned>
    <FormattedDateSigned>sample string 8</FormattedDateSigned>
    <FuelId>64</FuelId>
    <FuelTypeId>64</FuelTypeId>
    <IsBespokeQuote>true</IsBespokeQuote>
    <JourneyStatusRefId>1</JourneyStatusRefId>
    <MeterDetailsList>
      <MeterDetails>
        <ContractDetailId>1</ContractDetailId>
        <ContractId>1</ContractId>
        <ContractStartDate>2025-07-02T16:30:51.0213754+00:00</ContractStartDate>
        <DayConsumption>1</DayConsumption>
        <MpanMprn>sample string 2</MpanMprn>
        <NightConsumption>1</NightConsumption>
        <OtherConsumption>1</OtherConsumption>
        <QuoteId>4</QuoteId>
        <ResultId>1</ResultId>
        <SiteName>sample string 1</SiteName>
        <Status>sample string 3</Status>
        <StatusId>1</StatusId>
        <Type>sample string 5</Type>
      </MeterDetails>
      <MeterDetails>
        <ContractDetailId>1</ContractDetailId>
        <ContractId>1</ContractId>
        <ContractStartDate>2025-07-02T16:30:51.0213754+00:00</ContractStartDate>
        <DayConsumption>1</DayConsumption>
        <MpanMprn>sample string 2</MpanMprn>
        <NightConsumption>1</NightConsumption>
        <OtherConsumption>1</OtherConsumption>
        <QuoteId>4</QuoteId>
        <ResultId>1</ResultId>
        <SiteName>sample string 1</SiteName>
        <Status>sample string 3</Status>
        <StatusId>1</StatusId>
        <Type>sample string 5</Type>
      </MeterDetails>
    </MeterDetailsList>
    <MeterNotes>sample string 6</MeterNotes>
    <MpanMprn>sample string 7</MpanMprn>
    <NoOfSites>11</NoOfSites>
    <QuoteType>sample string 10</QuoteType>
    <ShowOwnersDetails>true</ShowOwnersDetails>
    <SignedContractUrl>sample string 14</SignedContractUrl>
    <SignedSummaryContractUrl>sample string 15</SignedSummaryContractUrl>
    <SiteAddress>sample string 4</SiteAddress>
    <SiteName>sample string 1</SiteName>
    <StartDate>2025-07-02T16:30:51.0213754+00:00</StartDate>
    <Status>sample string 13</Status>
    <StatusId>12</StatusId>
    <SupplierId>64</SupplierId>
    <SupplierName>sample string 3</SupplierName>
    <Type>sample string 16</Type>
  </ContractsInProgress>
</ArrayOfContractsInProgress>