Address
Get addresses from national database
| API | Description |
|---|---|
| GET request/Address/recco/company?postcode={postcode}&fuelTypeId={fuelTypeId} |
Gets company address details from RECCo/ECOES and Xoserve using a postcode. |
| GET request/Address/recco/search/mpxn?fuelTypeId={fuelTypeId}&mpan={mpan}&mprn={mprn} |
Searches RECCo/ECOES and Xoserve address or meter records using an MPxN, such as an MPAN or MPRN. |
| GET request/Address/recco?postcode={postcode}&fuelTypeId={fuelTypeId} |
Gets address details from RECCo/ECOES and Xoserve using a postcode. |
| POST request/Address/recco/details |
Gets full address and meter details from RECCo/ECOES and Xoserve for a selected address. |
Bank
Provides verification of Bank details for a switch
| API | Description |
|---|---|
| GET request/Bank/Is-Valid?sortCode={sortCode}&accountNumber={accountNumber} |
Checks whether the provided bank account details are valid. |
Company
Provides information about company
| API | Description |
|---|---|
| GET request/Company/selfServ?Uniquecode={Uniquecode} |
No documentation available. |
| POST request/Company/experian/creditinfo |
Gets company credit information using Experian data. |
| POST request/Company/experian/creditinfoandreport |
Gets company credit information and credit report using Experian data. |
| POST request/Company/experian/search |
Searches for company details using Experian company data. |
| POST request/Company/Query/Name/v2 |
Returns info about companies with a specific name |
| POST request/Company/Query/Registration-Number/v2 |
Searches for company details using the company registration number. |
Contract
Provides contract information
| API | Description |
|---|---|
| GET request/contract/{Id}/byid |
Gets details of multiple contracts using the contract ID. |
| GET request/contract/all |
Gets contract details for multiple users. |
| GET request/contract/precontract/esign/url?Id={Id}&SmartInstallationDate={SmartInstallationDate}&SmartInstallationTime={SmartInstallationTime} |
Gets e-signature URLs for multiple contract recipients. |
| GET request/contract/precontract/esign?Id={Id} |
Gets the uploaded DocuSign contract details using the contract ID. |
| GET request/contract/precontract/update?Id={Id}&docusignStatus={docusignStatus} |
Uploads or retrieves multiple DocuSign contract details using the contract ID. |
| GET request/contract/user/{userId} |
Returns all Contracts info available for specific user. |
| GET request/contract/user/{userId}/all |
Gets contract details for multiple users. |
| POST request/contract/{id}/submit/upload |
Uploads contract documents for multiple contracts. |
| POST request/contract/{Id}/survey |
Creates Buyer Survey Responses |
| POST request/contract/contactrole |
Submits role details for multiple contract recipients. |
| POST request/contract/precontract |
Submits pre-contract details before creating or finalising a contract. |
| POST request/contract/precontract/email/generate |
Sends the contract document to multiple recipients by email. |
| POST request/contract/precontract/esign/generate |
Sends the pre-contract document for e-signature. |
| POST request/contract/precontract/esign/payment |
Sends pre-contract documents to multiple recipients through DocuSign. |
| POST request/contract/precontract/esignemail/generate |
Sends the contract for e-signature to multiple recipients by email. |
| POST request/contract/precontract/print/generate |
Generates and downloads the contract document using the submitted contract details. |
| POST request/contract/submit |
Submits multiple contracts for processing. |
| PUT request/contract/{id}/status |
Updates the status of multiple contracts. |
Customer
Provide all information about company
Dashboard
| API | Description |
|---|---|
| GET request/dashboard |
No documentation available. |
| GET request/dashboard/user/{userid} |
No documentation available. |
Info
| API | Description |
|---|---|
| POST request/Info/Mpan |
Display MPAN information of meter |
QuickQuote
Provides information about Quick Quote
| API | Description |
|---|---|
| DELETE request/quickquote/{quoteId} |
Delete a particular quote |
| POST request/quickquote/dual/new |
Add a new quick quote |
Report
| API | Description |
|---|---|
| POST request/report/dashboard |
No documentation available. |
Request
| API | Description |
|---|---|
| GET request/billingaddressoption |
Display a billing address |
| 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/documenttypes |
Get a document by types |
| GET request/employees |
Display all payment types |
| GET request/industrysection/siccode |
Provides SicCodes,Description for all the IndustrySectors |
| GET request/industrysector |
Get All the brand industry sector |
| GET request/meter/deletereason |
Display meters deleted reason |
| GET request/paymentfrequency |
Provides all the available Payment Frequency |
| 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 public Holidays |
| 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 |
| POST request/contract/query |
Submit Contract Query |
Suppliers
| API | Description |
|---|---|
| GET request/Suppliers |
Gets a list of possible suppliers a customer can switch from. |
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} |
Delete a particular user from any brand |
| 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 |
To get all the users for the particular brand |
| GET request/user/currentuser |
Display current user info |
| GET request/user/currentuser/brand |
Display current user info |
| 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/parent/brand/all |
To get all the users for the looggedIn brand |
| 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} |
Display all users info |
| POST request/user |
Add a new User |
| POST request/user/{id}/subBroker/company |
Add/Update a new Sub Broker Company |
| POST request/user/brand/{brandid} |
Add a new User in the given Brand |
| POST request/user/changepassword |
Asks to Change Password when first Login |
| PUT request/user/{id} |
Update a particular User |
| PUT request/user/{userid}/brand/{brandid} |
Update a particular User in any given Brand |