Documentation

Address

Get addresses from national database

API	Description
GET request/Address/recco/company?postcode={postcode}&fuelTypeId={fuelTypeId}	Gets Address from REC Ecoes and Xoserve for a particular Postcode
GET request/Address/recco/noauth?postcode={postcode}&fuelTypeId={fuelTypeId}	No documentation available.
GET request/Address/recco/search/mpxn?fuelTypeId={fuelTypeId}&mpan={mpan}&mprn={mprn}	No documentation available.
GET request/Address/recco?postcode={postcode}&fuelTypeId={fuelTypeId}	Gets Address from REC Ecoes and Xoserve for a particular Postcode
POST request/Address/recco/details	Gets Address and MeterDetails from Ecoes and Xoserve for a Mpancore or AddressCode
POST request/Address/recco/details/noauth	No documentation available.

Bank

Provides verification of Bank details for a switch

API	Description
GET request/Bank/Is-Valid/noauth?sortCode={sortCode}&accountNumber={accountNumber}	Validates provided bank details information
GET request/Bank/Is-Valid?sortCode={sortCode}&accountNumber={accountNumber}	Validates provided bank details information

Brand

API	Description
DELETE request/brand/{brandid}	No documentation available.
GET request/brand/parent/all	No documentation available.
POST request/brand/admin	No documentation available.
PUT request/brand/{brandid}	No documentation available.

Company

Provides information about company

API	Description
POST request/Company/experian/creditinfo	No documentation available.
POST request/Company/experian/creditinfoandreport	No documentation available.
POST request/Company/experian/noauth/search	No documentation available.
POST request/Company/experian/search	Search company by name,Registration number or Postcode and provides all information about the company by using ExperianApi
POST request/Company/Query/Name/v2	Returns info about companies with a specific name
POST request/Company/Query/Registration-Number/v2	Returns info about companies with a company registration number.

Comparison

API	Description
POST request/Comparison/Results	Provides a comparison of ALL possible energy plans that a business could potentially switch to.

Contract

Provides contract information

API	Description
DELETE request/contract/{id}/audio	Delete Verbal Audio file for given contract Id
GET request/contract	Returns all Contracts info available for logged in user.
GET request/contract/{Id}	Returns a specific Contract information
GET request/contract/{Id}/byid	Returns a specific Contract information for MultiMeter
GET request/contract/{Id}/details	Returns a specific Contract with commission information
GET request/contract/all	Returns all Contracts info available for logged in user.
GET request/contract/esign/precontract?Id={Id}	Returns a specific Contract information in the precontract for esign for old single quote
GET request/contract/esign/url?Id={Id}	Send Docusign URL for contracts
GET request/contract/precontract/esign/url?Id={Id}&SmartInstallationDate={SmartInstallationDate}&SmartInstallationTime={SmartInstallationTime}	No documentation available.
GET request/contract/precontract/esign?Id={Id}	Returns a specific PreContract information for esign contract for new quotemerge(single and Multi)
GET request/contract/precontract/update?Id={Id}&docusignStatus={docusignStatus}	Returns a specific Contract information
GET request/contract/update?Id={Id}&docusignStatus={docusignStatus}	Returns a specific Contract information
GET request/contract/user/{userId}	Returns all Contracts info available for specific user(Only single meter).
GET request/contract/user/{userId}/all	Returns all Contracts information available for the logged in user.
POST request/contract	Add Contract information
POST request/contract/{id}/audio/upload	Uploads any Verbal Audio file
POST request/contract/{id}/submit/upload	Uploads the Signed Multimeter Contract to Azure
POST request/contract/{Id}/survey	Creates Buyer Survey Responses
POST request/contract/{id}/upload	Uploads the Signed Contract to Azure
POST request/contract/contactrole	Add Multi contract roles like signatory or partner
POST request/contract/email/generate	Contract details to send by Email
POST request/contract/esign/generate	Send Docusign URL for contracts ---------- docusignNow
POST request/contract/esign/precontract/payment	Update docusign Payment details
POST request/contract/esignemail/generate	Send Portal Docusign URL for contracts
POST request/contract/precontract	Generates precontract details for both single and Multi site meters for a particular quoteId
POST request/contract/precontract/email/generate	Contract details to send by Email for single and multiple sites(confirm with Email Option)
POST request/contract/precontract/esign/generate	Send Docusign URL for contracts ---------- docusignNow
POST request/contract/precontract/esign/payment	Update docusign precontract Payment details
POST request/contract/precontract/esignemail/generate	Send the portal Docusign URL through Email for contracts(both single and Multiple sites - confirmDocusignWithEmail Option)
POST request/contract/precontract/print/generate	Generates contract PDF for single and Multi sites (ConfirmWithDownload Option)
POST request/contract/print/generate	Print Contract details
POST request/contract/rolepost	Add contract roles like signatory or partner
POST request/contract/submit	Contract is submitted(Status - 100) if ContractPreference is either Batchfile or API
POST request/contract/verbal/generate	Contract details to send by Email
PUT request/contract/{id}/status	Updates the contract status for single or multi meter contract
PUT request/contract/{id}/update/status	Gets the Contract status History
PUT request/contract/update	Update Contract information

Customer

Provide all information about company

API	Description
DELETE request/customer/{customerId}	Delete a specific customer company
DELETE request/customer/{CustomerId}/contact/{ContactId}	Delete a specific company details
DELETE request/customer/{customerId}/document/{documentId}	Delete a particular company's document.
DELETE request/customer/{CustomerId}/electric/bespoke/{BespokeId}/document/{DocumentId}	Delete Electricity tender document
DELETE request/customer/{CustomerId}/gas/bespoke/{BespokeId}/document/{DocumentId}	Delete Gas tender document
DELETE request/customer/{CustomerId}/note/{NoteId}	Delete a specific company notes.
DELETE request/customer/{customerId}/quote/{QuoteId}/manualtariff/{TariffId}	Delete all the Manual Prices for a quote for a particular Tariff
DELETE request/customer/{CustomerId}/site/{SiteId}	Delete a specific customer site
DELETE request/customer/{CustomerId}/site/{SiteId}/contact/{ContactId}	Delete a particular site contact
DELETE request/customer/{customerId}/site/{siteId}/document/{documentId}	Delete specific documents of customer's company site
DELETE request/customer/{CustomerId}/site/{SiteId}/meter/electric/{MeterId}	Delete Customer Site's Electric meter information
DELETE request/customer/{CustomerId}/site/{SiteId}/meter/gas/{MeterId}	Delete Customer Site's Gas meter information
DELETE request/customer/{CustomerId}/site/{SiteId}/note/{NoteId}	Delete a specific customer site notes
DELETE request/customer/quote/{QuoteId}	Deletes any particular Multiple Quote
DELETE request/customer/quote/all	Deletes requested Multiple Quotes
GET request/customer/{customerId}	Displays specific customer's company information
GET request/customer/{CustomerId}/bespoke/{bespokeQuoteId}/electric	No documentation available.
GET request/customer/{CustomerId}/bespoke/{bespokeQuoteId}/gas	No documentation available.
GET request/customer/{customerId}/commission	Provides a specific company commision
GET request/customer/{CustomerId}/contact/{ContactId}	Provides a specific company's particular Contact information
GET request/customer/{CustomerId}/contact/main	Get a specific company's main contact information
GET request/customer/{CustomerId}/contacts	Get a specific Company's all contact information
GET request/customer/{customerId}/creditreport/exist	Credit report exists for specific cucstomer
GET request/customer/{customerId}/document/{documentId}	Provides a specific company's particular documents.
GET request/customer/{customerId}/documents	Provides specific company's all documents
GET request/customer/{customerId}/meter/{meterId}/uplift/list	Display a specific customer's company summary
GET request/customer/{CustomerId}/multiquote/electricity/create	Get Multiple site Electricity Quote customers meters get
GET request/customer/{CustomerId}/multiquote/gas/create	Get Multiple site Gas Quote customers meters get
GET request/customer/{CustomerId}/note/{NoteId}	Get a specific note about that company
GET request/customer/{CustomerId}/notes	Get all notes of that company
GET request/customer/{CustomerId}/ownersdetails	Get a specific Company's Owner contact and address information
GET request/customer/{customerId}/payment	Displays a specific customer's company payment details
GET request/customer/{customerId}/quote/{QuoteId}/manualtariff	Displays all the Manual Prices for a quote for a particular Tariff
GET request/customer/{CustomerId}/site/{SiteId}	Get a specific customer site information
GET request/customer/{CustomerId}/site/{SiteId}/contact/{ContactId}	Display company's a specific site contacts
GET request/customer/{CustomerId}/Site/{SiteId}/contact/main	Display company's main site contacts
GET request/customer/{CustomerId}/site/{SiteId}/contacts	Display company's all site contacts
GET request/customer/{CustomerId}/site/{SiteId}/copybillingoption	Display a specific customer site billing information
GET request/customer/{customerId}/site/{siteId}/document/{documentId}	Display specific documents of customer's company site
GET request/customer/{customerId}/site/{siteId}/documents	Display documents of a particular customer's company site
GET request/customer/{CustomerId}/site/{SiteId}/meter/{MeterId}/isquickquote	Display Customer Site's specific Gas meter information
GET request/customer/{CustomerId}/site/{SiteId}/meter/electric	No documentation available.
GET request/customer/{CustomerId}/site/{SiteId}/meter/electric/{MeterId}	Display Customer Site's specific Electric meter information
GET request/customer/{CustomerId}/site/{SiteId}/meter/electric/{MeterId}/carbonintensity	Get Carbon Intesity of the specific school meter
GET request/customer/{CustomerId}/site/{SiteId}/meter/electric/{MeterId}/commission	Display Customer Site's specific Gas meter commission
GET request/customer/{CustomerId}/site/{SiteId}/meter/electric/{MeterId}/quote?commission={commission}&oldquoteid={oldquoteid}	Provides a site's electricity meter quote details
GET request/customer/{CustomerId}/site/{SiteId}/meter/electric/{MeterId}/savings	Get Savings for the Meter (Samsung specific)
GET request/customer/{CustomerId}/site/{SiteId}/meter/gas/{MeterId}	Display Customer Site's specific Gas meter information
GET request/customer/{CustomerId}/site/{SiteId}/meter/gas/{MeterId}/commission	Display Customer Site's specific Gas meter commission
GET request/customer/{CustomerId}/site/{SiteId}/meter/gas/{MeterId}/quote?commission={commission}&oldquoteid={oldquoteid}	Provides a site's gas meter quote details
GET request/customer/{CustomerId}/site/{SiteId}/meter/gas?ProductId={ProductId}	Display Customer Site's Gas meter information
GET request/customer/{CustomerId}/site/{SiteId}/meters	Display Customer Site's meter information
GET request/customer/{CustomerId}/site/{SiteId}/meters/all	Display Customer All Site's meter information
GET request/customer/{CustomerId}/site/{SiteId}/meters/suppliers	Display Customer All Site's meter information
GET request/customer/{CustomerId}/site/{SiteId}/note/{NoteId}	Display a particular customer's site notes
GET request/customer/{CustomerId}/site/{SiteId}/notes	Display a specific customer site notes
GET request/customer/{CustomerId}/site/{SiteId}/payment	Provides a specific customer site payment information
GET request/customer/{CustomerId}/site/deleted?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}&userId={userId}&customerTypeId={customerTypeId}	Display all deleted customer sites
GET request/customer/{CustomerId}/site?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}&userId={userId}&customerTypeId={customerTypeId}	Display all customer sites
GET request/customer/{customerId}/sites?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}&userId={userId}&customerTypeId={customerTypeId}	Displays specific customer's company information
GET request/customer/{CustomerId}/sitesummary	Lists all the Sites Half Hourly Summary
GET request/customer/{CustomerId}/sitesummaryhh	Lists all the Sites Half Hourly Summary
GET request/customer/{customerId}/summary	Display a specific customer's company summary
GET request/customer/{id}/bespoke/{bespokeid}/loa	To get any particular customer's Bespoke LOA Document from Azure
GET request/customer/{id}/cmaswitchdetail	Gets CMA Switch Detail information for a particular customer
GET request/customer/{Id}/creditreport	returns the credit report information for given credit safe company id
GET request/customer/{page_no}/{page_size}	Display all Customer Companies information
GET request/customer/activeinstaneousquotes	Gets all the Active Instaneous Quotes
GET request/customer/bespoke/{bespokequoteid}/results	Get all bespoke quote results
GET request/customer/bespoke/{bespokequoteid}/results/{bespokesuppquoteid}?NoOfYears={NoOfYears}	Get all bespoke quote results
GET request/customer/bespoke/{BespokeQuoteId}/sites
GET request/customer/bespoke/{bespokequoteid}/supplierquote/{bespokesuppquoteid}/{noofyears}/contract/download	Bespoke Tender Contract sent to Buyer to be signed and Returned
GET request/customer/bespoke/{Id}/documents	Displays All the Bespoke Quote Documents
GET request/customer/bespoke/{id}/supplierquote/{suppquoteid}/contract?noofyears={noofyears}	Get bespoke contract
GET request/customer/bespoke/objections/{bespokecontractid}	Get bespoke objections
GET request/customer/bespoke/tender
GET request/customer/bespoke/tender/user/{userid}	No documentation available.
GET request/customer/deleted?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}&userId={userId}&customerTypeId={customerTypeId}	Displays deleted customer's companies
GET request/customer/List/user/{UserId}?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}&customerTypeId={customerTypeId}	Get Customer's Company information
GET request/customer/List?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}&userId={userId}&customerTypeId={customerTypeId}	Get Customer's Company information
GET request/customer/meters6monthcurrentcontact	Displays all the Meters current Six Month Contacts
GET request/customer/metersactivebespokejourney	Displays The Metres Active Bespoke Journey
GET request/customer/multiquote/{quoteId}/meters	Displays any particular Customer's Multiple Quotes
GET request/customer/search?search_text={search_text}&search_type={search_type}&userId={userId}	Get Customer's Company information
GET request/customer/selfserve/report	Get all the self serve customer report
GET request/customer/user/{UserId}?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}&customerTypeId={customerTypeId}	Provides particular customer's contacts
GET request/customer?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}&userId={userId}&customerTypeId={customerTypeId}	Get Customer's Company information
POST request/customer	Add New Customer Company
POST request/customer/{CustomerId}/bespoke/{BespokeId}/refresh	No documentation available.
POST request/customer/{customerId}/bespoke/{bespokequoteid}/results/{bespokesuppquoteid}/getcontractemail	No documentation available.
POST request/customer/{CustomerId}/contact	Add new comapny information
POST request/customer/{CustomerId}/electric/bespoke	No documentation available.
POST request/customer/{CustomerId}/electric/bespoke/{BespokeId}
POST request/customer/{CustomerId}/electric/bespoke/{BespokeQuoteId}/document/upload	Uploads The Bespoke Quote Document
POST request/customer/{CustomerId}/fuel/{FuelId}/quote/create	No documentation available.
POST request/customer/{CustomerId}/gas/bespoke	No documentation available.
POST request/customer/{CustomerId}/gas/bespoke/{BespokeId}
POST request/customer/{CustomerId}/gas/bespoke/{BespokeQuoteId}/document/upload	No documentation available.
POST request/customer/{CustomerId}/note	Add note for a specific company
POST request/customer/{CustomerId}/ownersdetails	Post specific Company's Owner contact and address information
POST request/customer/{customerId}/quote/{QuoteId}/manualtariff	Add ManualPrice for MultiQuote
POST request/customer/{CustomerId}/quote/{QuoteId}/results?Commission={Commission}&IsStandingChargeCommission={IsStandingChargeCommission}	No documentation available.
POST request/customer/{CustomerId}/site	Add new customer site information
POST request/customer/{CustomerId}/site/{SiteId}/contact	Add new site contacts
POST request/customer/{CustomerId}/site/{SiteId}/copybillingoption	Add customer site billing information
POST request/customer/{CustomerId}/site/{SiteId}/meter/{MeterId}/upload	Uploads the HHDocument against the meter
POST request/customer/{CustomerId}/site/{SiteId}/meter/electric	No documentation available.
POST request/customer/{CustomerId}/site/{SiteId}/meter/electric/{MeterId}/battery	Post Meter extra battery details (Samsung specific)
POST request/customer/{CustomerId}/site/{SiteId}/meter/gas	Add Customer Site's Gas meter information
POST request/customer/{CustomerId}/site/{SiteId}/meters	Adds New Electric and Gas multi meters information for Customer Sites
POST request/customer/{CustomerId}/site/{SiteId}/meters/all	Post Customer All Site's meter information
POST request/customer/{CustomerId}/site/{SiteId}/note	Add a customer site notes
POST request/customer/{CustomerId}/site/bulkupload	Add all the sites and meters
POST request/customer/{CustomerId}/site/bulkupload/dcda	No documentation available.
POST request/customer/{id}/bespoke/{bespokequoteid}/loa/upload	Uploads the Signed LOA document to Azure for a BespokeQuote
POST request/customer/bespoke/{bespokequoteid}/supplierquote/{bespokesuppquoteid}/{noofyears}/contract/request	No documentation available.
POST request/customer/bespoke/{bespokequoteid}/supplierquote/{bespokesuppquoteid}/{noofyears}/contract/upload	Uploads Bespoke Supplier Quote Contract
POST request/customer/bespoke/{Id}/survey	Creates Buyer Survey Responses
POST request/customer/existcheck	No documentation available.
POST request/customer/UploadCustomerDocument	Upload Comapny documents.
POST request/customer/UploadSiteDocument	Add site documents
PUT request/customer/{customerId}	Update a specific customer's company information
PUT request/customer/{customerId}/commission	Update a particular compnay's commission
PUT request/customer/{CustomerId}/contact/{ContactId}	Update a specific company details
PUT request/customer/{customerId}/document/{documentId}	Update specific comapny's documents
PUT request/customer/{CustomerId}/note/{NoteId}	Update a specific company notes
PUT request/customer/{customerId}/payment	Update a particular customer's company payment details
PUT request/customer/{customerId}/quote/{QuoteId}/manualtariff/{TariffId}	Update the Details and Tariff Rates for Manual price for Multi Quote
PUT request/customer/{CustomerId}/site/{SiteId}	Update a specific customer site information
PUT request/customer/{CustomerId}/site/{SiteId}/contact/{ContactId}	Update a specific site contacts
PUT request/customer/{CustomerId}/site/{SiteId}/copybillingoption	Update a specific customer site billing information
PUT request/customer/{customerId}/site/{siteId}/document/{documentId}	Update specific documents of customer's company sites
PUT request/customer/{CustomerId}/site/{SiteId}/meter/electric/{MeterId}	Update Customer Site's Electric meter information
PUT request/customer/{CustomerId}/site/{SiteId}/meter/gas/{MeterId}	Update Customer Site's Gas meter information
PUT request/customer/{CustomerId}/site/{SiteId}/note/{NoteId}	Update a specific customer site notes
PUT request/customer/{CustomerId}/site/{SiteId}/payment	Update a specific site payment details
PUT request/customer/{CustomerId}/site/{SiteId}/paymentaddressoption	Update a specific site payment address information
PUT request/customer/bespoke/{bespokequoteid}/withdraw	Update withdraw bespoke quotes
PUT request/customer/bespoke/{id}/contract/{contractId}/result/{resultId}/update/status	Gets the Contract status History

Dashboard

API	Description
GET request/dashboard	No documentation available.
GET request/dashboard/user/{userid}	No documentation available.

DCDA

API	Description
DELETE request/dcda/quote/{quoteid}	No documentation available.
GET request/dcda/contract/{Id}/byid	No documentation available.
GET request/dcda/contract/all	No documentation available.
GET request/dcda/contract/user/{userid}/all	No documentation available.
GET request/dcda/meterconnectiontype	No documentation available.
GET request/dcda/myquotes	No documentation available.
GET request/dcda/precontract/esign/url?Id={Id}&purchaseOrderId={purchaseOrderId}	No documentation available.
GET request/dcda/precontract/esign?Id={Id}	No documentation available.
GET request/dcda/precontract/update?Id={Id}&docusignStatus={docusignStatus}	No documentation available.
GET request/dcda/servicetype	No documentation available.
GET request/dcda/tier	No documentation available.
GET request/dcda/user/{userid}/myquotes	No documentation available.
POST request/dcda/{CustomerId}/quote/{QuoteId}/results	No documentation available.
POST request/dcda/contract/{id}/submit/upload	No documentation available.
POST request/dcda/customer/{customerId}/bulkupload	No documentation available.
POST request/dcda/customer/{CustomerId}/fuel/{FuelId}/quote/create	No documentation available.
POST request/dcda/precontract	No documentation available.
POST request/dcda/precontract/email/generate	No documentation available.
POST request/dcda/precontract/esignemail/generate	No documentation available.
POST request/dcda/precontract/print/generate	No documentation available.

Info

API	Description
GET request/Info/Contact-Titles	Display Contact Titles
POST request/Info/Mpan	Display MPAN information of meter
POST request/Info/Mpan/noauth	Display MPAN information of meter
POST request/Info/Mprn	Display MPRN information of meter
POST request/Info/Switch/State	Provides the information about the state of a switch

QuickQuote

Provides information about Quick Quote

API	Description
DELETE request/quickquote/{quoteId}	Delete a particular quote
GET request/quickquote/customer/{CustomerId}	Display all customer details
GET request/quickquote/electric/{MeterId}/quote?commission={commission}&oldquoteid={oldquoteid}	Provides an electricity meter quickquote details
GET request/quickquote/gas/{MeterId}/quote?commission={commission}&oldquoteid={oldquoteid}	Provides a gas meter quickquote details
GET request/quickquote/QuoteList	Display a list of quickquotes
POST request/quickquote	Add a new quick quote
POST request/quickquote/delete	Delete requestd list of quote ids
POST request/quickquote/dual	Add a new quick quote
POST request/quickquote/dual/new	Add a new quick quote
POST request/quickquote/electric/{MeterId}/quote	Provides an electricity meter quickquote details
POST request/quickquote/gas/{MeterId}/quote	Provides a gas meter quickquote details
PUT request/quickquote/customer/{CustomerId}	Update a specific customer details

Report

API	Description
GET request/report/summary/{agentId}?from={from}&to={to}	Provides a Summary
GET request/report/summary/agent/{agentId}/details?from={from}&to={to}	Provides a Summary For All Brokers
GET request/report/summary?from={from}&to={to}	Provides a Summary
GET request/report/summaryDetails/{agentId}?from={from}&to={to}	Provides a Dashboard

Request

API	Description
DELETE request/brandconfig/{id}	Delete any particular Brand Configration for a Product and User
GET request/billingaddressoption	Display a billing address
GET request/brandconfig	Displays the Brand Configuration for a specific user and a product
GET request/carbonintensity?date={date}	No documentation available.
GET request/commisionlist	Provides commision list
GET request/companytype	Provide all company types
GET request/comparisiontype	Provides a meter comparison information
GET request/consumptionperiod	Provides a meter consumption period
GET request/contact/deletereason	Display site contacts deleted reason
GET request/contractlength	Display all contract types
GET request/contractroles	Display contract roles
GET request/contracttype	Display all contract types
GET request/copybillingsendoption	Provides a copy of billing info
GET request/customer/deletereason	Display a customers deleted reason
GET request/customertypes	Get All CustomerTypes
GET request/dayahead	No documentation available.
GET request/documenttypes	Get a document by types
GET request/employees	Display all payment types
GET request/employees/noauth	No documentation available.
GET request/industrysector	Get All the brand industry sector
GET request/meter/deletereason	Display meters deleted reason
GET request/paymentfrequency	No documentation available.
GET request/paymentmethod	Display all payment methods
GET request/paymentmethod/bespoke/filter	Display all payment methods
GET request/paymentmethod/filter	Display all payment methods
GET request/paymentterm	Provide available payments by term
GET request/paymenttype	Display all payment types
GET request/publicholiday	Display all payment methods
GET request/renewaltype	Display all Renewal Energy Types
GET request/sicdescriptions	Display SIC information
GET request/site/deletereason	Display company sites deleted reason
GET request/sitestatus	Display company site status
GET request/standingchargeperiod	Provides a meter standing charge period
GET request/titles	Display all Titles
GET request/water/accountmanagement	Get All Water Contract Length
GET request/water/billing	Get All Water billing options
GET request/water/billingaddressoption	Display a billing address
GET request/water/contractlength	Get All Water Contract Length
GET request/water/documenttypes	Get a document by types
GET request/water/meterread	Get All Water Contract Length
GET request/water/paymentmethod/filter	Display all Water payment methods
GET request/water/paymentterm	Get All Water Payment Terms
GET request/water/quotestatus/reason	Get all the Water quote status reasons
POST request/brandconfig	To Add or Update the Brand configuration of a particular Brand,Parentcompany and product

Retention

API	Description
GET request/retention/account/{accountNumber}	Get the specific account number results
GET request/retention/quote?accountNumber={accountNumber}	Get the specific account number results

Suppliers

API	Description
GET request/Suppliers	Gets a list of possible suppliers a customer can switch from.
POST request/Suppliers/Switch-From	Gets a list of possible suppliers a customer can switch from.

Survey

API	Description
POST request/survey	Creates Buyer Survey Responses
POST request/survey/upload	Creates Buyer Survey Responses

User

Provides accurate and up-to-date user information

API	Description
DELETE request/user/{id}	Delete a particular user
DELETE request/user/{id}/subBroker/company	No documentation available.
DELETE request/user/{userid}/brand/{brandid}	No documentation available.
GET request/user/{id}	Display a particular user info
GET request/user/{id}/subBroker/company	No documentation available.
GET request/user/{userId}/myquotes	Displays Multi Quotes details for any particular User ----- Optima
GET request/user/adminusers	Display all Admin users
GET request/user/adminusers/role/{RoleId}	Get Admin users by roles
GET request/user/brand/{brandId}/all	No documentation available.
GET request/user/brand/{brandid}/roles	No documentation available.
GET request/user/brand/logo	Display current user brand
GET request/user/channels	Updates the Buyer User Notification Read Details
GET request/user/currentuser	Display current user info
GET request/user/currentuser/brand	No documentation available.
GET request/user/deletereason	Display deleted user reason
GET request/user/forgetpassword?email={email}	Get a Change Password
GET request/user/myquotes	Displays Multi Quotes details for the loggedinUser ----- Optima
GET request/user/notification	Display current user brand
GET request/user/parent/brand/all	No documentation available.
GET request/user/rolepermission	Display loggedIn user role permission info
GET request/user/roles	Display loggedIn user roles
GET request/user?UserTypeId={UserTypeId}&Email={Email}&ContactNumber={ContactNumber}&UserId={UserId}	No documentation available.
POST request/user	Add a new User
POST request/user/{id}/subBroker/company	Add/Update a new Sub Broker Company
POST request/user/authenticate/send	No documentation available.
POST request/user/authenticate/validate	No documentation available.
POST request/user/brand/{brandid}	No documentation available.
POST request/user/brokerbuyerportal	No documentation available.
POST request/user/changepassword	Asks to Change Password when first Login
POST request/user/register/dfe	Registration
POST request/user/register/gs	Registration of Gov Switch
POST request/user/register/mug	Registration of Gov Switch
POST request/user/register/wave	Registration of Wave self serve user
POST request/user/tracking	Add/Update User Tracking
PUT request/user/{id}	Update a particular User
PUT request/user/{userid}/brand/{brandid}	No documentation available.
PUT request/user/notification/{id}	Updates the Buyer User Notification Read Details

Waterconfiguration

API	Description
GET request/water/config/thresholdlimit	Returns water wholesale ThresholdLimit config
GET request/water/config/user	No documentation available.
GET request/water/config/user/{userid}/thresholdlimit	Returns water User Limit config
GET request/water/config/usertype	No documentation available.
POST request/water/config/thresholdlimit	No documentation available.
POST request/water/config/user	No documentation available.
POST request/water/config/user/{userid}/thresholdlimit	No documentation available.

WaterContract

API	Description
GET request/water/contract/{contractid}/export?ScotlandOrEngland={ScotlandOrEngland}	Display SiteMeter Export details for any particular contract
GET request/water/contract/{id}	Displays WaterContracts inforamtion for a specific Contract.
GET request/water/contract/esign/precontract?Id={Id}	No documentation available.
GET request/water/contract/esign/url?Id={Id}	No documentation available.
GET request/water/contract/update?Id={Id}&docusignStatus={docusignStatus}	Returns a specific Contract information
GET request/water/contract?ContractId={ContractId}&UserTypeId={UserTypeId}&CustomerName={CustomerName}&Email={Email}&Postcode={Postcode}&userId={userId}	No documentation available.
GET request/water/contract?MugQuoteId={MugQuoteId}	Get a specific water precontract Details
POST request/water/contract/{id}/upload	Uploads the Signed Water Contract to Azure
POST request/water/contract/esign/generate	Send Docusign URL for Watercontracts
POST request/water/contract/esign/precontract/payment	Update docusign Payment details
POST request/water/contract/esignemail/generate	Send Portal Docusign URL for Watercontracts
POST request/water/contract/print/generate	Print Water Contract details
PUT request/water/contract/{id}/update/status	Displays WaterContracts inforamtion for a specific Contract.
PUT request/water/contract/{id}/update/status/multi	Updates the status of multiple sites for a particular contract.

WaterCustomer

Provide all information about company

API	Description
DELETE request/water/customer/{customerId}	Deletes a specific customer company
DELETE request/water/customer/{CustomerId}/contact/{ContactId}	Delete a specific company details
DELETE request/water/customer/{CustomerId}/site/{SiteId}	Delete a specific company site details
DELETE request/water/customer/{CustomerId}/site/{SiteId}/contact/{ContactId}	Delete a specific company details
DELETE request/water/customer/quote/{quoteId}/delete	Deletes any particular Quote deatils
GET request/water/customer/{customerId}	Displays specific customer's company information
GET request/water/customer/{CustomerId}/contact/{contactId}	Get a specific company's contact information
GET request/water/customer/{CustomerId}/contact/main	Get a specific company's main contact information
GET request/water/customer/{CustomerId}/contacts	Get a specific Water Company's all contact information
GET request/water/customer/{CustomerId}/document/{documentId}	Get Water specific document for a Customer
GET request/water/customer/{CustomerId}/document/all	Displays all the attached Documents Details of any particular water Customer
GET request/water/customer/{CustomerId}/document/loa	Displays Any particular water Customer's LOA Documents Attached Details
GET request/water/customer/{CustomerId}/ownersdetails	Get a specific Water Company's Owner contact and address information
GET request/water/customer/{customerId}/payment	Displays a specific customer's company payment details
GET request/water/customer/{customerId}/quote/{quoteid}/email/pdf	No documentation available.
GET request/water/customer/{customerId}/quote/{quoteid}/error	Displays specific customer's Water Bulk Processing Error
GET request/water/customer/{customerid}/quote/{quoteid}/export?ScotlandOrEngland={ScotlandOrEngland}	No documentation available.
GET request/water/customer/{customerId}/quote/{quoteid}/pdf	Exports Quote result in pdf format with dynamic fields - for England
GET request/water/customer/{customerid}/quote/{quoteid}/results	To display Bulk processing(File,MultiQuote and Requote) quote Results for a customer's quote
GET request/water/customer/{customerid}/site/{siteid}	Display any specific CMA or CMOS Site Details
GET request/water/customer/{CustomerId}/site/{siteId}/contact/{contactId}	Get a specific company's site contact information
GET request/water/customer/{CustomerId}/site/{siteId}/contact/main	Get a specific company's site main contact information
GET request/water/customer/{CustomerId}/site/{siteId}/contacts	Get a specific Water Company's all site contact information
GET request/water/customer/{customerid}/site/{siteId}/payment	Gets the Customer Billing payment Details
GET request/water/customer/{customerid}/site/{siteid}/quote/{quoteId}/info	No documentation available.
GET request/water/customer/{customerid}/sites	Displays all the Site Meter details belongs to a particular Customer
GET request/water/customer/dashboard	Get Water England and Scotland Customer's Company information
GET request/water/customer/list/details	No documentation available.
GET request/water/customer/list?UserTypeId={UserTypeId}&CustomerName={CustomerName}&Email={Email}&userId={userId}	No documentation available.
GET request/water/customer/quote/pending/authorisation?IsEnglandOrScotland={IsEnglandOrScotland}	Displays all the Pending quotes for a Authorised user(status = Pending)
GET request/water/customer/quoterequests	Get any particular Water Customer's Multiple Site Quote Request Details
GET request/water/customer/quoterequests/{mugquoteid}	Get Water Site Quote Request Details for any particular Quote
GET request/water/customer/quoterequests/user/{UserId}	No documentation available.
GET request/water/customer/quoterequests/user/{UserId}/{mugquoteid}	No documentation available.
GET request/water/customer/site/search?postcode={postcode}&wspid={wspid}&sspid={sspid}&EnglandOrScotland={EnglandOrScotland}	Displays Site meter details for a particular Postcode or SPID or SSPID
GET request/water/customer/site/validatetariffcode?spid={spid}&sspid={sspid}&EnglandOrScotland={EnglandOrScotland}	Checks whether the given Site is in Tariffcode Exclude List
POST request/water/customer	Add New Customer Company
POST request/water/customer/{customerid}/bulkuploadquote	To process the Bulk Quote(Instant and Queued) through file Upload
POST request/water/customer/{CustomerId}/bulkuploadsite	Creates a new Bulk Sites
POST request/water/customer/{CustomerId}/contact	Add a new comapany contact information
POST request/water/customer/{CustomerId}/document/upload	Uploads any particular Customer's Document to Azure
POST request/water/customer/{customerId}/experian/creditinfoandreport	Updates the credit Report details(Credit score,timestamp,Siccode) for a customer
POST request/water/customer/{customerId}/experian/proprietorcreditinfoandreport	No documentation available.
POST request/water/customer/{CustomerId}/ownersdetails	Post specific Water Company's Owner contact and address information
POST request/water/customer/{customerid}/quote/{quoteid}/requoteupload	To upload for the queued(more than 40 meters) requote adjustable volume from Excel for England
POST request/water/customer/{customerId}/quote/{quoteid}/siteexport	To export customer site Details to Excel
POST request/water/customer/{customerid}/quote/multi	Creates Multi Site Quote(Instant or Queued) for both CMOS and CMA Sites.
POST request/water/customer/{customerid}/site	Creates a new Site for a Customer
POST request/water/customer/{CustomerId}/site/{siteId}/contact	Add comapny new site contact information
POST request/water/customer/{customerid}/site/{siteid}/quote/{quoteid}/refresh	No documentation available.
POST request/water/customer/{customerid}/site/multiple	Creates multiple sites which is either CMOS Or CMA
POST request/water/customer/exist	No documentation available.
PUT request/water/customer/{customerId}	Updates a specific customer's company information
PUT request/water/customer/{CustomerId}/{site}/{siteId}/contact/{ContactId}	/ Update a specific company site contact details
PUT request/water/customer/{CustomerId}/contact/{ContactId}	Updates a specific company contact details
PUT request/water/customer/{customerId}/payment	Update a particular customer's company payment details
PUT request/water/customer/{customerid}/quote/{quoteid}/netmargin	Updates any particular quote Net margin by loggedInUser
PUT request/water/customer/{customerid}/quote/{quoteid}/status	Authorised user updates the status of any particular failed quote (credit check fail or WholesaleCharge above threshold limit)
PUT request/water/customer/{customerid}/quote/{quoteid}/transfer/user	Any Authorised user can change the quote transfer (lock or unlock) any his assigned pending quote for override saying the quote is picked by this user
PUT request/water/customer/{customerid}/site/{siteid}	Updates the Site detail for a Customer
PUT request/water/customer/{customerid}/site/{siteid}/payment	Updates the customer billing payment details
PUT request/water/customer/{customerid}/site/{siteid}/quote/{quoteId}/info	No documentation available.

WaterQuickQuote

API	Description
POST request/quickquote/water/multi	Creates a new Quick Quote Customer with multi sites
POST request/quickquote/water/multi/quote	Creates a new Quick Quote Customer with multi sites

WaterRegistration

API	Description
GET request/water/registration/userexists?id={id}	No documentation available.
POST request/water/registration/company	No documentation available.
POST request/water/registration/start?email={email}	No documentation available.
PUT request/water/registration/continue?email={email}	No documentation available.
PUT request/water/registration/verify?id={id}	No documentation available.

WaterReport

API	Description
GET request/water/report/authorisedquotes	Displays the Authorised Quotes (with status Accept,Reject and Done outside the portal)
GET request/water/report/count	No documentation available.