get https://{host}/v2/pointsLedger/getCustomerLedgerInfo
Retrieves the points ledger entries of a customer, usergroup or alternate currencies for each event.
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
Prerequisites
- Make sure you have access to the Points access group resource. For more information, see access group documentation.
API Specification
| HTTP Method | GET |
| Pagination | Yes |
| Batch support | No |
| Rate limit information | Refer to rate limit documentation . |
API endpoint example
- User group - /v2/pointsLedger/getCustomerLedgerInfo?type=USERGROUP2&identifierName=id&identifierValue=381335652&source=INSTORE&offset=0&limit=10&sortOrder=ASC
- Customer - v2/pointsLedger/getCustomerLedgerInfo?identifierName=id&identifierValue=98662653&source=INSTORE&limit=10
- Alternate Currencies- /v2/pointsLedger/getCustomerLedgerInfo?identifierName=id&identifierValue=423725119&source=INSTORE&includeAlternateCurrencies=true or /v2/pointsLedger/getCustomerLedgerInfo?identifierName=id&identifierValue=423725119&source=INSTORE&alternateCurrencyNames=acNjnkvfgfdeun
Query parameter (Customer)
| Parameter (Parameters marked with * sign are mandatory) | Description |
|---|---|
| identifierName* | Identifier type to identify the customer. |
| identifierValue* | Value of the specified identifier type of the customer. |
| source* | Source in which the identifier is available. |
| acountId* | For sources with multiple accounts, pass the specific accountId. |
| tillId | Get the customer’s ledger information of a specific TILL. Pass the unique till ID. |
| limit | Pass the number of results to retrieve. |
| offset | Page number to retrieve. Page Number. |
| programId | Retrieve the ledger details of a specific program. |
| isFilterBasedOnDate | Indicates whether the date filter should be applied when fetching data from the database. When the start date and end date are not passed in the API request parameters, the value of isFilterBasedOnDate becomes false and the API fetches the user’s entire past purchase history. Default value: True |
| includeLastOneYearData | If includeLastOneYearData is set to true, the API response will include data from the last year instead of the last 90 days when only startDate or endDate is passed in the API query parameter.Default value: False |
| startDate | Get ledger information from on or after a specific date. Pass the start date in YYYY-MM-DDThh:mm:ss format. Notes: - The maximum difference between startDate and endDate should not be more than 90 days. - If only startDate or endDate is passed in the API query parameter, the ledger data for 90 days is retrieved based on the provided startDate or endDate. If includeLastOneYearData is set to true, the API response will include data from the last year instead of the last 90 days.- When the start date and end date are not passed in the API request parameters, the value of isFilterBasedOnDate becomes false and the API fetches the user’s entire past purchase history. |
| endDate | Get ledger information until a specific date. Pass the end date in YYYY-MM-DDThh:mm:ss format. Notes: - The maximum difference between startDate and endDate should not be more than 90 days. - If only startDate or endDate is passed in the API query parameter, the ledger data for 90 days is retrieved based on the provided startDate or endDate.. If includeLastOneYearData is set to true, the API response will include data from the last year instead of the last 90 days.-When the start date and end date are not passed in the API request parameters, the value of isFilterBasedOnDate becomes false and the API fetches the user’s entire past purchase history. |
| includeTillConceptEvents | Pass true to fetch deduction entries that were triggered at the tills mapped to the Concept of the Program ID even if the deductions are from a different program. Default value is false. When true, pass the programId also, else it will be qualified as invalid input combination. |
| ledgerEntryType | Specify the type of ledger entries you want to fetch. Supported values: CREDIT, DEBIT, OPENING_BALANCE. By default, it fetches all the ledger entry types. |
| pointCategoryType | Specify the point category type for which you want to fetch ledger details. Supported values: REGULAR, PROMISED, TRIGGER_BASED. By default, it fetches all the points category details. |
Query parameter (User group)
| Parameter (Parameters marked with * sign are mandatory) | Description |
|---|---|
| type | Type of entity. |
| identifierName* | The identifier of the group to search for the ledger information. The following identifiers are applicable: groupId, externalId, and primaryUserId |
| identifierValue* | The value of the identifier. |
| source* | The origin of the information. For example, INSTORE, MARTJACK, WECHAT, FACEBOOK , WEB_ENGAGE, , TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, ALL |
| limit | The maximum number of items to be retrieved. |
| offset | The starting index for data retrieval. |
| sort | Sort the order of entries from date. The supported values are ASC and DESC. |
| role | These are the roles defined by the brands for members in a user group.Pa For example, PRIMARY, SECONDARY, and so on. |
Request query parameter (Alternate currencies)
| Parameter | Data type | Description |
|---|---|---|
| identifierName* | String | Identifier type to identify the customer. |
| identifierValue* | String | Value of the specified identifier type of the customer. |
| source | Enum | Source in which the identifier is available. Supported values: NSTORE, WECHAT, FACEBOOK, WEB_ENGAGE, ECOMMERCE, WEBSITE, LINE |
| includeAlternateCurrencies | Boolean | Pass includeAlternateCurrencies=true to retrieve all alternate currencies available with the customer. |
| alternateCurrencyNames | String | Filter alternate currencies for the customer based on the name. You can also pass a list of comma-separated alternate currency names. Set the parameter includeAlternateCurrencies to false when you use this. If the value is true, includeAlternateCurrencies lists all the available currencies. |
| pointCategoryType | Enum | Specify the point category type for which you want to fetch ledger details. By default, it fetches all the points category details. |
https://eucrm.cc.capillarytech.com/v2/pointsLedger/getCustomerLedgerInfo?includeAlternateCurrencies=true
https://eucrm.cc.capillarytech.com/v2/pointsLedger/getCustomerLedgerInfo?alternateCurrencyNames=acNjnkvfgfdeun
Response parameter (Customer)
| Parameter | Description |
|---|---|
| customerDetails | Details of the current customer. |
| firstName | Name of the customer. |
| lastName | Last name of the customer. |
| userId | Unique ID of the customer. |
| externalId | External ID of the customer. |
| entityType | Whether the points are issued to an individual (CUSTOMER), or group (FLEET). |
| pageNumber | Current page number. Default value - 0 (first page). |
| pageSize | Number of entries shown on the current page. |
| totalEntries | Total number of ledger entries available for the customer. |
| pageCount | Total number of pages according to the page size. |
| eventLogId | Unique log ID of the current event. |
| eventName | Name of the event associated with the points. Example - TransactionAdd, PointsRedemption, DelayedAccrual, PointsExpiry, CustomerRegistration, ReturnBill. |
| ledgerCreatedDate | Date and time when the points ledger entry was created. |
| entryDetails | Details of the points ledger. |
| ledgerClosingBalance | Details of closing ledger balance on a specific date. |
| pointsCategory | Category from which points are issued. Supported values: Main (redeemable account), DelayedAccrualPointCategory (promised points), ExternalTriggerBasedPointCategory (promised points). |
| programName | Name of the loyalty program associated with points. |
| programId | Unique ID of the loyalty program. |
| closingBalance | Available closing balance on that particular end date. |
| netPointsOnEvent | Net points in the current event (by adding credits and subtracting debits). |
| transactionDetails | Transaction details of the current points. Applicable for transaction related events. |
| transactionId | Transaction ID associated with the points. |
| transactionNumber | Transaction number associated with the points. |
| date | Date of the transaction. |
| amount | Net transaction amount. |
| store | Name of the store associated with the points. |
| storeCode | Unique code of the store associated with points. |
| tillCode | Unique TILL code associated with points. |
Response parameter (User group)
| Parameter | Description |
|---|---|
| ledgerDetails | Contains details about the pagination of the ledger entries. |
| pageNumber | The current page number in the pagination. |
| pageSize | The number of entries per page in the pagination. |
| totalEntries | The total number of entries in the ledger. |
| pageCount | The total number of pages in the pagination. |
| ledgerEntries | An array containing the ledger entries. |
| eventLogId | A unique identifier for the event. |
| eventName | The name of the event. |
| customerId | The identifier of the customer associated with the event. |
| ledgerCreatedDate | The date and time when the ledger entry was created. |
| customerDetails | Details of the customer. |
| entryDetails | An array containing the details about the ledger entry. |
| ledgerEntryType | The type of the ledger entry. |
| points | The number of points associated with the entry. |
| pointsCategory | The category of the points. |
| programName | The name of the program associated with the entry. |
| programId | The identifier of the program is associated with the entry. |
| netPointsOnEvent | The net points associated with the event. |
| transactionDetails | Details about the transaction. |
| store | The store associated with the event. |
| storeCode | The code of the store associated with the event. |
| tillCode | The code of the till associated with the event. |
| eventDetails | Details about the event. |
| reason | The reason for the event. |
| warnings | An array containing any warning messages. |