The API retrieves event log IDs that have CREDIT
or DEBIT
entries for alternate currencies from the ledger entries.
NoteThis is a private API and is accessible only through Neo dataflows.
Prerequisites
- Access to Neo
- Basic or OAuth authentication details
- Access group resource - NA
Resource information
URI to be used in Neo dataflow | /das/getACLedgerEntriesWithEventId |
HTTP method | GET |
Pagination supported? | Yes |
Rate limit | Based on Neo |
Batch support | NA |
Request query parameters
Parameter (Parameters marked with * are mandatory) | Data Type | Description |
---|---|---|
ledger_entry_types* | String | Type of entry recorded in a customer's points ledger. Allowed values: |
entity_id* | Long | Unique customer ID of the customer |
end_date* | Date | Last date to which you want to retrieve the ledger information Format: YYYY-MM-DD. Example: 2025-06-22 |
start_date* | Date | Start date from which you want to retrieve the ledger information Format: YYYY-MM-DD. Example: 2024-01-01 |
alternate_currency_names* | String | Name of the alternate currency for which ledger information is retrieved. |
till_ids* | Integer | Till IDs used to filter the results. |
is_filter_not_based_on_date* | Boolean | Indicates whether the API should apply a date filter.
|
is_till_not_present* | Boolean | Indicates whether the API should ignore filtering by till ID.
|
page | Integer | Retrieve details of a specific page. Page count starts from 1. Example: |
count | Integer | Number of results to display per page. The default value is 10. The maximum supported value is 100. |
Response parameters
Parameter | Data Type | Description |
---|---|---|
ledgerEntryType | String | Type of ledger entry.
Example: |
cpsId | Long | Unique identifier for the customer points system entry. |
configMetadata | String | Additional metadata related to configuration. |
pointsLedgerId | Long | Unique identifier of the points ledger entry. |
createdOn | Long | Time when the ledger entry was created, in epoch milliseconds |
pointsCategoryName | String | Name of the points category used. |
eventSubjectId | Long | ID of the event subject, usually a customer or account. |
processingTime | Long | Time when the event was processed, in epoch milliseconds |
alternateCurrencyName | String | Name of the alternate currency.
Example: |
points | Float | Number of points credited or debited |
categoryType | String | Type of point category.
Example: |
eventTypeId | Integer | Unique identifier of the event type. |
sourceProgramId | Integer | Program ID from which the points originated. |
entityMetadata | String | JSON string with metadata like slab info, programId, and slab name. |
requestId | String | Unique identifier for the request. |
customerId | Long | Unique ID of the customer. |
eventTime | Long | Time when the event occurred, in epoch milliseconds |
eventName | String | Name of the event.
Example: |
genericEventId | String | Identifier for generic event, if any. |
eventLogId | Long | Unique identifier of the event log entry. |
tillId | Long | ID of the source till. |
uniqueId | String | Unique string identifier for the transaction or record. |
Sample response
[
{
"ledgerEntryType": "CREDIT",
"cpsId": 85912155,
"configMetadata": null,
"pointsLedgerId": 64554870,
"createdOn": 1744382856000,
"pointsCategoryName": "Flux_REGULAR",
"eventSubjectId": 2152201202,
"processingTime": 1743107884000,
"alternateCurrencyName": "Flux",
"points": 1370.25,
"categoryType": "ALTERNATE_CURRENCIES",
"eventTypeId": 15,
"sourceProgramId": 2809,
"entityMetadata": "{\"pointInTimeSlabs\": [{\"programId\": 2809, \"isDefaultProgram\": true, \"pointInTimeSlabName\": \"Diamond\", \"pointInTimeSlabNumber\": 5}]}",
"requestId": "e7a4344912bde36e4bd9994eb9d96f76",
"customerId": 387457911,
"eventTime": 1743107884000,
"eventName": "TransactionAdd",
"genericEventId": null,
"eventLogId": 37188433,
"tillId": 50691660,
"uniqueId": "7eCwyq507M"
},
{
"ledgerEntryType": "CREDIT",
"cpsId": 85912155,
"configMetadata": null,
"pointsLedgerId": 64554867,
"createdOn": 1744382854000,
"pointsCategoryName": "Flux_REGULAR",
"eventSubjectId": 2152201200,
"processingTime": 1741873476000,
"alternateCurrencyName": "Flux",
"points": 300,
"categoryType": "ALTERNATE_CURRENCIES",
"eventTypeId": 15,
"sourceProgramId": 2809,
"entityMetadata": "{\"pointInTimeSlabs\": [{\"programId\": 2809, \"isDefaultProgram\": true, \"pointInTimeSlabName\": \"Diamond\", \"pointInTimeSlabNumber\": 5}]}",
"requestId": "e7a4344912bde36e4bd9994eb9d96f76",
"customerId": 387457911,
"eventTime": 1741873476000,
"eventName": "TransactionAdd",
"genericEventId": null,
"eventLogId": 37188431,
"tillId": 50691660,
"uniqueId": "13QwzvQmiM"
},
{
"ledgerEntryType": "CREDIT",
"cpsId": 85912155,
"configMetadata": null,
"pointsLedgerId": 64554861,
"createdOn": 1744382851000,
"pointsCategoryName": "Flux_REGULAR",
"eventSubjectId": 2152201116,
"processingTime": 1743263207000,
"alternateCurrencyName": "Flux",
"points": 655.8,
"categoryType": "ALTERNATE_CURRENCIES",
"eventTypeId": 15,
"sourceProgramId": 3414,
"entityMetadata": "{\"pointInTimeSlabs\": [{\"programId\": 3414, \"isDefaultProgram\": false, \"pointInTimeSlabName\": \"ELITE\", \"pointInTimeSlabNumber\": 2}, {\"programId\": 2809, \"isDefaultProgram\": true, \"pointInTimeSlabName\": \"Diamond\", \"pointInTimeSlabNumber\": 5}]}",
"requestId": "2078c7ea355f2e971886d3da8f2dc087",
"customerId": 387457911,
"eventTime": 1743263207000,
"eventName": "TransactionAdd",
"genericEventId": null,
"eventLogId": 37188428,
"tillId": 50776027,
"uniqueId": "3i8qVUFzeF"
}
]
Error code
Error Code | Description |
---|---|
400 | Bad Request |
404 | Not Found |
500 | Internal Server Error |