Plan Comparison APIs (v4)

Download OpenAPI specification:Download

Accurassi’s plan comparison and switch products extract energy bills, provide a personalised comparison of energy plans and digitally process requests to switch plans.

Comparison API

/market/compare

Compare using an electricity bill. Hundreds of datapoints are accurately extracted from the uploaded document. This data is then used to compare the bill against the whole market. A personalised comparison is returned that is a best fit for the customer's energy profile.

header Parameters

clientCode required	string This value will be provided by Accurassi during on-boarding.
clientID required	string This value will be provided by Accurassi during on-boarding. The clientID is paired with clientCode and used for authentication. This value should never be published on a public facing site.

Request Body schema: application/json

correlationId	string <uuid> User generated, unique identifier for comparison. This ID allows you to match the comparison against a record in your system
ebillBase64 required	string <base64> Base64 encoded PDF
planLimit	integer Default: 30 The maximum number of plans to return

Responses

Request samples

Payload
Python
NodeJS
cURL

Content type

application/json

{"correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"ebillBase64": "QWNjdXJhc3NpIE1hcmtldFBsYWNlIEFQSQ==",
"planLimit": 30
}

Response samples

Content type

application/json

Example

ComparisonResponse

{"correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"comparisonDate": "2019-10-18T07:09:21.882+11:00",
"plans": [{"id": 100456,
"name": "Accurassi Energy All Time Saver",
"retailer": {"id": 123456,
"name": "Accurassi Energy Retailer",
"phone": "+555 13384337",
"email": "energy@accurassi.com"
},
"referencePrice": {"equivalence": "less than",
"percentDifferent": 22,
"retailerAnnualEstimate": 4000,
"averageAnnualConsumption": 10027
},
"estimatedTotalCost": 704.8,
"estimatedBaseCost": 704.8,
"estimatedSaving": 179.8,
"rates": {"name": "Rates",
"value": [{"name": "Peak Rate",
"value": 23.94,
"unit": "cents per kW hour"
}
]
},
"type": "SR",
"url": "https://www.energymadeeasy.gov.au/offer/1008406?postcode=2067",
"defaultOfferMessage": "The annualised price of this plan is $1,764 and is 14% less than the Reference Price.",
"payOnTimeRequired": false,
"directDebitRequired": false,
"discounts": {"payOnTime": 60.23,
"directDebit": 43.84
},
"benefits": {"name": "Benefits",
"discounts": [{"name": "Guaranteed discount on total bill(usage and supply)",
"value": "13%",
"condition": "Discount applies to GST exclusive usage and supply charges, and not to fees and other charges such as late payment fees or Greenpower."
}
],
"incentives": [{"name": "$50 Welcome credit (GST incl)",
"value": "We'll provide the welcome credit for each new supply address you sign up via www.accurassi.com, as an offset against the charges on your first electricity bill (excluding a final bill). Terms and conditions apply."
}
]
},
"contract": {"name": "Contract Details",
"value": [{"name": "string",
"value": ["string"
]
}
]
},
"conditions": {"name": "Conditions",
"value": [{"name": "string",
"value": ["string"
]
}
]
},
"paymentOptions": {"name": "string",
"value": ["string"
]
},
"greenOptions": {"name": "string",
"value": ["string"
]
},
"feesAndCharges": {"name": "string",
"value": [{"name": "string",
"value": "string",
"description": "string"
}
],
"additionalFeeInfo": ""
}
}
],
"currentBillData": {"accountName": "John Smith",
"accountAddress": "Level 3, 9 Help Street, Chatswood, NSW, 2067",
"supplyAddress": "Level 3, 9 Help Street, Chatswood, NSW, 2067",
"tariffType": "SR",
"usage": {"controlLoad1": 0,
"controlLoad2": 0,
"op": 0,
"opStep1": 0,
"opStep2": 0,
"pk": 500,
"pkStep1": 0,
"pkStep2": 0,
"pkStep3": 0,
"sh": 0,
"solar": 0,
"supply": 0
},
"retailer": {"id": 123456,
"name": "Accurassi Energy Retailer",
"phone": "+555 13384337",
"email": "energy@accurassi.com"
},
"nmi": "41035337484",
"accountNumber": "4813 741 128",
"fuelType": "E",
"GSTInclusive": "false",
"seasonalBill": false,
"billDateFrom": "2018-11-03T00:00:00.000+11:00",
"billDateTo": "2019-02-08T00:00:00.000+11:00",
"days": 93,
"actualPlanTotalCost": 884.598,
"discount": 0,
"periods": [{"peak": {"rate": 0.2847,
"value": 305.76
},
"peakStep1": {"rate": 0.2847,
"value": 305.76
},
"peakStep2": {"rate": 0.2847,
"value": 305.76
},
"peakStep3": {"rate": 0.2847,
"value": 305.76
},
"offPeak": {"rate": 0.2847,
"value": 305.76
},
"offPeakStep1": {"rate": 0.2847,
"value": 305.76
},
"offPeakStep2": {"rate": 0.2847,
"value": 305.76
},
"shoulder": {"rate": 0.2847,
"value": 305.76
},
"controlledLoad1": {"rate": 0.2847,
"value": 305.76
},
"controlledLoad2": {"rate": 0.2847,
"value": 305.76
},
"supplyCharge": {"rate": 0.2847,
"value": 305.76
}
}
],
"solar": true
},
"concessionOrRebateAmount": 0,
"concessionOrRebateApplied": false,
"maximumSaving": 6.95,
"defaultOffer": {"name": "Default Market Offer (DMO)",
"value": "For an average household in the AUSGRID network using 3,900kWh/year on a flat rate tariff.\nAmounts do not include any concessions or rebates, feed in tariffs, or green energy charges. Amounts include all other benefits (including discounts) that you're eligible for, and GST (unless otherwise stated).\nYour actual bill will vary depending on your actual usage, tariff type and distributor."
},
"marketDisclosure": {"name": "Market Disclosure",
"value": "The energy plans compared on this site are not representative of all plans available in the market. We do not compare all brands in the market, or all products offered by all brands."
},
"source": "Bill",
"concessionCards": [{"name": "DVA Gold Card (War Widows Pension only)",
"value": "DVAGC_WW"
}
],
"concessionCardMessage": [{"type": "text",
"name": "Billing Address",
"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis auctor erat ligula, faucibus mattis felis vestibulum et",
"key": "understand_and_agree",
"attribute": "bold",
"confirmation": "optional",
"parameters": {"{{parameter name}}": {"type": "link",
"value": "https://www.accurassi.com"
}
},
"children": [{ }
]
}
],
"version": "200.132bfab"
}

/market/compare/cdr

Compare using CDR data. This data is then used to compare the bill against the whole market. A personalised comparison is returned that is a best fit for the customer's energy profile.

header Parameters

clientCode required	string This value will be provided by Accurassi during on-boarding.
clientID required	string This value will be provided by Accurassi during on-boarding. The clientID is paired with clientCode and used for authentication. This value should never be published on a public facing site.

Request Body schema: application/json

correlationId	string <uuid> User generated, unique identifier for comparison. This ID allows you to match the comparison against a record in your system
required	object CDR data

Responses

Request samples

Payload
Python
NodeJS
cURL

Content type

application/json

{"correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"cdrData": {"consentId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"accountName": "John Smith",
"accountNumber": "4813 741 128",
"domestic": true,
"averageDailyLoad": 20,
"averageHourlyUsage": [ ],
"dateFrom": "2018-11-03",
"dateTo": "2019-02-08",
"gst": 88.46,
"invoiceNumber": "",
"nmi": "41035337484",
"supplyAddress": "Level 3, 9 Help Street, Chatswood, NSW, 2067",
"state": "NSW",
"postcode": "2067",
"supplyDays": 93,
"totalAmount": 884.6,
"tariffType": "SR",
"smartMeter": false,
"usage": {"controlledLoad1": {"qty": 0,
"rate": 0,
"chg": 0
},
"controlledLoad2": {"qty": 0,
"rate": 0,
"chg": 0
},
"demand": {"qty": 0,
"rate": 0,
"chg": 0
},
"offPeak": {"qty": 0,
"rate": 0,
"chg": 0
},
"offPeakDemand": {"qty": 0,
"rate": 0,
"chg": 0
},
"peak": {"qty": 0,
"rate": 0,
"chg": 0
},
"shoulder": {"qty": 0,
"rate": 0,
"chg": 0
},
"shoulder1": {"qty": 0,
"rate": 0,
"chg": 0
},
"shoulder2": {"qty": 0,
"rate": 0,
"chg": 0
},
"solar": {"qty": 0,
"rate": 0,
"chg": 0
},
"supply": {"qty": 0,
"rate": 0,
"chg": 0
}
}
}
}

Response samples

Content type

application/json

Example

ComparisonResponse

{"correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"comparisonDate": "2019-10-18T07:09:21.882+11:00",
"plans": [{"id": 100456,
"name": "Accurassi Energy All Time Saver",
"retailer": {"id": 123456,
"name": "Accurassi Energy Retailer",
"phone": "+555 13384337",
"email": "energy@accurassi.com"
},
"referencePrice": {"equivalence": "less than",
"percentDifferent": 22,
"retailerAnnualEstimate": 4000,
"averageAnnualConsumption": 10027
},
"estimatedTotalCost": 704.8,
"estimatedBaseCost": 704.8,
"estimatedSaving": 179.8,
"rates": {"name": "Rates",
"value": [{"name": "Peak Rate",
"value": 23.94,
"unit": "cents per kW hour"
}
]
},
"type": "SR",
"url": "https://www.energymadeeasy.gov.au/offer/1008406?postcode=2067",
"defaultOfferMessage": "The annualised price of this plan is $1,764 and is 14% less than the Reference Price.",
"payOnTimeRequired": false,
"directDebitRequired": false,
"discounts": {"payOnTime": 60.23,
"directDebit": 43.84
},
"benefits": {"name": "Benefits",
"discounts": [{"name": "Guaranteed discount on total bill(usage and supply)",
"value": "13%",
"condition": "Discount applies to GST exclusive usage and supply charges, and not to fees and other charges such as late payment fees or Greenpower."
}
],
"incentives": [{"name": "$50 Welcome credit (GST incl)",
"value": "We'll provide the welcome credit for each new supply address you sign up via www.accurassi.com, as an offset against the charges on your first electricity bill (excluding a final bill). Terms and conditions apply."
}
]
},
"contract": {"name": "Contract Details",
"value": [{"name": "string",
"value": ["string"
]
}
]
},
"conditions": {"name": "Conditions",
"value": [{"name": "string",
"value": ["string"
]
}
]
},
"paymentOptions": {"name": "string",
"value": ["string"
]
},
"greenOptions": {"name": "string",
"value": ["string"
]
},
"feesAndCharges": {"name": "string",
"value": [{"name": "string",
"value": "string",
"description": "string"
}
],
"additionalFeeInfo": ""
}
}
],
"currentBillData": {"accountName": "John Smith",
"accountAddress": "Level 3, 9 Help Street, Chatswood, NSW, 2067",
"supplyAddress": "Level 3, 9 Help Street, Chatswood, NSW, 2067",
"tariffType": "SR",
"usage": {"controlLoad1": 0,
"controlLoad2": 0,
"op": 0,
"opStep1": 0,
"opStep2": 0,
"pk": 500,
"pkStep1": 0,
"pkStep2": 0,
"pkStep3": 0,
"sh": 0,
"solar": 0,
"supply": 0
},
"retailer": {"id": 123456,
"name": "Accurassi Energy Retailer",
"phone": "+555 13384337",
"email": "energy@accurassi.com"
},
"nmi": "41035337484",
"accountNumber": "4813 741 128",
"fuelType": "E",
"GSTInclusive": "false",
"seasonalBill": false,
"billDateFrom": "2018-11-03T00:00:00.000+11:00",
"billDateTo": "2019-02-08T00:00:00.000+11:00",
"days": 93,
"actualPlanTotalCost": 884.598,
"discount": 0,
"periods": [{"peak": {"rate": 0.2847,
"value": 305.76
},
"peakStep1": {"rate": 0.2847,
"value": 305.76
},
"peakStep2": {"rate": 0.2847,
"value": 305.76
},
"peakStep3": {"rate": 0.2847,
"value": 305.76
},
"offPeak": {"rate": 0.2847,
"value": 305.76
},
"offPeakStep1": {"rate": 0.2847,
"value": 305.76
},
"offPeakStep2": {"rate": 0.2847,
"value": 305.76
},
"shoulder": {"rate": 0.2847,
"value": 305.76
},
"controlledLoad1": {"rate": 0.2847,
"value": 305.76
},
"controlledLoad2": {"rate": 0.2847,
"value": 305.76
},
"supplyCharge": {"rate": 0.2847,
"value": 305.76
}
}
],
"solar": true
},
"concessionOrRebateAmount": 0,
"concessionOrRebateApplied": false,
"maximumSaving": 6.95,
"defaultOffer": {"name": "Default Market Offer (DMO)",
"value": "For an average household in the AUSGRID network using 3,900kWh/year on a flat rate tariff.\nAmounts do not include any concessions or rebates, feed in tariffs, or green energy charges. Amounts include all other benefits (including discounts) that you're eligible for, and GST (unless otherwise stated).\nYour actual bill will vary depending on your actual usage, tariff type and distributor."
},
"marketDisclosure": {"name": "Market Disclosure",
"value": "The energy plans compared on this site are not representative of all plans available in the market. We do not compare all brands in the market, or all products offered by all brands."
},
"source": "Bill",
"concessionCards": [{"name": "DVA Gold Card (War Widows Pension only)",
"value": "DVAGC_WW"
}
],
"concessionCardMessage": [{"type": "text",
"name": "Billing Address",
"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis auctor erat ligula, faucibus mattis felis vestibulum et",
"key": "understand_and_agree",
"attribute": "bold",
"confirmation": "optional",
"parameters": {"{{parameter name}}": {"type": "link",
"value": "https://www.accurassi.com"
}
},
"children": [{ }
]
}
],
"version": "200.132bfab"
}

/market/compare/meter

Compare using meter data. For the passed address or NMI the meter type and average daily load are used to return a personalised comparison that is a best fit for the customers energy profile.

header Parameters

clientCode required	string This value will be provided by Accurassi during on-boarding.
clientID required	string This value will be provided by Accurassi during on-boarding. The clientID is paired with clientCode and used for authentication. This value should never be published on a public facing site.

Request Body schema: application/json

correlationId	string <uuid> User generated, unique identifier for comparison. This ID allows you to match the comparison against a record in your system
address	string Address of the property
nmi	string National Meter Index (NMI) of the property
planLimit	integer Default: 30 The maximum number of plans to return

Responses

Request samples

Payload
Python
NodeJS
cURL

Content type

application/json

{"correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"address": "4 Some Street, Some Suburn, NSW 2000",
"nmi": "4564321234",
"planLimit": 30
}

Response samples

Content type

application/json

Example

ComparisonResponse

{"correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"comparisonDate": "2019-10-18T07:09:21.882+11:00",
"plans": [{"id": 100456,
"name": "Accurassi Energy All Time Saver",
"retailer": {"id": 123456,
"name": "Accurassi Energy Retailer",
"phone": "+555 13384337",
"email": "energy@accurassi.com"
},
"referencePrice": {"equivalence": "less than",
"percentDifferent": 22,
"retailerAnnualEstimate": 4000,
"averageAnnualConsumption": 10027
},
"estimatedTotalCost": 704.8,
"estimatedBaseCost": 704.8,
"estimatedSaving": 179.8,
"rates": {"name": "Rates",
"value": [{"name": "Peak Rate",
"value": 23.94,
"unit": "cents per kW hour"
}
]
},
"type": "SR",
"url": "https://www.energymadeeasy.gov.au/offer/1008406?postcode=2067",
"defaultOfferMessage": "The annualised price of this plan is $1,764 and is 14% less than the Reference Price.",
"payOnTimeRequired": false,
"directDebitRequired": false,
"discounts": {"payOnTime": 60.23,
"directDebit": 43.84
},
"benefits": {"name": "Benefits",
"discounts": [{"name": "Guaranteed discount on total bill(usage and supply)",
"value": "13%",
"condition": "Discount applies to GST exclusive usage and supply charges, and not to fees and other charges such as late payment fees or Greenpower."
}
],
"incentives": [{"name": "$50 Welcome credit (GST incl)",
"value": "We'll provide the welcome credit for each new supply address you sign up via www.accurassi.com, as an offset against the charges on your first electricity bill (excluding a final bill). Terms and conditions apply."
}
]
},
"contract": {"name": "Contract Details",
"value": [{"name": "string",
"value": ["string"
]
}
]
},
"conditions": {"name": "Conditions",
"value": [{"name": "string",
"value": ["string"
]
}
]
},
"paymentOptions": {"name": "string",
"value": ["string"
]
},
"greenOptions": {"name": "string",
"value": ["string"
]
},
"feesAndCharges": {"name": "string",
"value": [{"name": "string",
"value": "string",
"description": "string"
}
],
"additionalFeeInfo": ""
}
}
],
"currentBillData": {"accountName": "John Smith",
"accountAddress": "Level 3, 9 Help Street, Chatswood, NSW, 2067",
"supplyAddress": "Level 3, 9 Help Street, Chatswood, NSW, 2067",
"tariffType": "SR",
"usage": {"controlLoad1": 0,
"controlLoad2": 0,
"op": 0,
"opStep1": 0,
"opStep2": 0,
"pk": 500,
"pkStep1": 0,
"pkStep2": 0,
"pkStep3": 0,
"sh": 0,
"solar": 0,
"supply": 0
},
"retailer": {"id": 123456,
"name": "Accurassi Energy Retailer",
"phone": "+555 13384337",
"email": "energy@accurassi.com"
},
"nmi": "41035337484",
"accountNumber": "4813 741 128",
"fuelType": "E",
"GSTInclusive": "false",
"seasonalBill": false,
"billDateFrom": "2018-11-03T00:00:00.000+11:00",
"billDateTo": "2019-02-08T00:00:00.000+11:00",
"days": 93,
"actualPlanTotalCost": 884.598,
"discount": 0,
"periods": [{"peak": {"rate": 0.2847,
"value": 305.76
},
"peakStep1": {"rate": 0.2847,
"value": 305.76
},
"peakStep2": {"rate": 0.2847,
"value": 305.76
},
"peakStep3": {"rate": 0.2847,
"value": 305.76
},
"offPeak": {"rate": 0.2847,
"value": 305.76
},
"offPeakStep1": {"rate": 0.2847,
"value": 305.76
},
"offPeakStep2": {"rate": 0.2847,
"value": 305.76
},
"shoulder": {"rate": 0.2847,
"value": 305.76
},
"controlledLoad1": {"rate": 0.2847,
"value": 305.76
},
"controlledLoad2": {"rate": 0.2847,
"value": 305.76
},
"supplyCharge": {"rate": 0.2847,
"value": 305.76
}
}
],
"solar": true
},
"concessionOrRebateAmount": 0,
"concessionOrRebateApplied": false,
"maximumSaving": 6.95,
"defaultOffer": {"name": "Default Market Offer (DMO)",
"value": "For an average household in the AUSGRID network using 3,900kWh/year on a flat rate tariff.\nAmounts do not include any concessions or rebates, feed in tariffs, or green energy charges. Amounts include all other benefits (including discounts) that you're eligible for, and GST (unless otherwise stated).\nYour actual bill will vary depending on your actual usage, tariff type and distributor."
},
"marketDisclosure": {"name": "Market Disclosure",
"value": "The energy plans compared on this site are not representative of all plans available in the market. We do not compare all brands in the market, or all products offered by all brands."
},
"source": "Bill",
"concessionCards": [{"name": "DVA Gold Card (War Widows Pension only)",
"value": "DVAGC_WW"
}
],
"concessionCardMessage": [{"type": "text",
"name": "Billing Address",
"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis auctor erat ligula, faucibus mattis felis vestibulum et",
"key": "understand_and_agree",
"attribute": "bold",
"confirmation": "optional",
"parameters": {"{{parameter name}}": {"type": "link",
"value": "https://www.accurassi.com"
}
},
"children": [{ }
]
}
],
"version": "200.132bfab"
}

/market/compare/postcode

Uses benchmark and reference pricing to return the most cost effective Single Rate plans for the postcode.

header Parameters

clientCode required	string This value will be provided by Accurassi during on-boarding.
clientID required	string This value will be provided by Accurassi during on-boarding. The clientID is paired with clientCode and used for authentication. This value should never be published on a public facing site.

Request Body schema: application/json

correlationId	string <uuid> User generated, unique identifier for comparison. This ID allows you to match the comparison against a record in your system
postcode required	string Postcode of the property
planLimit	integer Default: 30 The maximum number of plans to return

Responses

Request samples

Payload
Python
NodeJS
cURL

Content type

application/json

{"correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"postcode": "2000",
"planLimit": 30
}

Response samples

Content type

application/json

Example

ComparisonResponse

{"correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"comparisonDate": "2019-10-18T07:09:21.882+11:00",
"plans": [{"id": 100456,
"name": "Accurassi Energy All Time Saver",
"retailer": {"id": 123456,
"name": "Accurassi Energy Retailer",
"phone": "+555 13384337",
"email": "energy@accurassi.com"
},
"referencePrice": {"equivalence": "less than",
"percentDifferent": 22,
"retailerAnnualEstimate": 4000,
"averageAnnualConsumption": 10027
},
"estimatedTotalCost": 704.8,
"estimatedBaseCost": 704.8,
"estimatedSaving": 179.8,
"rates": {"name": "Rates",
"value": [{"name": "Peak Rate",
"value": 23.94,
"unit": "cents per kW hour"
}
]
},
"type": "SR",
"url": "https://www.energymadeeasy.gov.au/offer/1008406?postcode=2067",
"defaultOfferMessage": "The annualised price of this plan is $1,764 and is 14% less than the Reference Price.",
"payOnTimeRequired": false,
"directDebitRequired": false,
"discounts": {"payOnTime": 60.23,
"directDebit": 43.84
},
"benefits": {"name": "Benefits",
"discounts": [{"name": "Guaranteed discount on total bill(usage and supply)",
"value": "13%",
"condition": "Discount applies to GST exclusive usage and supply charges, and not to fees and other charges such as late payment fees or Greenpower."
}
],
"incentives": [{"name": "$50 Welcome credit (GST incl)",
"value": "We'll provide the welcome credit for each new supply address you sign up via www.accurassi.com, as an offset against the charges on your first electricity bill (excluding a final bill). Terms and conditions apply."
}
]
},
"contract": {"name": "Contract Details",
"value": [{"name": "string",
"value": ["string"
]
}
]
},
"conditions": {"name": "Conditions",
"value": [{"name": "string",
"value": ["string"
]
}
]
},
"paymentOptions": {"name": "string",
"value": ["string"
]
},
"greenOptions": {"name": "string",
"value": ["string"
]
},
"feesAndCharges": {"name": "string",
"value": [{"name": "string",
"value": "string",
"description": "string"
}
],
"additionalFeeInfo": ""
}
}
],
"currentBillData": {"accountName": "John Smith",
"accountAddress": "Level 3, 9 Help Street, Chatswood, NSW, 2067",
"supplyAddress": "Level 3, 9 Help Street, Chatswood, NSW, 2067",
"tariffType": "SR",
"usage": {"controlLoad1": 0,
"controlLoad2": 0,
"op": 0,
"opStep1": 0,
"opStep2": 0,
"pk": 500,
"pkStep1": 0,
"pkStep2": 0,
"pkStep3": 0,
"sh": 0,
"solar": 0,
"supply": 0
},
"retailer": {"id": 123456,
"name": "Accurassi Energy Retailer",
"phone": "+555 13384337",
"email": "energy@accurassi.com"
},
"nmi": "41035337484",
"accountNumber": "4813 741 128",
"fuelType": "E",
"GSTInclusive": "false",
"seasonalBill": false,
"billDateFrom": "2018-11-03T00:00:00.000+11:00",
"billDateTo": "2019-02-08T00:00:00.000+11:00",
"days": 93,
"actualPlanTotalCost": 884.598,
"discount": 0,
"periods": [{"peak": {"rate": 0.2847,
"value": 305.76
},
"peakStep1": {"rate": 0.2847,
"value": 305.76
},
"peakStep2": {"rate": 0.2847,
"value": 305.76
},
"peakStep3": {"rate": 0.2847,
"value": 305.76
},
"offPeak": {"rate": 0.2847,
"value": 305.76
},
"offPeakStep1": {"rate": 0.2847,
"value": 305.76
},
"offPeakStep2": {"rate": 0.2847,
"value": 305.76
},
"shoulder": {"rate": 0.2847,
"value": 305.76
},
"controlledLoad1": {"rate": 0.2847,
"value": 305.76
},
"controlledLoad2": {"rate": 0.2847,
"value": 305.76
},
"supplyCharge": {"rate": 0.2847,
"value": 305.76
}
}
],
"solar": true
},
"concessionOrRebateAmount": 0,
"concessionOrRebateApplied": false,
"maximumSaving": 6.95,
"defaultOffer": {"name": "Default Market Offer (DMO)",
"value": "For an average household in the AUSGRID network using 3,900kWh/year on a flat rate tariff.\nAmounts do not include any concessions or rebates, feed in tariffs, or green energy charges. Amounts include all other benefits (including discounts) that you're eligible for, and GST (unless otherwise stated).\nYour actual bill will vary depending on your actual usage, tariff type and distributor."
},
"marketDisclosure": {"name": "Market Disclosure",
"value": "The energy plans compared on this site are not representative of all plans available in the market. We do not compare all brands in the market, or all products offered by all brands."
},
"source": "Bill",
"concessionCards": [{"name": "DVA Gold Card (War Widows Pension only)",
"value": "DVAGC_WW"
}
],
"concessionCardMessage": [{"type": "text",
"name": "Billing Address",
"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis auctor erat ligula, faucibus mattis felis vestibulum et",
"key": "understand_and_agree",
"attribute": "bold",
"confirmation": "optional",
"parameters": {"{{parameter name}}": {"type": "link",
"value": "https://www.accurassi.com"
}
},
"children": [{ }
]
}
],
"version": "200.132bfab"
}

/market/eic

Before entering into a contract with a new energy retailer, consumers are first obliged to review the retailer's contractual terms and conditions, confirm they understand these terms as well as give explicit consent for the switch to occur. This API call retrieves all information that must be displayed in order for a compliant EIC to be captured from a consumer.

header Parameters

clientCode required	string This value will be provided by Accurassi during on-boarding.
clientID required	string This value will be provided by Accurassi during on-boarding. The clientID is paired with clientCode and used for authentication. This value should never be published on a public facing site.

Request Body schema: application/json

correlationId required	string <uuid> The correlationId of the comparison request.
planId required	string <string> Unique ID of plan, selected from comparison results
	object (EICDetails) Information for the residents of the property being supplied

Responses

Request samples

Payload
Python
NodeJS
cURL

Content type

application/json

{"correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"planId": "123456",
"details": {"lifeSupport": {"type": "IPDM",
"description": "string"
},
"concessionCard": {"number": "123456789",
"type": "DVAGC_EDA",
"date": "2018-10",
"firstName": "John",
"lastName": "Doe"
}
}
}

Response samples

Content type

application/json

Example

EICResponse

{"correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"plan": {"id": 100456,
"name": "Accurassi Energy All Time Saver",
"retailer": {"id": 123456,
"name": "Accurassi Energy Retailer",
"phone": "+555 13384337",
"email": "energy@accurassi.com"
},
"referencePrice": {"equivalence": "less than",
"percentDifferent": 22,
"retailerAnnualEstimate": 4000,
"averageAnnualConsumption": 10027
},
"estimatedTotalCost": 704.8,
"estimatedBaseCost": 704.8,
"estimatedSaving": 179.8,
"rates": {"name": "Rates",
"value": [{"name": "Peak Rate",
"value": 23.94,
"unit": "cents per kW hour"
}
]
},
"type": "SR",
"url": "https://www.energymadeeasy.gov.au/offer/1008406?postcode=2067",
"defaultOfferMessage": "The annualised price of this plan is $1,764 and is 14% less than the Reference Price.",
"payOnTimeRequired": false,
"directDebitRequired": false,
"discounts": {"payOnTime": 60.23,
"directDebit": 43.84
},
"benefits": {"name": "Benefits",
"discounts": [{"name": "Guaranteed discount on total bill(usage and supply)",
"value": "13%",
"condition": "Discount applies to GST exclusive usage and supply charges, and not to fees and other charges such as late payment fees or Greenpower."
}
],
"incentives": [{"name": "$50 Welcome credit (GST incl)",
"value": "We'll provide the welcome credit for each new supply address you sign up via www.accurassi.com, as an offset against the charges on your first electricity bill (excluding a final bill). Terms and conditions apply."
}
]
},
"contract": {"name": "Contract Details",
"value": [{"name": "string",
"value": ["string"
]
}
]
},
"conditions": {"name": "Conditions",
"value": [{"name": "string",
"value": ["string"
]
}
]
},
"paymentOptions": {"name": "string",
"value": ["string"
]
},
"greenOptions": {"name": "string",
"value": ["string"
]
},
"feesAndCharges": {"name": "string",
"value": [{"name": "string",
"value": "string",
"description": "string"
}
],
"additionalFeeInfo": ""
}
},
"eic": [{"type": "text",
"name": "Billing Address",
"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis auctor erat ligula, faucibus mattis felis vestibulum et",
"key": "understand_and_agree",
"attribute": "bold",
"confirmation": "optional",
"parameters": {"{{parameter name}}": {"type": "link",
"value": "https://www.accurassi.com"
}
},
"children": [{ }
]
}
],
"version": "200.132bfab"
}

Switch API

/market/switch

The bill payer has uploaded their current bill, selected a new plan, accepted the terms and conditions and given their consent for the switch to occur. This API call will finalise the switch request and send all the customers data along with the requested plan to the selected retailer.

header Parameters

clientCode required	string This value will be provided by Accurassi during on-boarding.
clientID required	string This value will be provided by Accurassi during on-boarding. The clientID is paired with clientCode and used for authentication. This value should never be published on a public facing site.

Request Body schema: application/json

correlationId required	string <uuid> The correlationId of the comparison request.
required	object (SwitchDetails) Details required to switch retailers
confirmation	Array of strings Array of strings containing all the keys of the elements that required confirmation in the EIC. The absence of any key for a mandatory confirmation will result in an error response.

Responses

Request samples

Payload
Python
NodeJS
cURL

Content type

application/json

{"correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"details": {"customerDetails": {"name": {"title": "Miss",
"first": "Jane",
"middle": "Joan",
"last": "Doe"
},
"address": "Level 3, 9 Help Street, Chatswood, NSW 2067",
"email": "jane.doe@email.com",
"mobile": "+555 13384337",
"dateOfBirth": "22/04/1983",
"evidenceOfIdentity": {"type": "passport",
"number": "B765435",
"country": "Australia",
"expiryDate": "10/2022"
}
},
"paymentDetails": {"directDebit": {"accountName": "John Doe",
"accountBSB": "062000",
"accountNumber": "54645645"
}
}
},
"confirmation": ["terms_and_conditions",
"product_details"
]
}

Response samples

Content type

application/json

Example

SwitchResponse

{"correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"reference": "bdacdabc-e3f7-4f6d-93d3-ffa83e419762",
"switchDate": "2018-11-03T00:00:00.000+11:00",
"plan": {"id": 100456,
"name": "Accurassi Energy All Time Saver",
"retailer": {"id": 123456,
"name": "Accurassi Energy Retailer",
"phone": "+555 13384337",
"email": "energy@accurassi.com"
},
"referencePrice": {"equivalence": "less than",
"percentDifferent": 22,
"retailerAnnualEstimate": 4000,
"averageAnnualConsumption": 10027
},
"estimatedTotalCost": 704.8,
"estimatedBaseCost": 704.8,
"estimatedSaving": 179.8,
"rates": {"name": "Rates",
"value": [{"name": "Peak Rate",
"value": 23.94,
"unit": "cents per kW hour"
}
]
},
"type": "SR",
"url": "https://www.energymadeeasy.gov.au/offer/1008406?postcode=2067",
"defaultOfferMessage": "The annualised price of this plan is $1,764 and is 14% less than the Reference Price.",
"payOnTimeRequired": false,
"directDebitRequired": false,
"discounts": {"payOnTime": 60.23,
"directDebit": 43.84
},
"benefits": {"name": "Benefits",
"discounts": [{"name": "Guaranteed discount on total bill(usage and supply)",
"value": "13%",
"condition": "Discount applies to GST exclusive usage and supply charges, and not to fees and other charges such as late payment fees or Greenpower."
}
],
"incentives": [{"name": "$50 Welcome credit (GST incl)",
"value": "We'll provide the welcome credit for each new supply address you sign up via www.accurassi.com, as an offset against the charges on your first electricity bill (excluding a final bill). Terms and conditions apply."
}
]
},
"contract": {"name": "Contract Details",
"value": [{"name": "string",
"value": ["string"
]
}
]
},
"conditions": {"name": "Conditions",
"value": [{"name": "string",
"value": ["string"
]
}
]
},
"paymentOptions": {"name": "string",
"value": ["string"
]
},
"greenOptions": {"name": "string",
"value": ["string"
]
},
"feesAndCharges": {"name": "string",
"value": [{"name": "string",
"value": "string",
"description": "string"
}
],
"additionalFeeInfo": ""
}
},
"nextSteps": [{"type": "text",
"name": "Billing Address",
"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis auctor erat ligula, faucibus mattis felis vestibulum et",
"key": "understand_and_agree",
"attribute": "bold",
"confirmation": "optional",
"parameters": {"{{parameter name}}": {"type": "link",
"value": "https://www.accurassi.com"
}
},
"children": [{ }
]
}
],
"version": "200.132bfab"
}

Plan Comparison APIs (v4)

Comparison API

/market/compare

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

/market/compare/cdr

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

/market/compare/meter

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

/market/compare/postcode

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Explicit Informed Consent API

/market/eic

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Switch API

/market/switch

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples