APG PayAPG Paydocs

Loans

List loan statement lines

GET/loan-statement-lines
Request
GEThttps://api.tst.au.apgpay.dev/loan-statement-lines
curl -X GET https://api.tst.au.apgpay.dev/loan-statement-lines \
  -H "Authorization: Bearer $API_KEY"

Return the lines of loan statements that a search names. Platform staff only. Lines page by page.

Permissions

Required permission
loanStatements:query

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

Query parameters

pageinteger (int32)

1-based page number.

limitinteger (int32)

Maximum items per page.

columnsarray of SlinColumn

Columns to include, in order, when asking for text/csv. Omit for all of them. Sending it with application/json is a 400.

loanStatementIdone of array of string, string

Lines of this statement, or of any of these, up to 100 by repeating the parameter.

customerIdstring

Lines of this customer's statements.

loanIdstring

Lines of this loan's statements.

createdFromstring (date-time)

Lines of statements made at or after this instant.

createdTostring (date-time)

Lines of statements made at or before this instant.

amountFrominteger (int64)

Lines of at least this amount, in minor units of the statement's currency. A refund's amount is negative.

amountTointeger (int64)

Lines of at most this amount, in minor units of the statement's currency. A refund's amount is negative.

ticketNumberstring

Lines whose ticket number contains this text. Case matters.

travellerNamestring

Lines whose traveller's name contains this text. Case matters.

dbiFieldSlinDbiField

Which data-based invoicing reference dbiValue is of. Give it with dbiValue.

PkDsKsAeIkBdPrAuAkRz
dbiValuestring

Lines whose dbiField reference is exactly this. Give it with dbiField.

issuerTransactionIdstring

Lines of this card transaction, a whole identifier.

transactionIdstring

Lines of the card transactions linked to this one, a whole identifier.

galaxyTransactionIdstring

Lines whose Galaxy transaction reference is exactly this.

financialTransactionIdstring

Lines whose financial transaction identifier is exactly this.

Responses

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

Discriminated by type
type = "SlinPageAttributes"
hasMorebooleanrequired

Whether further items exist after this page.

Example true

nextStartingAfterstring

Id to pass as startingAfter to fetch the next page. Present in cursor mode only.

totalCountinteger (int64)

Total items matching the query.

Example 42

pageinteger (int32)

The 1-based page returned. Present in offset mode only.

Example 1250

totalPagesinteger (int32)

Total pages available. Present in offset mode only.

Example 1250

Example
{
  "type": "SlinPageAttributes",
  "data": [
    {
      "type": "SlinViewAttributes",
      "loanStatementId": "lstmt_9f2Kd8QpLzXw",
      "referenceStatementId": "your-own-reference",
      "statementCreatedAt": "2026-08-19T04:21:07Z",
      "loanId": "loan_9f2Kd8QpLzXw",
      "loanAccountName": "Ada Lovelace",
      "referenceLoanId": "your-own-reference",
      "customerId": "cust_9f2Kd8QpLzXw",
      "customerName": "Ada Lovelace",
      "kind": "Charge",
      "entryId": "string",
      "description": "string",
      "postedAt": "2026-08-19T04:21:07Z",
      "issuerTransactionId": "itxn_9f2Kd8QpLzXw",
      "transactionId": "tran_9f2Kd8QpLzXw",
      "galaxyTransactionId": "tran_9f2Kd8QpLzXw",
      "financialTransactionId": "tran_9f2Kd8QpLzXw",
      "approvalCode": "string",
      "openLoop": true,
      "cardType": "Uatp",
      "billing": {
        "type": "SlinBillingAttributes",
        "currency": "AUD",
        "netAmount": 1250,
        "taxAmount": 1250,
        "grossAmount": 1250,
        "taxRate": "0.9412",
        "taxType": "string"
      },
      "sales": {
        "type": "SlinSalesAttributes",
        "currency": "AUD",
        "netAmount": 1250,
        "taxAmount": 1250,
        "grossAmount": 1250,
        "exchangeRate": "0.9412"
      },
      "serviceType": "Flight",
      "ticketNumber": "string",
      "travellerName": "Ada Lovelace",
      "routing": "string",
      "bookingClass": "string",
      "airlineCode": "string",
      "salesDate": "2026-08-19",
      "travelDate": "2026-08-19",
      "merchantName": "Ada Lovelace",
      "merchantCategoryCode": "string",
      "agencyDeliveryNoteNumber": "string",
      "supplierIataNumber": "string",
      "serviceLines": [
        "string"
      ],
      "dbi": {
        "type": "SlinDbiAttributes",
        "pk": "string",
        "ds": "string",
        "ks": "string",
        "ae": "string",
        "ik": "string",
        "bd": "string",
        "pr": "string",
        "au": "string",
        "ak": "string",
        "rz": "string"
      }
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses