Seamlessly integrate our Medusa API into your systems to access real-time pricing, contracts, payouts and more. You can connect to the live endpoint at https://medusa.jellyfish.rest to retrieve this data.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9702688","collectionId":"079deec4-7e5b-42eb-b43d-df1739365471","publishedId":"2sA3JKei9T","public":true,"customColor":{"top-bar":"212121","right-sidebar":"303030","highlight":"e72e6f"},"publishDate":"2024-05-09T14:04:59.000Z"},"item":[{"name":"Authentication","item":[{"name":"/auth","id":"16410cb7-6426-4bbe-99b1-69102db1cf02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shortCode\": \"JELLYFISH\", // your partner short code\n \"key\": \"{{JELLYFISHING}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{MEDUSA_ENDPOINT}}auth","description":"This endpoint is used to authenticate the partner using a short code and key.
\nshortCode (string): Your partner short codekey (string): Partner key for authenticationThe response is a JSON object with the following properties:
\nsuccess (boolean): Indicates the success of the authenticationdata (object): Contains the authentication token and its expiration timetoken (string): Authentication tokenexp (string): Token expiration timeerrors: Indicates any errors in the authentication process, will be null if no errors occurred{\n \"success\": true,\n \"data\": {\n \"token\": \"\",\n \"exp\": \"\"\n },\n \"errors\": null\n}\n\nThis endpoint is used to check the authentication status.
\nRequest
\n{{MEDUSA_ENDPOINT}}auth/checkResponse
\nBody:
\n {\n \"success\": true,\n \"data\": {\n \"id\": 0,\n \"name\": \"\",\n \"partnerId\": 0,\n \"partner\": {\n \"name\": \"\",\n \"shortCode\": \"\",\n \"createdAt\": \"\",\n \"appLogo\": true,\n \"documentLogo\": true,\n \"appHue\": null,\n \"frozen\": true\n },\n \"api\": true\n },\n \"errors\": null\n }\n\nUse your short code and API key to authenticate with our platform.
\n","_postman_id":"e77792a8-f5a6-4b8e-b1b5-fbfabcc5dc0d"},{"name":"Searches","item":[{"name":"/searches","id":"2d7925b3-8b72-4958-b4ed-b91783774e12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"reference\": null,\n \"energy\": \"electricity\",\n \"usage\": 50000,\n \"mpxn\": \"1800020687927\",\n \"startDate\": \"2024-06-01\",\n \"commission\": 1.05,\n \"promotionCode\": \"TEST\",\n \"riskScore\": 90\n}","options":{"raw":{"language":"json"}}},"url":"{{MEDUSA_ENDPOINT}}searches","description":"Create a new search to instantly view available products.
\nreference (string, optional): The reference for the search.
energy (string): The energy type for the search.
usage (number): The usage amount for the search.
mpxn (string): The MPXN for the search.
startDate (string): The start date for the search.
commission (number): The commission amount for the search against the unit rate (per kWh).
standingUplift (number): The commission amount for the search against the standing charge (per day).
promotionCode (string, optional): The promotion code for the search.
riskScore (number, optional): The risk score for the search.
The response is in JSON format and has the following schema:
\n{\n \"success\": true,\n \"data\": {\n \"reference\": \"\"\n },\n \"errors\": null\n}\n\nsuccess (boolean): Indicates if the request was successful.
data (object): Contains the data related to the search.
reference (string): The reference for the search.errors: Indicates any errors in the response.
This endpoint retrieves search results from the Medusa system.
\nStatus: 200
\nContent-Type: application/json
\nBody:
\n {\n \"success\":true,\n \"data\":[\n {\n \"ts\":\"\",\n \"params\":{\n \"reference\":\"\",\n \"mpxn\":\"\",\n \"usage\":0,\n \"energy\":\"\",\n \"startDate\":\"\",\n \"commission\":0,\n \"retentionRating\":0\n },\n \"user\":\"\"\n }\n ],\n \"errors\":null\n }\n\nThe response contains a \"success\" flag indicating the success of the request, along with \"data\" containing search results in the form of an array of objects. Each object includes \"ts\", \"params\", and \"user\" fields. The \"errors\" field is null, indicating no errors.\n\nThis endpoint retrieves information for a specific search by providing the search reference in the URL.
\nThis is a GET request and does not require a request body.
\nsuccess (boolean): Indicates if the request was successful.data (object): Contains the search details and product information.search (object): Details of the search.ts (string): Timestamp.params (object): Parameters used for the search.reference (string): Reference information.mpxn (string): MPXN information.usage (number): Usage value.energy (string): Energy information.startDate (string): Start date.commission (number): Commission value.retentionRating (number): Retention rating.user (string): User information.products (array): List of products.id (number): Product ID.name (string): Product name.description (string): Product description.facts (array): List of facts.fixed (boolean): Indicates if the product is fixed.term (number): Term value.allOrDayUnitRate (number): All or day unit rate.nightRate (number): Night rate.eveningWeekendRate (number): Evening/weekend rate.standingCharge (number): Standing charge.meterType (string): Type of meter.riskScoreExclusive (boolean): Indicates if risk score is exclusive.retentionExclusive (boolean): Indicates if retention is exclusive.costs (object): Cost details.annualCost (number): Annual cost.annualCommission (number): Annual commission.monthlyCost (number): Monthly cost.monthlyCommission (number): Monthly commission.errors: Indicates any errors, if present.An example response:
\n{\n \"success\": true,\n \"data\": {\n \"search\": {\n \"ts\": \"\",\n \"params\": {\n \"reference\": \"\",\n \"mpxn\": \"\",\n \"usage\": 0,\n \"energy\": \"\",\n \"startDate\": \"\",\n \"commission\": 0,\n \"retentionRating\": 0\n },\n \"user\": \"\",\n \"api\": true\n },\n \"products\": [\n {\n \"id\": 0,\n \"name\": \"\",\n \"description\": \"\",\n \"facts\": [\"\"],\n \"fixed\": true,\n \"term\": 0,\n \"allOrDayUnitRate\": 0,\n \"nightRate\": null,\n \"eveningWeekendRate\": null,\n \"standingCharge\": 0,\n \"meterType\": \"\",\n \"riskScoreExclusive\": true,\n \"retentionExclusive\": true,\n \"costs\": {\n \"annualCost\": 0,\n \"annualCommission\": 0,\n \"monthlyCost\": 0,\n \"monthlyCommission\": 0\n }\n }\n ]\n },\n \"errors\": null\n}\n\nDelete a search.
\nExample response body:
\n{\n \"success\":true,\n \"data\":true,\n \"errors\":null\n}\n\nCreate a new search to instantly view available products. Stored for 7 days.
\n","_postman_id":"40f2e427-9a59-413b-abe7-0b424765b709"},{"name":"Bulk Searches","item":[{"name":"/bulk-searches","id":"363e810f-fa96-4f7a-8759-9b07ab6de0e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"reference\": \"testing123\",\n \"data\": [\n {\n \"energy\": \"electricity\",\n \"usage\": 50000,\n \"mpxn\": \"1800020687927\",\n \"startDate\": \"2024-06-01\",\n \"commission\": 1.05,\n \"promotionCode\": \"TEST\",\n \"riskScore\": 90\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{MEDUSA_ENDPOINT}}bulk-searches","description":"For multi-site searches.
\nThe request body should be in raw format and should include an array of objects with the following parameters:
\nreference (string, required): A reference value.
data (array, required): An array of objects containing the following parameters:
energy (string, required): Energy type.
usage (number, required): Usage value.
mpxn (string, required): MPXN value.
startDate (string, required): Start date.
commission (number, required): Commission value.
promotionCode (string, optional): Promotion code.
riskScore (number, optional): Risk score value.
The response will be in JSON format with the following schema:
\n{\n \"success\": true,\n \"data\": {\n \"reference\": \"\"\n },\n \"errors\": null\n}\n\nsuccess (boolean): Indicates if the request was successful.data (object): Contains the reference value.reference (string): A reference value.errors: Indicates any errors, if present.Upon successful execution, the response will be in JSON format with a status code of 200. The response will contain the following fields:
\nsuccess (boolean): Indicates whether the request was successful.data (array): An array of objects containing search data.ts: Timestamp of the search.user: User associated with the search.api (boolean): Indicates if the search was performed via API.reference: Reference information for the search.meters (number): Number of meters associated with the search.errors: Indicates any errors encountered during the request.{\n \"success\":true,\n \"data\":[\n {\n \"ts\":\"\",\n \"user\":\"\",\n \"api\":true,\n \"reference\":\"\",\n \"meters\":0\n }\n ],\n \"errors\":null\n}\n\n{\n \"success\": true,\n \"data\": {\n \"ts\": \"\",\n \"params\": {\n \"data\": [\n {\n \"mpxn\": \"\",\n \"energy\": \"\",\n \"commission\": 0,\n \"usage\": 0,\n \"startDate\": \"\",\n \"promotionCode\": \"\",\n \"products\": [],\n \"errors\": [\"\"]\n }\n ],\n \"dataFilters\": {},\n \"reference\": \"\"\n },\n \"user\": \"\",\n \"api\": true\n },\n \"errors\": null\n}\n\nRefresh products for the bulk search reference.
\n{\n \"success\": true,\n \"data\": true,\n \"errors\": null\n}\n\nThis JSON schema represents the response structure for the request, where:
\nDelete a bulk search.
\nUpon successful execution, the endpoint returns a JSON response with a status code of 200 and a content type of application/json. The response body follows the schema below:
{\n \"type\": \"object\",\n \"properties\": {\n \"success\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"boolean\"\n },\n \"errors\": {\n \"type\": \"null\"\n }\n },\n \"required\": [\"success\", \"data\", \"errors\"]\n}\n\nThis schema describes the structure of the response object, where the success and data properties are of type boolean, and the errors property is of type null.
Create a new search to instantly view available products. Stored for 7 days. Products will be cached unless /refresh is called.
\n","_postman_id":"4b546b2e-6b7f-4db1-ba53-68f32cf4d4dd"},{"name":"Contracts","item":[{"name":"/contracts","id":"6557fb71-f36c-454f-9a3e-e30dd9c93881","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}contracts?stage=PENDING_SIGNATURE","description":"INFORMATION_REQUIREDPENDING_SIGNATUREPENDING_APPROVALREJECTEDCONTRACT_EXPIREDThe response is a JSON object with the following schema:
\n{\n \"success\": boolean,\n \"data\": [\n {\n \"id\": number,\n \"companyName\": string,\n \"reference\": string,\n \"startDate\": string,\n \"mpxn\": string,\n \"energy\": string,\n \"metadata\": {\n \"partner_user\": string\n }\n }\n ],\n \"errors\": null\n}\n\nThe success field indicates if the request was successful. The data array contains contract details including id, companyName, reference, startDate, mpxn, energy, and metadata with partner_user. The errors field is null if there are no errors.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 0,\n \"companyName\": \"\",\n \"reference\": \"\",\n \"startDate\": \"\",\n \"mpxn\": \"\",\n \"energy\": \"\",\n \"metadata\": {\n \"partner_user\": \"\"\n }\n }\n ],\n \"errors\": null\n}\n\nThis endpoint allows the creation of contracts. The request should be sent as an HTTP POST to {{MEDUSA_ENDPOINT}}/contracts with the following payload in raw request body type:
\n{\n \"productId\": 0,\n \"search\": {\n \"ts\": \"\",\n \"params\": {\n \"reference\": \"\",\n \"energy\": \"\",\n \"usage\": 0,\n \"mpxn\": \"\",\n \"startDate\": \"\",\n \"commission\": 0,\n \"promotionCode\": \"\",\n \"riskScore\": 0\n },\n \"user\": \"\",\n \"api\": true\n },\n \"companyName\": \"\",\n \"reference\": \"\",\n \"loa\": \"\"\n}\n\nThe response for this request is a JSON object with the following schema:
\n{\n \"success\": true,\n \"data\": {\n \"id\": 0\n },\n \"errors\": null\n}\n\nThe success field indicates whether the request was successful. If successful, the data field contains the contract ID. The errors field will be null if there are no errors.
Example response:
\n{\n \"success\": true,\n \"data\": {\n \"id\": 0\n },\n \"errors\": null\n}\n\nThe endpoint retrieves contract information for a specific contract. The response is in JSON format and has a schema as follows:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"success\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\"\n },\n \"stage\": {\n \"type\": \"string\"\n },\n \"companyName\": {\n \"type\": \"string\"\n },\n \"companyRegistrationNumber\": {\n \"type\": \"string\"\n },\n \"reference\": {\n \"type\": \"string\"\n },\n \"startDate\": {\n \"type\": \"string\"\n },\n \"endDate\": {\n \"type\": \"string\"\n },\n \"contactTitle\": {\n \"type\": \"string\"\n },\n \"contactFirstName\": {\n \"type\": \"string\"\n },\n \"contactLastName\": {\n \"type\": \"string\"\n },\n \"contactPosition\": {\n \"type\": \"string\"\n },\n \"contactEmail\": {\n \"type\": \"string\"\n },\n \"contactPhone\": {\n \"type\": \"string\"\n },\n \"contactAltPhone\": {\n \"type\": [\"string\", \"null\"]\n },\n \"mpxn\": {\n \"type\": \"string\"\n },\n \"bankAccountName\": {\n \"type\": \"string\"\n },\n \"bankAccountNumber\": {\n \"type\": \"string\"\n },\n \"bankAccountSortCode\": {\n \"type\": \"string\"\n },\n \"commissionPerUnit\": {\n \"type\": \"integer\"\n },\n \"estimatedAnnualUsage\": {\n \"type\": \"integer\"\n },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"partner_user\": {\n \"type\": \"string\"\n }\n }\n },\n \"productId\": {\n \"type\": \"integer\"\n },\n \"energy\": {\n \"type\": \"string\"\n },\n \"active\": {\n \"type\": \"boolean\"\n },\n \"contractDocumentId\": {\n \"type\": [\"string\", \"null\"]\n },\n \"creditsafeId\": {\n \"type\": [\"string\", \"null\"]\n },\n \"cot\": {\n \"type\": \"boolean\"\n },\n \"createdAt\": {\n \"type\": \"string\"\n },\n \"updatedAt\": {\n \"type\": \"string\"\n },\n \"partnerId\": {\n \"type\": \"integer\"\n }\n }\n },\n \"errors\": {\n \"type\": [\"array\", \"null\"],\n \"items\": {}\n }\n }\n}\n\nThis endpoint is used to update the contract object. Note that stages will automatically update. You can use the parameters found in the contract object.
\nCompany Type Options
\n[\n \"limited-company\",\n \"sole-trader\",\n \"partnership\",\n \"llp\",\n \"plc\",\n \"charity\",\n \"other\"\n]\n\nStatus: 200
\nContent-Type: application/json
\n{\n \"success\": true,\n \"data\": true,\n \"errors\": null\n}\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"success\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"boolean\"\n },\n \"errors\": {\n \"type\": \"null\"\n }\n }\n}\n\nThis endpoint retrieves the selected product for the contract.
\nThe response for this request is a JSON object with the following schema:
\n{\n \"success\": boolean,\n \"data\": {\n \"id\": integer,\n \"name\": string,\n \"description\": string,\n \"facts\": array,\n \"region\": string,\n \"standingCharge\": number,\n \"unitRate\": number,\n \"minAq\": number,\n \"maxAq\": number,\n \"effectiveFrom\": string,\n \"effectiveTo\": string,\n \"fixed\": boolean,\n \"term\": integer,\n \"active\": boolean,\n \"broker\": boolean,\n \"retention\": boolean,\n \"online\": boolean,\n \"riskScoreFloor\": number,\n \"riskScoreCeiling\": number,\n \"retentionRating\": null or string,\n \"brokerShortCode\": null or string,\n \"promotionCode\": null or string\n },\n \"errors\": null\n}\n\nThe success field indicates whether the request was successful. The data field contains information about the selected product, including its ID, name, description, pricing details, and other attributes. The errors field is null when the request is successful.
This endpoint retrieves the onboarding notes for the contract.
\n","urlObject":{"path":["3813","onboarding-notes"],"host":["{{MEDUSA_ENDPOINT}}contracts"],"query":[],"variable":[]}},"response":[{"id":"67f80fed-44e4-4151-99e5-9d9629755a02","name":"/contracts/:id/onboarding-notes","originalRequest":{"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}contracts/3813/onboarding-notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Thu, 09 May 2024 12:10:58 GMT"},{"key":"X-RateLimit-Reset","value":"1715256669"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"530"},{"key":"ETag","value":"W/\"212-V/v1UYgGXbz5sgAYBGVOEqQ5ORc\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [{\n \"note\": \"ABC\",\n \"date\": \"2025-01-01\"\n }],\n \"errors\": null\n}"}],"_postman_id":"90076ee1-de20-4c09-a1f4-0dba8a4a0023"},{"name":"/contracts/:id/client","id":"15ff6e0f-f680-4218-a01c-ce137b43f390","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}contracts/4444/client","description":"This endpoint retrieves the client information for the specified contract. The contract must be in an ACCEPTED state.
\nThis is a GET request and does not require a request body.
\nThe response for this request is a JSON object with the following schema:
\n{\n \"success\": boolean,\n \"data\": {\n \"account\": string,\n \"address\": string,\n \"balance\": number,\n \"contacts\": [\n {\n \"name\": string,\n \"email\": string,\n \"telephone\": string,\n \"mobile\": string\n }\n ],\n \"name\": string,\n \"rating\": number,\n \"status\": string,\n \"lastBill\": {\n \"amount\": number,\n \"date\": string,\n \"id\": number\n },\n \"lastPayment\": {\n \"amount\": number,\n \"date\": string\n },\n \"lastReading\": {\n \"value\": number,\n \"date\": string\n },\n \"nextProduct\": {\n \"description\": string,\n \"rate\": number,\n \"commission\": number,\n \"name\": string,\n \"start\": string,\n \"end\": string\n },\n \"mandate\": {\n \"status\": string,\n \"id\": string\n },\n \"pendingPayments\": number,\n \"product\": [\n {\n \"description\": string,\n \"rate\": number,\n \"commission\": number,\n \"name\": string,\n \"start\": string,\n \"end\": string\n }\n ],\n \"estimatedAnnualUsage\": number,\n \"mpxn\": string,\n \"type\": string,\n \"pendingRenewalContracts\": [\n {\n \"id\": number,\n \"reference\": string,\n \"metadata\": {\n \"partner_user\": string\n },\n \"stage\": string\n }\n ]\n },\n \"errors\": null\n}\n\nThe success field indicates whether the request was successful. The data field contains detailed client information, including account details, address, balance, contact details, billing and payment history, product details, and more. The errors field is null when the request is successful.
This endpoint is used to initiate the electronic signing process for a specific contract. Upon successful execution, it returns a JSON response with a status code of 200 and the following structure:
\n{\n \"success\": true,\n \"data\": true,\n \"errors\": null\n}\n\nThis endpoint retrieves the e-sign status for the contract.
\nNo request body is required for this endpoint.
\nThe response for this request is a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"success\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"sent\": {\n \"type\": [\"date\", \"null\"]\n }\n }\n },\n \"errors\": {\n \"type\": [\"array\", \"null\"]\n }\n }\n}\n\nThe response contains a boolean value indicating the success status, an object with the e-sign status and sent date, and an array of errors if any.
\n{\n \"success\": true,\n \"data\": {\n \"status\": \"\",\n \"sent\": null\n },\n \"errors\": null\n}\n\nReturns a pre-filled contract PDF as file data.
\n","urlObject":{"path":["3813","document"],"host":["{{MEDUSA_ENDPOINT}}contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"35859f90-af0c-42c3-a007-9761eb93c085"},{"name":"/contracts/:id/document","id":"78638c01-ea45-4e76-8750-7a3f0f74c4a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"file\": \"JVBERi0xLj...\"\n}","options":{"raw":{"language":"json"}}},"url":"{{MEDUSA_ENDPOINT}}contracts/3813/document","description":"This endpoint is used to upload a document for the contract. This will automatically send the contract to Jellyfish Energy for approval.
\nfile (file): The document file to be uploaded.Upon successful execution, the API returns a JSON object with the following fields:
\nsuccess (boolean): Indicates if the request was successful.data (boolean): Indicates if the document upload was successful.errors (null): Null if there are no errors.Example response:
\n{\n \"success\": true,\n \"data\": true,\n \"errors\": null\n}\n\nCreate and prepare contracts from a search. Then upload/send signed contracts for approval by Jellyfish Energy.
\n","_postman_id":"7a85b42a-f1f3-444c-89c6-4b83559af7c1"},{"name":"Renewal Contracts","item":[{"name":"/renewal-contracts","id":"4d790f95-0e63-4c09-b275-1e6c2d52f4ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}renewal-contracts?stage=PENDING_SIGNATURE","urlObject":{"host":["{{MEDUSA_ENDPOINT}}renewal-contracts"],"query":[{"key":"stage","value":"PENDING_SIGNATURE"}],"variable":[]}},"response":[],"_postman_id":"4d790f95-0e63-4c09-b275-1e6c2d52f4ec"},{"name":"/renewal-contracts","id":"95169375-9f06-4e72-8a65-a069a073753b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{MEDUSA_ENDPOINT}}renewal-contracts","urlObject":{"host":["{{MEDUSA_ENDPOINT}}renewal-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"95169375-9f06-4e72-8a65-a069a073753b"},{"name":"/renewal-contracts/:id","id":"9d2ac51b-c016-42a8-867e-5a93dfa1ea97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}renewal-contracts/21","urlObject":{"path":["21"],"host":["{{MEDUSA_ENDPOINT}}renewal-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d2ac51b-c016-42a8-867e-5a93dfa1ea97"},{"name":"/renewal-contracts/:id","id":"c1640038-b583-4e53-a3be-d789593a1696","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{MEDUSA_ENDPOINT}}renewal-contracts/3813","urlObject":{"path":["3813"],"host":["{{MEDUSA_ENDPOINT}}renewal-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"c1640038-b583-4e53-a3be-d789593a1696"},{"name":"/renewal-contracts/:id/selected-product","id":"9676892b-164d-4f1a-9165-ca375a0cfb8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}renewal-contracts/21/selected-product","urlObject":{"path":["21","selected-product"],"host":["{{MEDUSA_ENDPOINT}}renewal-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"9676892b-164d-4f1a-9165-ca375a0cfb8b"},{"name":"/renewal-contracts/:id/esign","id":"d4566321-9b3c-4e78-b4b8-2e2a5504ebfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{MEDUSA_ENDPOINT}}renewal-contracts/3813/esign","urlObject":{"path":["3813","esign"],"host":["{{MEDUSA_ENDPOINT}}renewal-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"d4566321-9b3c-4e78-b4b8-2e2a5504ebfc"},{"name":"/renewal-contracts/:id/esign/status","id":"a8b82fad-1e76-4161-af66-1d5e00a4656c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}renewal-contracts/3813/esign/status","urlObject":{"path":["3813","esign","status"],"host":["{{MEDUSA_ENDPOINT}}renewal-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"a8b82fad-1e76-4161-af66-1d5e00a4656c"},{"name":"/renewal-contracts/:id/document","id":"776f0590-52bd-43b5-ba43-b4561ee83681","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}renewal-contracts/21/document","urlObject":{"path":["21","document"],"host":["{{MEDUSA_ENDPOINT}}renewal-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"776f0590-52bd-43b5-ba43-b4561ee83681"},{"name":"/renewal-contracts/:id/document","id":"feffddb9-5a98-45be-9208-eda8188ae3b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{MEDUSA_ENDPOINT}}renewal-contracts/3813/document","urlObject":{"path":["3813","document"],"host":["{{MEDUSA_ENDPOINT}}renewal-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"feffddb9-5a98-45be-9208-eda8188ae3b4"}],"id":"301c780b-bb37-43d0-b7bc-bb69eae341cc","description":"Create and prepare contracts from a search. Then upload/send signed contracts for approval by Jellyfish Energy. Live accounts only.
\n","_postman_id":"301c780b-bb37-43d0-b7bc-bb69eae341cc"},{"name":"Bulk Contracts","item":[{"name":"/bulk-contracts","id":"58032de9-eb11-4353-96fb-1ae46dfb3dd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}bulk-contracts?stage=PENDING_SIGNATURE","urlObject":{"host":["{{MEDUSA_ENDPOINT}}bulk-contracts"],"query":[{"key":"stage","value":"PENDING_SIGNATURE"}],"variable":[]}},"response":[],"_postman_id":"58032de9-eb11-4353-96fb-1ae46dfb3dd0"},{"name":"/bulk-contracts","id":"ac797d03-a764-422e-8c75-f55010d8488a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{MEDUSA_ENDPOINT}}bulk-contracts","urlObject":{"host":["{{MEDUSA_ENDPOINT}}bulk-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"ac797d03-a764-422e-8c75-f55010d8488a"},{"name":"/bulk-contracts/:id","id":"66363620-7bb0-490b-bed3-aeb7bbc736ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}bulk-contracts/21","urlObject":{"path":["21"],"host":["{{MEDUSA_ENDPOINT}}bulk-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"66363620-7bb0-490b-bed3-aeb7bbc736ca"},{"name":"/bulk-contracts/:id","id":"b1e0c885-1ae1-4eda-9764-c73a8b45c895","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{MEDUSA_ENDPOINT}}bulk-contracts/3813","urlObject":{"path":["3813"],"host":["{{MEDUSA_ENDPOINT}}bulk-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"b1e0c885-1ae1-4eda-9764-c73a8b45c895"},{"name":"/bulk-contracts/:id/meters","id":"d45e69b3-6cae-4ec4-b043-6b268bc61258","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}bulk-contracts/21/meters","urlObject":{"path":["21","meters"],"host":["{{MEDUSA_ENDPOINT}}bulk-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"d45e69b3-6cae-4ec4-b043-6b268bc61258"},{"name":"/bulk-contracts/:id/document","id":"7a25743f-3cff-4da7-bfe1-cf93ce2ada8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}bulk-contracts/21/document","urlObject":{"path":["21","document"],"host":["{{MEDUSA_ENDPOINT}}bulk-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a25743f-3cff-4da7-bfe1-cf93ce2ada8f"},{"name":"/bulk-contracts/:id/document","id":"fd87d0f6-efdb-424e-a49b-4b9803b35daf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{MEDUSA_ENDPOINT}}bulk-contracts/3813/document","urlObject":{"path":["3813","document"],"host":["{{MEDUSA_ENDPOINT}}bulk-contracts"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd87d0f6-efdb-424e-a49b-4b9803b35daf"}],"id":"217f50b8-854e-4247-be5e-151dca3779a0","description":"Create and prepare contracts from a bulk search. Then upload/send signed contracts for approval by Jellyfish Energy.
\n","_postman_id":"217f50b8-854e-4247-be5e-151dca3779a0"},{"name":"Clients","item":[{"name":"/clients","id":"abfc5086-0e8c-46a0-b8e6-171ebc7a18a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}clients?stage=LIVE","description":"This endpoint makes an HTTP GET request to fetch live clients from the Medusa API.
\nstage (query parameter): Indicates the stage of the clients to retrieve.
LIVE
ONBOARDING
LOSING
FAILED
READING_REQUIRED
mpxn (query parameter): Indicates the MPAN/MPRN of the client to retrieve.
The API returns a JSON object with the following fields:
\nsuccess (boolean): Indicates whether the request was successful.
data (array): Contains an array of objects, each representing a live client. Each object includes the following fields:
account (string): The account information of the client.
type (string): The type of the client.
name (string): The name of the client.
mpxn (string): The MPXN (Meter Point Administration Number) of the client.
address (string): The address of the client.
postcode (string): The postcode of the client.
errors (null): Indicates any errors encountered during the request.
{\n \"success\": true,\n \"data\": [\n {\n \"account\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"mpxn\": \"\",\n \"address\": \"\",\n \"postcode\": \"\"\n }\n ],\n \"errors\": null\n}\n\nThis endpoint makes an HTTP GET request to retrieve client information for the specified client ID. The response will include details such as account information, address, balance, contacts, rating, last bill, last payment, last reading, pending payments, product details, estimated annual usage, MPXN, client type, and pending renewal contracts.
\nThis request does not include a request body.
\nsuccess (boolean): Indicates if the request was successful.
data (object): Contains the client information including account, address, balance, contacts, name, rating, status, last bill, last payment, last reading, next product, mandate, pending payments, product details, estimated annual usage, MPXN, client type, and pending renewal contracts.
errors (null): Indicates any errors in the response, which is null if no errors occurred.
The response will include the specified client's details in the data object if the request is successful.
All released client bills with the related payout ID if applicable.
\nThe response is in JSON format and has the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"success\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\"\n },\n \"reference\": {\n \"type\": \"integer\"\n },\n \"amount\": {\n \"type\": \"integer\"\n },\n \"start\": {\n \"type\": \"string\"\n },\n \"end\": {\n \"type\": \"string\"\n },\n \"payoutId\": {\n \"type\": [\"integer\", \"null\"]\n }\n }\n }\n },\n \"errors\": {\n \"type\": [\"array\", \"null\"]\n }\n }\n}\n\nThis endpoint retrieves the consumption and standing charge lines for the client bill.
\nThe response is a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"success\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"consumption\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"timeBand\": {\n \"type\": \"string\"\n },\n \"start\": {\n \"type\": \"string\"\n },\n \"end\": {\n \"type\": \"string\"\n },\n \"startRead\": {\n \"type\": \"number\"\n },\n \"endRead\": {\n \"type\": \"number\"\n },\n \"units\": {\n \"type\": \"number\"\n },\n \"rate\": {\n \"type\": \"number\"\n },\n \"charge\": {\n \"type\": \"number\"\n },\n \"startReadType\": {\n \"type\": \"string\"\n },\n \"endReadType\": {\n \"type\": \"string\"\n }\n }\n }\n },\n \"standingCharge\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"start\": {\n \"type\": \"string\"\n },\n \"end\": {\n \"type\": \"string\"\n },\n \"units\": {\n \"type\": \"number\"\n },\n \"rate\": {\n \"type\": \"number\"\n },\n \"charge\": {\n \"type\": \"number\"\n }\n }\n }\n }\n }\n },\n \"errors\": {\n \"type\": [\"null\", \"object\"]\n }\n }\n}\n\nGenerate a search automatically from client data.
\nThe response is in JSON format and has the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"success\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"reference\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\"reference\"]\n },\n \"errors\": {\n \"type\": [\"object\", \"null\"]\n }\n },\n \"required\": [\"success\", \"data\", \"errors\"]\n}\n\nView and analyse live contracts placed with Jellyfish Energy.
\n","_postman_id":"f3ea775e-d151-4427-bf00-bbb5f435a9d3"},{"name":"Payouts","item":[{"name":"/payouts","id":"8e383346-a71f-455e-8a9e-3613c45a8be5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}payouts","description":"Request Body
This is a GET request and does not require a request body.
Response
\nsuccess (boolean): Indicates if the request was successful.data (array): An array of payout objects, each containing the following fields:id (integer): The ID of the payout.period (string): The period for the payout.amount (integer): The amount of the payout.invoiceUploaded (boolean): Indicates if the invoice is uploaded.partnerId (integer): The ID of the partner.billCount (integer): The count of bills for the payout.stage (string): The stage of the payout.errors (null): Indicates any errors, if present.Example Response
\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": 0,\n \"period\": \"\",\n \"amount\": 0,\n \"invoiceUploaded\": true,\n \"partnerId\": 0,\n \"billCount\": 0,\n \"stage\": \"\"\n }\n ],\n \"errors\": null\n}\n\nThis endpoint retrieves the payout details for a specific payout ID.
\nStatus: 200
\nContent-Type: application/json
\nBody:
\n {\n \"success\": true,\n \"data\": {\n \"id\": 0,\n \"period\": \"\",\n \"amount\": 0,\n \"invoiceUploaded\": true,\n \"partnerId\": 0,\n \"backing\": [\n {\n \"id\": 0,\n \"start\": \"\",\n \"end\": \"\",\n \"account\": \"\",\n \"name\": \"\",\n \"mpxn\": \"\",\n \"cancelled\": true\n }\n ],\n \"stage\": \"\"\n },\n \"errors\": null\n }\n\nThis endpoint retrieves the payout lines that are currently on hold.
\nNo request body is required for this endpoint.
\nThe response will be a JSON object with the following schema:
\n{\n \"success\": boolean,\n \"data\": [\n {\n \"account\": string,\n \"name\": string,\n \"mpxn\": string,\n \"commission\": number,\n \"haltedDueToPayment\": boolean,\n \"haltedDueToReads\": boolean\n }\n ],\n \"errors\": null\n}\n\nThe success field indicates whether the request was successful. The data field contains an array of objects, each representing a payout on hold, with details such as account, name, MPXN, commission, and flags indicating if the payout is halted due to payment or reads. The errors field will be null if there are no errors.
{\n \"success\": true,\n \"data\": [\n {\n \"account\": \"\",\n \"name\": \"\",\n \"mpxn\": \"\",\n \"commission\": 0,\n \"haltedDueToPayment\": true,\n \"haltedDueToReads\": true\n }\n ],\n \"errors\": null\n}\n\nView and analyse commission payout statements from Jellyfish Energy.
\n","_postman_id":"a9988707-dd0c-4ff2-9f91-d7258e7223e4"},{"name":"Reports","item":[{"name":"/reports/renewals","id":"ff240985-bdcd-4e71-a5d2-5949b01eb709","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}reports/renewals","description":"All upcoming renewal dates and the stage.
\nResponse:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"success\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"account\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"stage\": {\n \"type\": \"string\"\n },\n \"date\": {\n \"type\": \"string\"\n }\n }\n }\n },\n \"errors\": {\n \"type\": [\"null\", \"object\"]\n }\n }\n}\n\nThis request retrieves recent objections (<= 7 days from now) from the Medusa API. The response will have a \"success\" field indicating the success status of the request, and a \"data\" field containing an array of objection report objects. Each objection report object includes \"account\", \"name\", \"mpxn\", \"proposedStart\", and \"status\" fields. The \"errors\" field will be null if there are no errors in the response. No specific headers are mentioned for this request.
\n","urlObject":{"path":["objections"],"host":["{{MEDUSA_ENDPOINT}}reports"],"query":[],"variable":[]}},"response":[{"id":"45135824-29ab-426a-93a9-82e6963e9f92","name":"/reports/objections","originalRequest":{"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}reports/objections"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Wed, 05 Jun 2024 19:33:47 GMT"},{"key":"X-RateLimit-Reset","value":"1717616037"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"277"},{"key":"ETag","value":"W/\"115-fUv8dHhe1+U6zpOOFrcdCUcsdqE\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"account\": \"123456\",\n \"name\": \"Company 134\",\n \"mpxn\": \"1800027039999\",\n \"proposedStart\": \"17/10/2024\",\n \"status\": \"Rejected\"\n }\n ],\n \"errors\": null\n}"}],"_postman_id":"15e77a41-2539-4a5d-955c-36896db846b0"},{"name":"/reports/client-ratings","id":"c0e3345b-748d-4f7a-833e-f0eeea15d2da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JELLYFISHING_BEARER}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{MEDUSA_ENDPOINT}}reports/client-ratings","description":"Returns an array of objects (account, rating, weight) which is the backing data for the partner rating.
\n","urlObject":{"path":["client-ratings"],"host":["{{MEDUSA_ENDPOINT}}reports"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0e3345b-748d-4f7a-833e-f0eeea15d2da"}],"id":"470ac8c6-4abe-4583-988f-db8d1185430f","description":"View pre-made reports via API.
\n","_postman_id":"470ac8c6-4abe-4583-988f-db8d1185430f"}]}