---
title: "Get Points Ledger Explode Info in Connected Orgs"
method: GET
path: "/v2.1/pointsLedger/getLedgerExplodeInfo"
---

# Get Points Ledger Explode Info in Connected Orgs

`GET /v2.1/pointsLedger/getLedgerExplodeInfo`

## Query parameters

- `identifierName` string, required
- `identifierValue` string, required
- `source` string, required
- `eventIds` string, 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

## Headers

- `DATA-SCOPE-ORG` string, required
- `DATA-SCOPE` string

## 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
      - `eventReferenceId` string
      - `orgId` integer
    - `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
              - …
      - `eventReferenceId` string
      - `orgId` integer
    - `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
      - `eventReferenceId` string
      - `orgId` integer
    - `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
      - `eventReferenceId` string
      - `orgId` integer
    - `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
      - `eventReferenceId` string
      - `orgId` integer
    - `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
      - `eventReferenceId` string
      - `orgId` integer
    - `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
      - `eventReferenceId` string
      - `orgId` integer
    - `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
        - `pointsEarned` object
          - `regular` unknown[]
            - unknown
          - `promo` unknown[]
            - unknown
          - `promised` unknown[]
            - unknown
        - `pointsEarnedBreakup` object
          - `regular` unknown[]
            - unknown
          - `promised` unknown[]
            - unknown
        - `lineItems` object[]
          - `id` integer
          - `itemCode` string
          - `grossAmount` integer
          - `amount` integer
          - `rate` integer
          - `qty` integer
          - `serialNumber` integer
          - `returnAmount` integer
          - `returnRate` integer
          - `returnQty` integer
          - `returnValue` integer
          - `pointsEarned` object
            - `regular` object[]
              - …
            - `promo` object[]
              - …
            - `promised` unknown[]
              - …
          - `pointsEarnedBreakup` object
            - `regular` object[]
              - …
            - `promised` unknown[]
              - …
      - `eventReferenceId` string
      - `orgId` integer
    - `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
      - `eventReferenceId` string
      - `orgId` integer
    - `warnings` unknown[]
      - unknown

## Other responses

- `400` — 400

---

[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)