---
title: "Get Points Ledger Information in Connected Orgs"
method: GET
path: "/v2.1/pointsLedger/getCustomerLedgerInfo"
---

# Get Points Ledger Information in Connected Orgs

`GET /v2.1/pointsLedger/getCustomerLedgerInfo`

## Query parameters

- `identifierName` string, required
- `identifierValue` string, required
- `source` string, required
- `accountId` string
- `tillId` integer
- `limit` integer
- `offset` integer
- `programId` integer
- `startDate` string
- `endDate` string
- `includeTillConceptEvents` boolean
- `ledgerEntryType` string
- `pointCategoryType` string
- `type` string
- `isPrimaryUser` boolean
- `excludeEvents` string
- `eventFilter` string
- `roles` string
- `includeLastOneYearData` boolean
- `order` string
- `isFilterBasedOnDate` boolean
- `includeAlternateCurrencies` boolean
- `alternateCurrencyNames` string

## Headers

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

## Response `200`

200

- object
  - `customerDetails` object
    - `firstName` string
    - `lastName` string
    - `userId` integer
    - `entityType` string
  - `ledgerDetails` object
    - `pageNumber` integer
    - `pageSize` integer
    - `totalEntries` integer
    - `pageCount` integer
    - `ledgerClosingBalance` unknown[]
      - unknown
  - `ledgerEntries` object[]
    - `eventLogId` integer
    - `eventName` string
    - `customerId` integer
    - `ledgerCreatedDate` string
    - `customerDetails` object
      - `userId` integer
    - `entryDetails` object[]
      - `ledgerEntryType` string
      - `points` string
      - `pointsCategory` string
      - `programName` string
      - `programId` integer
    - `netPointsOnEvent` string
    - `transactionDetails` object
      - `transactionId` integer
      - `transactionNumber` string
      - `date` string
      - `amount` integer
      - `grossBillAmount` integer
      - `source` string
    - `store` string
    - `storeCode` string
    - `tillCode` string
    - `eventDetails` object
    - `sourceProgramId` integer
    - `sourceProgramName` 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)