{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6c1c1b26-4faf-41e1-8f26-ac1d5f3d688b","name":"Connected API for POWWR UK Supplier Portals","description":"---\nSupports creating, validating and submitting new deals to UK Suppliers via POWWR Supplier Portals.\n\n**Typical Usage**\n1. Obtain an OAuth token from the POWWR Auth Server\n2. Call `/CreateDeal` passing customer, meter and rate data\n3. Add Supporting documentation via `/addDocument`\n4. Validate the quote data provide by calling `/performQuote`\n5. Credit check the customer by calling `/performCreditCheck`\n6. Submit the new deal to the supplier with `/submitDeal`\n\n---\nVersion History\n\n5.6.0\n\n- Added SmartInstallationDateAndTime\n    \n\n5.5.0\n\n- Added PayeeDetails (Bank Account Type, Joint Account, Company Registration No) to the paymentDetails\n    \n\n5.4.0\n\n- Added supplierUplift to ElecPriceComponent and GasPriceComponent\n    \n- Updated description of uplift to clarify the distinction between the two uplift types\n    \n- Added ignoreInvalidData to DealRequest\n    \n\n5.3.0\n\n- Added dateOfQuote to smeElectricity and smeGas\n    \n\n5.2.0\n\n- Added replaceExisting flag to addDocumentRequest\n    \n\n5.1.0\n\n- Added EnrichmentNotAvailable enum value\n    \n- Allow 5 digit SIC codes\n    \n- Removed pattern for telephone numbers\n    \n\n5.0.0\n\n- Fixed spelling of dateOfIncorporation property (Breaking)\n    \n\n4.1.7\n\n- Added additional Enums to Entity property in Issue object\n    \n- Added 400 response to /submitDeal\n    \n\n4.1.6\n\n- Add credit check override result to /performCreditCheck\n    \n\n4.1.5\n\n- Various bug fixes\n    \n\n4.1.4\n\n- Added elecRates to performQuote response\n    \n- Added gasRates to performQuote response\n    \n- Removed pricesReturned flag from performQuote response\n    \n\n## Version History\n\n**4.1.3**  \n\\+ Add Elec Meter Last Reading  \n\\+ Add Gas Meter Last Reading\n\n## Version History\n\n## **4.1.2**\n\n  \n\\* Renamed udStatusGroup to powwrStatusGroup  \n\\- Removed PencePerMonth from rateTypes\n\n## 4.1.1\n\n\\+ Fix response type to json so examples are shown in Swagger for all endpoints  \n\\+ Set version number to match code version\n\n## 4.1.0\n\n\\+ Added isGreen flag to elec and gas (needed for pricing)  \n\\+ Added standingChargeType enum to elec and gas (needed for pricing)  \n\\+ Added hasCustomMeteringService to elec (needed for pricing)  \n\\+ Added halfHourlyNumberOfRates  \n\\+ fixed spelling on UnnecessaryProperty enum  \n\\+ bespoke prices flag in CAPI on performQuote  \n\\+ Added strictValidation flag to createDeal\n\n## 4.0.0\n\n\\- Removed success flag from all responses as ProblemDetails used for failure  \n\\* Renamed Basket to Deal throughout  \n\\* Merged Enrichments with Warnings, added specifics for warnings  \n\\* Fix non camelCased UtilityBaseType properties (BillingDetails, DealDetails and Address)  \n\\* Changed UdId to PowwrId  \n\\* PowwrId is mandatory when specifying a supplier/brokerage/agent  \n\\+ Added format definition for 400 response to use ProblemDetail response\n\n## 3.0.0\n\n\\- Removed cclVat from AddDocument DocumentType enum as this is covered already  \nby cclException (Breaking change)  \n\\- Removed DocuSign document types from add document  \n\\+ Added endpoint /AddDocuSignDocument with Request/Response  \n\\+ Add minimum of 0 to uplift  \n\\+ Made brokerage and agent mandatory on createbasket request\n\n## 2.2.5\n\n\\+ Added Message to CreditCheckResponse\n\n## 2.2.4\n\n\\+ Added Enrichments to CreateBasketResponse to return data added/changed  \nfrom lookups\n\n## 2.2.3\n\n\\+ Added Get Portal Link endpoint\n\n## 2.2.2\n\n\\+ Added ContractSignedDate to ContractDetails\n\n## 2.2.1\n\n\\+ Added CclVat to the AddDocument DocumentType enum\n\n## 2.2.0\n\n\\+ Removed Water\n\n## 2.1.0\n\n\\+ Removed CashOrCheque (same as receipt of bill)\n\n## 2.0.0 (Breaking change)\n\n\\* Renamed UtilityStatus.Status to UtilityStatus.supplierStatus  \n\\+ Added UtilityStatus.UdStatusGroup\n\n## 1.14.0\n\n\\+ Make MPAN required\n\n## 1.13.0\n\n\\+ Add Webhook for basket updates\n\n## 1.12.0\n\n\\+ Add UpdateBasket endpoint\n\n## 1.11.0\n\n\\+ Remove EveningAndWeekend rates\n\n## 1.10.0\n\n\\+ Add in extra credit check responses\n\n## 1.9.0\n\n\\+ Add error reporting to quotation  \n\\+ Modify quote response\n\n## 1.8.0\n\n\\+ Add error reporting to submit endpoint\n\n## 1.7.0\n\n\\+ Add submit endpoint\n\n## 1.6.0\n\n\\+ Add perform credit check endpoint  \n\\+ Flip Request/Respone on quote endpoint as incorrect\n\n## 1.5.0\n\n\\+ Add field sale to contract type\n\n## 1.4.0\n\n\\+ Add endpoint to automatically generate a quote (/performQuote)  \n\\+ Add format uuid to basketId throughout\n\n## 1.3.0\n\n\\+ Add endpoint to retrieve statuses for each utility in a basket  \n\\+ Remove unused schemas around submit bakset  \n\\+ Reorder schemas\n\n## 1.2.2\n\n\\+ Add Sandbox authorisation\n\n## 1.2.1\n\n\\+ Align document types with the V2 Portals\n\n## 1.2.0\n\n\\+ Removed the submitBasket endpoint as not yet required.\n\n## 1.1.1\n\n\\+ Add Product to contract details, needed for quote  \n\\+ Add Pricebook to contract details, needed for quote\n\n## 1.1.0\n\n\\+ Change usages from array to object (breaking change)  \n\\+ Add brokeragePaymentTerm to ContractDetails  \n\\+ Added commercialUsagePercentage to ContractDetails\n\n## 1.0.6\n\n\\+ Add contact to site\n\n1.0.5\n\n- Added Smart Meter marketing to SME Gas and SME Electric","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"53415706","team":113592,"collectionId":"6c1c1b26-4faf-41e1-8f26-ac1d5f3d688b","publishedId":"2sBYAxQ9ap","public":true,"publicUrl":"https://capi.docs.powwr.net","privateUrl":"https://go.postman.co/documentation/53415706-6c1c1b26-4faf-41e1-8f26-ac1d5f3d688b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.11","publishDate":"2026-09-14T09:52:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/0c959db5dc90d60a5e4cda0f7c2f0b7345555cc62596f658d47857e3660bedf7","favicon":"https://powwr.net/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://capi.docs.powwr.net/view/metadata/2sBYAxQ9ap"}