---
title: "Get Points Ledger Explode info"
method: GET
path: "/pointsLedger/getLedgerExplodeInfo"
---

# Get Points Ledger Explode info

`GET /pointsLedger/getLedgerExplodeInfo`

Retrieves the points ledger explode info for customer/ user group.

> **Note:** This API returns promotion details and behavioral event metadata (field schema). It does not return custom payload attributes submitted with a behavioral event (such as `dollars_to_award` or `vendor_reference_id`). To retrieve those attributes, use [GET v2/events/event_data/{userId}](https://docs.capillarytech.com/reference/get-customer-events) instead.

## Query parameters

- `identifierName` string, required
- `identifierValue` string, required
- `source` string, required
- `eventIds` integer, required
- `accountId` string
- `getBillDetails` boolean
- `getPointsEarnedBreakup` boolean
- `getCustomFields` boolean
- `getExtendedFields` boolean
- `getMaxConversionDetails` boolean
- `getPaymentMode` string
- `type` string
- `isPrimaryUser` boolean
- `includeAlternateCurrencies` boolean
- `alternateCurrencyNames` string
- `eventName` string
- `eventReferenceIds` integer

## Response `200`

200

- union
  - object
    - `events` object[]
      - `eventLogId` integer
      - `eventName` string
      - `eventDetails` object
        - `eventTime` string
        - `tillId` integer
      - `billDetails` object
        - `type` string
        - `billNumber` string
        - `grossAmount` integer
        - `discount` integer
        - `billAmount` integer
        - `note` string
        - `source` string
        - `pointsEarned` object
          - `regular` unknown[]
            - unknown
          - `promo` unknown[]
            - unknown
          - `promised` unknown[]
            - unknown
        - `lineItems` object[]
          - `id` integer
          - `itemCode` string
          - `source` string
          - `grossAmount` integer
          - `discount` integer
          - `amount` integer
          - `rate` integer
          - `qty` integer
          - `pointsEarned` object
            - `regular` object[]
              - …
            - `promo` object[]
              - …
            - `promised` unknown[]
              - …
      - `customFields` object[]
        - `name` string
        - `value` string
      - `extendedFields` unknown[]
        - unknown
      - `paymentModes` string[]
      - `pointInTimeSlabs` object[]
        - `pointInTimeSlabNumber` integer
        - `pointInTimeSlabName` string
        - `programId` integer
        - `isDefaultProgram` boolean
    - `warnings` unknown[]
      - unknown
  - object
    - `events` object[]
      - `eventLogId` integer
      - `eventName` string
      - `eventDetails` object
        - `eventDisplayName` string
        - `tillId` integer
        - `displayName` string
      - `pointsEarned` object
        - `regular` unknown[]
          - unknown
        - `promo` object[]
          - `promotionId` integer
          - `promotionName` string
          - `programId` integer
          - `programName` string
          - `value` integer
          - `promotionStartDate` string
          - `promotionEndDate` string
        - `promised` unknown[]
          - unknown
      - `behavioralEventMetadata` object
        - `label` string
        - `fields` object[]
          - `fieldName` string
          - `fieldType` string
          - `attributes` object
            - `accountId` object
              - …
            - `addCustomerIfNotExists` object
              - …
            - `identifierType` object
              - …
            - `isRequired` object
              - …
            - `source` object
              - …
    - `warnings` unknown[]
      - unknown
  - object
    - `events` object[]
      - `eventLogId` integer
      - `eventName` string
      - `eventDetails` object
        - `eventTime` string
        - `tillId` integer
      - `pointsEarned` object
        - `regular` object[]
          - `value` integer
          - `expiresOn` string
          - `programId` integer
          - `programName` string
          - `expiryType` string
        - `promo` object[]
          - `promotionId` integer
          - `promotionName` string
          - `programId` integer
          - `programName` string
          - `value` integer
          - `expiresOn` string
          - `expiryType` string
        - `promised` object[]
          - `value` integer
          - `conversionDate` string
          - `programId` integer
          - `programName` string
    - `warnings` unknown[]
      - unknown
  - object
    - `events` object[]
      - `eventLogId` integer
      - `eventName` string
      - `eventDetails` object
        - `eventTime` string
        - `reason` string
        - `requestId` integer
      - `pointsEarned` object
        - `regular` unknown[]
          - unknown
        - `promo` object[]
          - `promotionId` integer
          - `promotionName` string
          - `programId` integer
          - `programName` string
          - `value` integer
          - `expiresOn` string
          - `expiryType` string
        - `promised` unknown[]
          - unknown
    - `warnings` unknown[]
      - unknown
  - object
    - `events` object[]
      - `eventLogId` integer
      - `eventName` string
      - `eventDetails` object
        - `eventTime` string
        - `tillId` integer
      - `targetCompletedDetails` object
        - `targetGroupID` integer
        - `targetGroupName` string
        - `targetId` integer
        - `targetName` string
        - `targetPeriodID` integer
        - `targetPeriodName` string
        - `targetValue` string
        - `achievedValue` string
        - `sourceId` integer
        - `sourceType` string
        - `pointsEarned` object
          - `promised` object[]
            - `value` integer
            - `conversionDate` string
            - `programId` integer
            - `programName` string
    - `warnings` unknown[]
      - unknown
  - object
    - `events` object[]
      - `eventLogId` integer
      - `eventName` string
      - `eventDetails` object
        - `eventTime` string
      - `transferredFrom` object
        - `userId` string
        - `firstName` string
        - `lastName` string
        - `transferType` string
        - `pointsTransferDetails` object[]
          - `points` string
          - `programId` string
          - `programName` string
      - `transferredTo` object
        - `userId` string
        - `firstName` string
        - `lastName` string
        - `transferType` string
        - `pointsTransferDetails` object[]
          - `points` string
          - `programId` string
          - `programName` string
      - `notes` string
    - `warnings` unknown[]
      - unknown
  - object
    - `events` object[]
      - `eventLogId` integer
      - `eventName` string
      - `eventDetails` object
        - `eventTime` string
        - `tillId` integer
        - `redemptionDetails` object
          - `pointsRedeemed` string
          - `transactionNumber` string
          - `billingTime` string
          - `externalReferenceNumber` string
          - `notes` string
          - `groupRedemption` boolean
      - `customFields` unknown[]
        - unknown
      - `pointsBreakup` object[]
        - `points` string
        - `programId` string
        - `programName` string
    - `warnings` unknown[]
      - unknown
  - object
    - `events` object[]
      - `eventLogId` integer
      - `eventName` string
      - `eventDetails` object
        - `eventTime` string
        - `tillId` integer
      - `billDetails` object
        - `billNumber` string
        - `billAmount` integer
        - `note` string
        - `returnDate` string
        - `returnAmount` integer
        - `billDate` string
        - `returnType` string
        - `returnBillId` integer
        - `pointsEarned` object
          - `regular` object[]
            - `value` integer
            - `expiresOn` string
            - `programId` integer
            - `programName` string
            - `returnPoints` integer
            - `expiryType` string
          - `promo` object[]
            - `promotionId` integer
            - `promotionName` string
            - `programId` integer
            - `programName` string
            - `value` integer
            - `expiresOn` string
            - `returnedPoints` integer
            - `expiryType` string
          - `promised` unknown[]
            - unknown
        - `pointsEarnedBreakup` object
          - `regular` object[]
            - `value` integer
            - `expiresOn` string
            - `awardedOn` string
            - `sourceValue` integer
            - `programId` integer
            - `programName` string
            - `allocationStrategyId` integer
            - `allocationStrategyName` string
            - `pointsCategoryId` integer
            - `pointsCategoryName` string
            - `expiryStrategyId` integer
            - `expiryStrategyName` string
            - `promotionDetails` object
              - …
            - `returnPoints` integer
            - `expiryType` string
          - `promised` unknown[]
            - unknown
        - `lineItems` unknown[]
          - unknown
      - `eventReferenceId` string
      - `uniqueId` string
    - `warnings` unknown[]
      - unknown
  - object
    - `events` object[]
      - `eventLogId` integer
      - `eventName` string
      - `eventDetails` object
        - `eventDisplayName` string
        - `tillId` integer
      - `pointsEarned` object
        - `regular` unknown[]
          - unknown
        - `promo` object[]
          - `promotionId` integer
          - `promotionName` string
          - `programId` integer
          - `programName` string
          - `value` integer
        - `promised` unknown[]
          - unknown
      - `importMeta` object
        - `fileName` string
        - `importStartTime` string
        - `importEndTime` string
        - `profileName` string
        - `profileType` string
    - `warnings` unknown[]
      - unknown
  - object
    - `events` object[]
      - `eventLogId` integer
      - `eventName` string
      - `eventDetails` object
        - `eventTime` string
        - `tillId` integer
      - `billDetails` object
        - `type` string
        - `billNumber` string
        - `grossAmount` integer
        - `discount` integer
        - `billAmount` integer
        - `note` string
        - `source` string
        - `pointsEarned` object
          - `regular` object[]
            - `value` integer
            - `expiresOn` string
            - `programId` integer
            - `programName` string
            - `expiryType` string
          - `promo` unknown[]
            - unknown
          - `promised` unknown[]
            - unknown
        - `pointsEarnedBreakup` object
          - `regular` object[]
            - `value` integer
            - `expiresOn` string
            - `awardedOn` string
            - `sourceValue` integer
            - `programId` integer
            - `programName` string
            - `allocationStrategyId` integer
            - `allocationStrategyName` string
            - `pointsCategoryId` integer
            - `pointsCategoryName` string
            - `expiryStrategyId` integer
            - `expiryStrategyName` string
            - `expiryType` string
          - `promised` unknown[]
            - unknown
        - `alternateCurrencyValueEarned` object[]
          - `regular` object[]
            - `value` integer
            - `expiresOn` string
            - `programId` integer
            - `programName` string
            - `expiryType` string
          - `promo` unknown[]
            - unknown
          - `promised` unknown[]
            - unknown
          - `alternateCurrencyName` string
          - `alternateCurrencyIdentifier` string
        - `alternateCurrencyValueEarnedBreakup` object[]
          - `regular` object[]
            - `value` integer
            - `expiresOn` string
            - `awardedOn` string
            - `sourceValue` integer
            - `programId` integer
            - `programName` string
            - `allocationStrategyId` integer
            - `allocationStrategyName` string
            - `pointsCategoryId` integer
            - `pointsCategoryName` string
            - `expiryStrategyId` integer
            - `expiryStrategyName` string
            - `expiryType` string
          - `promised` unknown[]
            - unknown
          - `alternateCurrencyName` string
          - `alternateCurrencyIdentifier` string
        - `lineItems` object[]
          - `id` integer
          - `itemCode` string
          - `source` string
          - `grossAmount` integer
          - `discount` integer
          - `amount` integer
          - `rate` number
          - `qty` integer
      - `customFields` unknown[]
        - unknown
      - `extendedFields` unknown[]
        - unknown
      - `paymentModes` unknown[]
        - unknown
      - `pointInTimeSlabs` object[]
        - `pointInTimeSlabNumber` integer
        - `pointInTimeSlabName` string
        - `programId` integer
        - `isDefaultProgram` boolean
    - `warnings` object[]
      - `code` integer
      - `message` string
      - `status` boolean
  - object
    - `events` object[]
      - `eventLogId` integer
      - `eventName` string
      - `eventDetails` object
        - `eventTime` string
        - `tillId` integer
      - `pointsEarned` object
        - `regular` object[]
          - `value` integer
          - `expiresOn` string
          - `programId` integer
          - `programName` string
          - `expiryType` string
        - `promo` object[]
          - `promotionId` integer
          - `promotionName` string
          - `programId` integer
          - `programName` string
          - `value` integer
          - `expiresOn` string
          - `expiryType` string
        - `promised` unknown[]
          - unknown
      - `eventReferenceId` string
      - `uniqueId` string
      - `voucherRedemptionDetails` object
        - `voucherIssuedId` integer
        - `voucherSeriesId` integer
        - `redeemedVoucherCode` string
        - `redeemDate` string
    - `warnings` unknown[]
      - unknown

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)