Skip to content

GET Membership Points Transactions by Criteria

Endpoint

URL: https://api.akaun.com/core2/tnt/dm/crm/membership-points-txn/backoffice-ep/lines/query
Method: GET
Headers:

  • Authorization: Bearer <token> (or an AccessId + AccessKey pair)
  • tenantCode: <Tenant Code>
  • Content-Type: application/json

Headers and credentials are described once, on the authentication page; this page does not repeat them.


Description

This endpoint retrieves membership points transaction based on filtering and pagination criteria.

Served by MembershipPointsTxnController (@GetMapping /lines/query); the filters are the fields of MembershipPointsTxnLineQueryCriteria. An earlier version of this page filtered the example on guid_pricing_scheme_hdr, which is not a field of that class and is silently ignored — filter on card_no or membership_hdr_guid.


cURL Example

curl 'https://api.akaun.com/core2/tnt/dm/crm/membership-points-txn/backoffice-ep/lines/query?limit=100&offset=0&calcTotalRecords=true&card_no=GS-0001234&txn_type=REWARD' \
  --header 'Authorization: <JWT Token>' \
  --header 'tenantCode: gadgetsphere'

Query Parameters

Pagination & Sorting

  • limit (default: 100)
  • offset (default: 0)
  • orderBy
  • order (ASC or DESC)
  • calcTotalRecords (boolean)

Filtering Fields

  • date_valid_from
  • date_valid_to
  • date_txn
  • date_txn_from
  • date_txn_to
  • txn_type
  • item_code
  • entity_hdr_guid (UUID)
  • membership_hdr_guid (UUID)
  • item_hdr_guid
  • company_guid (UUID)
  • branch_guid (UUID)
  • doc_hdr_guid
  • points_type
  • card_no
  • client_key
  • client_source
  • client_value
  • point_currency
  • point_currency_guid (UUID)
  • line_created_date_from
  • line_created_date_to
  • line_updated_date_from
  • line_updated_date_to
  • txn_count
  • positive_points_values
  • source
  • display_type
  • client_doc_1
  • client_doc_2
  • client_doc_3
  • client_doc_4
  • client_doc_5
  • client_doc_amount_1
  • client_doc_amount_2
  • client_doc_amount_3
  • client_doc_type_1
  • client_doc_type_2
  • client_doc_type_3
  • client_doc_type_4
  • client_doc_type_5

Also accepted: cancel_points_txn_line_guids, guids_generic_doc_line, plus the paging and status fields every criteria class inherits.


Response

Content-Type: application/json

Example Response

{
    "totalRecords": 1,
    "offset": 0,
    "limit": 100,
    "code": "OK_RESPONSE",
    "message": "",
    "data": [
        {
            "bl_crm_membership_points_txn_line": {
                "guid": "00000000-0000-4000-8000-000000000051",
                "txn_type": "REWARD",
                "branch_guid": "00000000-0000-4000-8000-000000000011",
                "company_guid": "00000000-0000-4000-8000-000000000010",
                "entity_hdr_guid": "00000000-0000-4000-8000-000000000022",
                "membership_hdr_guid": "00000000-0000-4000-8000-000000000021",
                "txn_hdr_guid": null,
                "card_no": "GS-0001234",
                "doc_hdr_guid": "00000000-0000-4000-8000-000000000061",
                "doc_line_guid": "00000000-0000-4000-8000-000000000062",
                "item_hdr_guid": "00000000-0000-4000-8000-000000000071",
                "item_code": "SMART-FLAG-128",
                "date_txn": "2026-03-14T06:12:00Z",
                "date_valid_from": "2026-03-14T00:00:00Z",
                "date_valid_to": "2027-03-13T23:59:59Z",
                "points_type": null,
                "points_value": 120,
                "points_balance": 1260,
                "remarks": null,
                "description": null,
                "client_key": null,
                "client_source": null,
                "status": "ACTIVE",
                "revision": "00000000-0000-4000-8000-000000000052",
                "vrsn": null,
                "point_currency_guid": "00000000-0000-4000-8000-000000000031",
                "property_json": null,
                "client_value": null,
                "point_currency": "GSPTS",
                "created_date": "2026-03-14T06:12:05.101Z",
                "updated_date": "2026-03-14T06:12:05.101Z",
                "created_by_subject_guid": "00000000-0000-4000-8000-000000000009",
                "updated_by_subject_guid": "00000000-0000-4000-8000-000000000009",
                "source": "GenericDocumentPointUpdateProcessor",
                "txn_count": null,
                "ocr_doc_hdr_guid": null,
                "ocr_doc_line_guid": null,
                "ctrl_acc_guid": "00000000-0000-4000-8000-000000000053",
                "client_doc_1": null,
                "client_doc_2": null,
                "client_doc_3": null,
                "client_doc_4": null,
                "client_doc_5": null,
                "client_txn_line_primary_key": null,
                "client_txn_type": null,
                "display_type": "DISPLAY",
                "client_doc_amount_1": null,
                "client_doc_amount_2": null,
                "client_doc_amount_3": null,
                "client_doc_type_1": null,
                "client_doc_type_2": null,
                "client_doc_type_3": null,
                "client_doc_type_4": null,
                "client_doc_type_5": null
            }
        }
    ]
}

Notes

  • calcTotalRecords=true adds overhead; enable only when the UI needs record count.
  • txn_type values written by the backend: REWARD and REDEEM for lines generated from a sales document (positive and negative point_amount respectively), EXPIRY for the scheduled expiry sweep, and CF / BF carry-forward rows; manual adjustments from Membership Admin carry source = ADMIN_MANUAL_POINTS_ASSIGNMENT.
  • The same mapping is served at /lines/query (no backoffice-ep) and has an etl-ep twin (…/membership-points-txn/etl-ep/lines/query).
  • Sample values are synthetic GadgetSphere data.