Bill Extraction API (v4)

Download OpenAPI specification:Download

Extract API extracts and standardises Australian energy retailer electricity and gas bills. This document relates to the following products

Resi Bill Extraction
SME Bill Extraction

Extract API

/extract

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

Responses

Request samples

Payload
Python
NodeJS
cURL

Content type

application/json

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

Response samples

Content type

application/json

{"billData": {"GST": 0.1,
"GSTInclusive": "false",
"acctAddress": "Level 2, 63 York St, Sydney, NSW, 2000",
"acctNMI": "4110000000",
"acctName": "John Smith",
"acctNumber": "994301",
"controlledLoad1": "false",
"controlledLoad2": "false",
"dateFrom": "2019-11-27",
"dateTo": "2020-03-11",
"demand": "true",
"discountPercentage": 0.28,
"distributor": "ENDEAVOUR",
"domestic": "true",
"exCharges": {"controlLoad1": 0,
"controlLoad2": 0,
"op": 0,
"opStep1": 0,
"opStep2": 0,
"pk": 88.05,
"pkStep1": 0,
"pkStep2": 0,
"pkStep3": 0,
"sh": 0,
"supply": 0
},
"exConcessions": {"credit": 56.85,
"credit2": 56.85,
"credit3": 56.85,
"credit4": 56.85,
"credit5": 56.85,
"credit6": 56.85,
"other": 2.5,
"other2": 2.5
},
"exConcessionsTotal": 56.85,
"exDiscounts": {"conditional": 0,
"creditDirectDebit": 0,
"creditExtraUsageChg": 0,
"directDebit": 74.12,
"guaranteed": 0,
"guaranteed2": 0,
"guaranteedSupply": 0,
"guaranteedUsage": 0,
"payontime": 0,
"payontime2": 0
},
"exDiscountsTotal": 74.12,
"exOtherCharges": {"mtrChg": 1.23,
"mtr2ndChg": 1.23,
"other": 1.23,
"otherAdj": 1.23,
"otherAdj2": 1.23,
"otherAdj3": 1.23,
"otherAdj4": 1.23,
"otherAdj5": 1.23,
"otherAdj6": 1.23,
"otherAdj7": 1.23,
"otherAdminChg": 1.23,
"otherAdmin2Chg": 1.23,
"otherAdmin3Chg": 1.23,
"otherCardProcessingFee": 1.23,
"otherPaymentFeeChg": 1.23,
"otherPayment2FeeChg": 1.23,
"otherPayment3FeeChg": 1.23,
"otherPayment4FeeChg": 1.23,
"otherPayment5FeeChg": 1.23,
"otherPayment6FeeChg": 1.23,
"otherPayment7FeeChg": 1.23,
"otherPayment8FeeChg": 1.23,
"otherPayment9FeeChg": 1.23,
"otherPaymentCounterChg": 1.23,
"otherLatePaymentChg": 1.23,
"otherOverduePaymentFeeChg": 1.23,
"otherPaperbillChg": 1.23,
"otherRoundingAdjChg": 1.23,
"otherUsageChg": 1.23,
"serviceChg": 1.23
},
"exTotalCharge": 751.01,
"exTotalChargeDiscounted": 620.04,
"fuelType": "E",
"period1DateFrom": "2019-11-27",
"period1DateTo": "2020-03-11",
"period2DateFrom": "2019-11-27",
"period2DateTo": "2020-03-11",
"period3DateFrom": "2019-11-27",
"period3DateTo": "2020-03-11",
"period4DateFrom": "2019-11-27",
"period4DateTo": "2020-03-11",
"periods": [{"controlledLoad1": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"controlledLoad2": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"op": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"opStep1": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"opStep2": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"pk": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"pkStep1": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"pkStep2": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"pkStep3": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"sh": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"solar": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"supply": {"charge": 98.05,
"qty": 78,
"rate": 1.257
}
}
],
"postcode": 2000,
"readType": "Actual",
"retailer": "AGL",
"retailerId": 123456,
"seasonal": false,
"serviceAddress": "Level 2, 63 York St, Sydney, NSW, 2000",
"solar": true,
"solarRebate": 308.38,
"state": "NSW",
"supplyDays": 106,
"tariffType": "SR",
"totalCharge": 517.73,
"totalChargeDiscounted": 373.66,
"totalDiscounts": 81.53,
"totalGST": 75.1,
"totalGSTDiscounted": 62,
"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
}
},
"client": "ACCURASSI",
"extractDate": "2021-04-22T11:18:44+10:00",
"status": {"code": 1039,
"message": "NMI is missing or invalid",
"customerPrompt": "Try another bill",
"errorType": "Data",
"product": "Extraction"
},
"uuid": "a61c6079-1201-4728-8a0c-5a54c0dafb6a",
"version": "3.3.5d0c592"
}

/extract/{correlationId}

path Parameters

correlationId

required

string

The correlation ID of a previous extraction.

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.

Responses

Response samples

Content type

application/json

{"billData": {"GST": 0.1,
"GSTInclusive": "false",
"acctAddress": "Level 2, 63 York St, Sydney, NSW, 2000",
"acctNMI": "4110000000",
"acctName": "John Smith",
"acctNumber": "994301",
"controlledLoad1": "false",
"controlledLoad2": "false",
"dateFrom": "2019-11-27",
"dateTo": "2020-03-11",
"demand": "true",
"discountPercentage": 0.28,
"distributor": "ENDEAVOUR",
"domestic": "true",
"exCharges": {"controlLoad1": 0,
"controlLoad2": 0,
"op": 0,
"opStep1": 0,
"opStep2": 0,
"pk": 88.05,
"pkStep1": 0,
"pkStep2": 0,
"pkStep3": 0,
"sh": 0,
"supply": 0
},
"exConcessions": {"credit": 56.85,
"credit2": 56.85,
"credit3": 56.85,
"credit4": 56.85,
"credit5": 56.85,
"credit6": 56.85,
"other": 2.5,
"other2": 2.5
},
"exConcessionsTotal": 56.85,
"exDiscounts": {"conditional": 0,
"creditDirectDebit": 0,
"creditExtraUsageChg": 0,
"directDebit": 74.12,
"guaranteed": 0,
"guaranteed2": 0,
"guaranteedSupply": 0,
"guaranteedUsage": 0,
"payontime": 0,
"payontime2": 0
},
"exDiscountsTotal": 74.12,
"exOtherCharges": {"mtrChg": 1.23,
"mtr2ndChg": 1.23,
"other": 1.23,
"otherAdj": 1.23,
"otherAdj2": 1.23,
"otherAdj3": 1.23,
"otherAdj4": 1.23,
"otherAdj5": 1.23,
"otherAdj6": 1.23,
"otherAdj7": 1.23,
"otherAdminChg": 1.23,
"otherAdmin2Chg": 1.23,
"otherAdmin3Chg": 1.23,
"otherCardProcessingFee": 1.23,
"otherPaymentFeeChg": 1.23,
"otherPayment2FeeChg": 1.23,
"otherPayment3FeeChg": 1.23,
"otherPayment4FeeChg": 1.23,
"otherPayment5FeeChg": 1.23,
"otherPayment6FeeChg": 1.23,
"otherPayment7FeeChg": 1.23,
"otherPayment8FeeChg": 1.23,
"otherPayment9FeeChg": 1.23,
"otherPaymentCounterChg": 1.23,
"otherLatePaymentChg": 1.23,
"otherOverduePaymentFeeChg": 1.23,
"otherPaperbillChg": 1.23,
"otherRoundingAdjChg": 1.23,
"otherUsageChg": 1.23,
"serviceChg": 1.23
},
"exTotalCharge": 751.01,
"exTotalChargeDiscounted": 620.04,
"fuelType": "E",
"period1DateFrom": "2019-11-27",
"period1DateTo": "2020-03-11",
"period2DateFrom": "2019-11-27",
"period2DateTo": "2020-03-11",
"period3DateFrom": "2019-11-27",
"period3DateTo": "2020-03-11",
"period4DateFrom": "2019-11-27",
"period4DateTo": "2020-03-11",
"periods": [{"controlledLoad1": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"controlledLoad2": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"op": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"opStep1": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"opStep2": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"pk": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"pkStep1": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"pkStep2": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"pkStep3": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"sh": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"solar": {"charge": 98.05,
"qty": 78,
"rate": 1.257
},
"supply": {"charge": 98.05,
"qty": 78,
"rate": 1.257
}
}
],
"postcode": 2000,
"readType": "Actual",
"retailer": "AGL",
"retailerId": 123456,
"seasonal": false,
"serviceAddress": "Level 2, 63 York St, Sydney, NSW, 2000",
"solar": true,
"solarRebate": 308.38,
"state": "NSW",
"supplyDays": 106,
"tariffType": "SR",
"totalCharge": 517.73,
"totalChargeDiscounted": 373.66,
"totalDiscounts": 81.53,
"totalGST": 75.1,
"totalGSTDiscounted": 62,
"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
}
},
"client": "ACCURASSI",
"extractDate": "2021-04-22T11:18:44+10:00",
"status": {"code": 1039,
"message": "NMI is missing or invalid",
"customerPrompt": "Try another bill",
"errorType": "Data",
"product": "Extraction"
},
"uuid": "a61c6079-1201-4728-8a0c-5a54c0dafb6a",
"version": "3.3.5d0c592"
}