APG PayAPG Paydocs

Loans

Get loan statement

GET/loan-statements/{loanStatementId}
Request
GEThttps://api.tst.au.apgpay.dev/loan-statements/{loanStatementId}
curl -X GET https://api.tst.au.apgpay.dev/loan-statements/{loanStatementId} \
  -H "Authorization: Bearer $API_KEY"

Return one loan statement, with its entries.

Permissions

Required permission
loanStatements:query

Requires the `query` action on `loanStatements` for the supplied runtime context

Path parameters

loanStatementIdstring
required

Responses

The response is a tagged shape: type is always "LstmtViewAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "LstmtViewAttributes"
loanStatementIdLstmtIdrequired

Identifier of a loan statement.

Example lstmt_9f2Kd8QpLzXw

loanIdLoanIdrequired

Identifier of a loan.

Example loan_9f2Kd8QpLzXw

referenceStatementIdstringrequired

The platform's own reference for this statement, which is what appears on a remittance.

Example your-own-reference

merchantIdMchtIdrequired

The merchant the borrower trades with.

Example mcht_9f2Kd8QpLzXw

customerIdCustId

The borrowing customer, on a trading-account loan.

Example cust_9f2Kd8QpLzXw

statusLstmtStatusrequired
DraftOutstandingDueOverduePaidDefaultedCancelledUnknown
periodStartstring (date)required

First day of the period this statement covers.

Example 2026-08-19

periodEndstring (date)required

Last day of the period this statement covers.

Example 2026-08-19

billingDatestring (date)required

The day the statement was cut.

Example 2026-08-19

dueDatestring (date)required

The day payment falls due.

Example 2026-08-19

The cycle this statement was cut on.

The amounts on a loan statement. All are in the single currency given here.

The late-payment fee charged on this statement, where one has been.

linkedStatementIdLstmtId

For a statement that exists because of another, a late-fee invoice, the statement it relates to.

Example lstmt_9f2Kd8QpLzXw

narrativestring

An internal note about this statement.

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "type": "LstmtViewAttributes",
  "loanStatementId": "lstmt_9f2Kd8QpLzXw",
  "loanId": "loan_9f2Kd8QpLzXw",
  "referenceStatementId": "your-own-reference",
  "merchantId": "mcht_9f2Kd8QpLzXw",
  "customerId": "cust_9f2Kd8QpLzXw",
  "status": "Draft",
  "periodStart": "2026-08-19",
  "periodEnd": "2026-08-19",
  "billingDate": "2026-08-19",
  "dueDate": "2026-08-19",
  "statementFrequency": {
    "type": "LprodFrequencyDaily"
  },
  "amounts": {
    "type": "LstmtAmountsAttributes",
    "currency": "AUD",
    "net": 1250,
    "insurance": 1250,
    "tax": 1250,
    "billed": 1250,
    "fees": 1250,
    "paid": 1250,
    "outstanding": 1250,
    "credited": 1250
  },
  "entries": [
    {
      "type": "LstmtEntryAttributes",
      "entryType": "Charge",
      "description": "string",
      "amounts": {
        "type": "LstmtEntryAmountsAttributes",
        "currency": "AUD",
        "total": 1250,
        "tax": 1250,
        "net": 1250
      },
      "taxRate": 0.9412,
      "taxType": "string",
      "originalAmount": {
        "type": "IsoCurrencyAmount",
        "minorCurrencyUnits": 1250,
        "currency": "AUD"
      },
      "loanTransactionId": "ltxn_9f2Kd8QpLzXw",
      "entryAt": "2026-08-19T04:21:07Z"
    }
  ],
  "lateFee": {
    "type": "LstmtLateFeeAttributes",
    "amounts": {
      "type": "LstmtEntryAmountsAttributes",
      "currency": "AUD",
      "total": 1250,
      "tax": 1250,
      "net": 1250
    },
    "calculatedTo": "2026-08-19",
    "narrative": "string"
  },
  "linkedStatementId": "lstmt_9f2Kd8QpLzXw",
  "narrative": "string",
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses