APG PayAPG Paydocs

Reference data

List apg numbers

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

Return the identifiers of the records that APG numbers name, or the APG numbers that records hold, for one kind. A number or record that has no counterpart is left out.

Permissions

Required permission
merchantTravelData:query

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

Query parameters

pageinteger (int32)

1-based page number.

limitinteger (int32)

Maximum items per page.

columnsarray of ApgnumColumn

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

kindApgnumKind
required

What the numbers number, or what the ids identify. Required.

DailyCardFileRunIssuerTransactionLoanStatementMerchantStatementReceiptStatementReceiptBatchTravelBatchTravelEntryTravelFileTravelUpload
numberone of array of integer (int64), integer (int64)

The APG numbers to look up, one or up to 100 by repeating the parameter. A number that names no record is left out of the answer. Give this or id, not both.

idone of array of string, string

The identifiers, on this API, of records of the kind, one or up to 100 by repeating the parameter, whose APG numbers to look up. A record with no APG number is left out of the answer. Give this or number, not both.

Responses

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

Discriminated by type
type = "ApgnumPageAttributes"
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": "ApgnumPageAttributes",
  "data": [
    {
      "type": "ApgnumViewAttributes",
      "kind": "DailyCardFileRun",
      "number": 1250,
      "id": "string"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses