---
title: "Get Customer Ledger Balance"
method: GET
path: "/pointsLedger/getCustomerLedgerBalance"
---

# Get Customer Ledger Balance

`GET /pointsLedger/getCustomerLedgerBalance`

Retrieves category-wise points’ ledger balance details of a customer for a given time.

## Query parameters

- `identifierName` 'mobile' | 'email' | 'externalId' | 'cardnumber' | 'cardExternalId', required
- `identifierValue` string, required
- `source` 'INSTORE' | 'MARTJACK' | 'WECHAT' | 'FACEBOOK' | 'WEB_ENGAG' | 'TMALL' | 'TAOBAO' | 'JD' | 'ECOMMERCE' | 'WEBSITE' | 'LINE' | 'ALL', required
- `accountId` string
- `tillId` string
- `limit` integer
- `offset` integer
- `endDate` string
- `includeTillConceptEvents` boolean
- `ledgerEntryType` 'CREDIT' | 'DEBIT' | 'OPENING_BALANCE'
- `pointCategoryType` 'REGULAR' | 'PROMISED' | 'TRIGGER_BASED'
- `alternateCurrencyNames` string
- `includeAlternateCurrencies` boolean

## Request body

- unknown

## Response `200`

200

- object
  - `customerDetails` object
    - `userId` integer
    - `externalId` string
    - `entityType` string
  - `ledgerDetails` object
    - `pageNumber` integer
    - `pageSize` integer
    - `totalEntries` integer
    - `pageCount` integer
    - `ledgerClosingBalance` object[]
      - `pointsCategory` string
      - `programName` string
      - `programId` integer
      - `closingBalance` string
  - `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)