The API retrieves event log IDs that have CREDIT or DEBIT entries for points from the ledger entries.
Note
This 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/getLedgerEntriesWithEventId |
| 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. |
entity_id* |
Long |
Unique customer ID of the customer |
end_date* |
Date |
Last date to which you want to retrieve the ledger information |
start_date* |
Date |
Start date from which you want to retrieve the ledger information |
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. |
count |
Integer |
Number of results to display per page. The default value is 10. The maximum supported value is 100. |
Response parameters
| Parameter | Datatype | Description |
|---|---|---|
| request_id | String | Unique identifier for the API request |
| data | Object | Contains the main response data |
| -records | Array | List of records returned in the response |
| -- fields | Object | Key-value pairs representing attributes of a ledger entry |
| --- ledgerEntryType | String | Type of ledger entry. **Example **: DEBIT, CREDIT |
| --- cpsId | Number | Unique customer points summary ID |
| --- configMetadata | Null | Configuration metadata; null if not present |
| --- pointsLedgerId | Number | Unique identifier of the ledger entry |
| --- createdOn | Number | Timestamp when the ledger entry was created in milliseconds |
| --- pointsCategoryName | String | Name of the points category. Example: Main |
| --- eventSubjectId | Number | Unique identifier for the event subject |
| --- processingTime | Number | Timestamp when the event was processed in milliseconds |
| --- points | Number | Number of points credited or debited |
| --- categoryType | String | Type of the points category. Example: REGULAR_POINTS |
| --- eventTypeId | Number | Unique identifier for the event type |
| --- sourceProgramId | Number | Program ID from which the event originated |
| --- entityMetadata | String | Metadata about the entity |
| --- requestId | String | Identifier that links the event to the original request |
| --- customerId | Number | Unique identifier of the customer |
| --- eventTime | Number | Timestamp of when the event occurred in milliseconds |
| --- eventName | String | Name of the event. Example: ReturnBill, TransactionAdd |
| --- genericEventId | Null | Generic event ID if present; null if not applicable |
| --- eventLogId | Number | Unique identifier of the event log |
| --- tillId | Number | Identifier for the till |
| --- uniqueId | String | Unique ID associated with the ledger record |
Sample response
{
"request_id": "39dbfc61-4e8b-4c5c-a1ee-913c99fb46e7",
"data": {
"records": [
{
"fields": {
"ledgerEntryType": {
"string_value": "DEBIT"
},
"cpsId": {
"number_value": 85912160
},
"configMetadata": {
"null_value": "NULL_VALUE"
},
"pointsLedgerId": {
"number_value": 65152554
},
"createdOn": {
"number_value": 1749573240000
},
"pointsCategoryName": {
"string_value": "Main"
},
"eventSubjectId": {
"number_value": 2152317880
},
"processingTime": {
"number_value": 1749105748000
},
"points": {
"number_value": 31
},
"categoryType": {
"string_value": "REGULAR_POINTS"
},
"eventTypeId": {
"number_value": 5
},
"sourceProgramId": {
"number_value": 2809
},
"entityMetadata": {
"string_value": "{\\"pointInTimeSlabs\\": []}"
},
"requestId": {
"string_value": "6ad7d91f9b543d5adf0cd4c90de35d0b"
},
"customerId": {
"number_value": 387457911
},
"eventTime": {
"number_value": 1749105748000
},
"eventName": {
"string_value": "ReturnBill"
},
"genericEventId": {
"null_value": "NULL_VALUE"
},
"eventLogId": {
"number_value": 38943074
},
"tillId": {
"number_value": 50691660
},
"uniqueId": {
"string_value": "fFOIZvZwef"
}
}
},
{
"fields": {
"ledgerEntryType": {
"string_value": "CREDIT"
},
"cpsId": {
"number_value": 85912160
},
"configMetadata": {
"null_value": "NULL_VALUE"
},
"pointsLedgerId": {
"number_value": 65152551
},
"createdOn": {
"number_value": 1749573203000
},
"pointsCategoryName": {
"string_value": "Main"
},
"eventSubjectId": {
"number_value": 2152317882
},
"processingTime": {
"number_value": 1748958294000
},
"points": {
"number_value": 31
},
"categoryType": {
"string_value": "REGULAR_POINTS"
},
"eventTypeId": {
"number_value": 15
},
"sourceProgramId": {
"number_value": 2809
},
"entityMetadata": {
"string_value": "{\\"pointInTimeSlabs\\": [{\\"programId\\": 2809, \\"isDefaultProgram\\": true, \\"pointInTimeSlabName\\": \\"Diamond\\", \\"pointInTimeSlabNumber\\": 5}]}"
},
"requestId": {
"string_value": "2d27cb2119f7ca4a0c7733b6baccd20b"
},
"customerId": {
"number_value": 387457911
},
"eventTime": {
"number_value": 1748958294000
},
"eventName": {
"string_value": "TransactionAdd"
},
"genericEventId": {
"null_value": "NULL_VALUE"
},
"eventLogId": {
"number_value": 38943071
},
"tillId": {
"number_value": 50691660
},
"uniqueId": {
"string_value": "jbASNg5B0x"
}
}
}
]
}
}Error codes
| Error Code | Description |
|---|---|
| 400 | Bad Request |
| 404 | Not Found |
| 500 | Internal Server Error |