v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Retrieve group ledger information (Available in points ledger)

This API allows you to retrieve the ledger information of the group.

get/pointsLedger/getCustomerLedgerInfo

Query parameters

sourcestring required

Enter the source of the group.

identifierNamestring required

Enter the identifier name such as, group id, external id.

identifierValuestring required

Enter the value of the identifier.

typestring required

Type of group. In this case, the value should be USERGROUP2.

limitstring

The maximum number of items to be retrieved.

offsetstring

The starting index for data retrieval.

Response

200

Example response

{
  "ledgerDetails": {
    "pageSize": 10,
    "totalEntries": 2,
    "pageCount": 1
  },
  "ledgerEntries": [
    {
      "eventLogId": 508308379,
      "eventName": "AllocateGoodwillPoints",
      "customerId": -2860,
      "ledgerCreatedDate": "2023-06-21 13:34:16.0",
      "entryDetails": [
        {
          "ledgerEntryType": "CREDIT",
          "points": "350.000",
          "pointsCategory": "Main",
          "programName": "Default Program",
          "programId": 469
        }
      ],
      "netPointsOnEvent": "350.000",
      "store": "test",
      "storeCode": "teststore",
      "tillCode": "neestoretillssnee23",
      "eventDetails": {
        "reason": "POINTS_ISSUE"
      }
    }
  ]
}