Bill Extraction API (3.3)

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 us 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

Content type
application/json
{
  • "correlationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  • "ebillBase64": "QWNjdXJhc3NpIE1hcmtldFBsYWNlIEFQSQ=="
}

Response samples

Content type
application/json
{
  • "billData": {