Get Statements

Endpoint: GET /statements

The statements service is used to get the list of statement related information.

By default, all the latest statements of active and to be closed accounts are retrieved for the user.

Certain sites do not have both a statement date and a due date. When a fromDate is passed as an input, all the statements that have the due date on or after the passed date are retrieved.

For sites that do not have the due date, statements that have the statement date on or after the passed date are retrieved.

The default value of "isLatest" is true. To retrieve historical statements isLatest needs to be set to false.

Parameters

For the Request

Example Request

curl -X GET /statements \\
	-H 'Content-Type: application/json' \\
	-H "Authorization: Bearer {access_token}"

Example Response

{
  "statement": [
    {
      "apr": 0,
      "cashApr": 0,
      "billingPeriodStart": "string",
      "dueDate": "string",
      "interestAmount": {
        "amount": 0,
        "currency": "AUD"
      },
      "statementDate": "string",
      "cashAdvance": {
        "amount": 0,
        "currency": "AUD"
      },
      "billingPeriodEnd": "string",
      "principalAmount": {
        "amount": 0,
        "currency": "AUD"
      },
      "loanBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "amountDue": {
        "amount": 0,
        "currency": "AUD"
      },
      "accountId": 0,
      "lastUpdated": "string",
      "isLatest": true,
      "minimumPayment": {
        "amount": 0,
        "currency": "AUD"
      },
      "lastPaymentDate": "string",
      "lastPaymentAmount": {
        "amount": 0,
        "currency": "AUD"
      },
      "id": 0,
      "newCharges": {
        "amount": 0,
        "currency": "AUD"
      }
    }
  ]
}