API Documentation
Start typing to search…

Get Event Log IDs with Credit or Debit for Alternate Currency

get https://{host}/das/getACLedgerEntriesWithEventId

The API retrieves event log IDs that have CREDIT or DEBIT entries for alternate currencies 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/getACLedgerEntriesWithEventId
HTTP methodGET
Pagination supported?Yes
Rate limitBased on Neo
Batch supportNA

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: CREDIT, DEBIT

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.

  • If set to 1, the API does not apply any date filter. However, you must still pass dummy values for start_date and end_dateExample: 2025-01-01
  • If set to 0, the API filters the results based on the provided date range. In this case, pass the actual start_date and end_date values Example: 2024-04-01 to 2025-03-31.

is_till_not_present*

Boolean

Indicates whether the API should ignore filtering by till ID.

  • If set to 1, the API does not apply a till ID filter. In this case, pass till_ids = -1. - If set to 0, the API filters results based on the specified till IDs. Provide one or more comma-separated values in the till_ids parameter.
    Example: 1234323432,8759345333.

page

Integer

Retrieve details of a specific page. Page count starts from 1.
Example: page=2 retrieves data on page 2.

count

Integer

Number of results to display per page. The default value is 10. The maximum supported value is 100.

Response Parameters

ParameterDatatypeDescription
request_idStringUnique identifier for the API request
dataObjectContains the main response data
-recordsArrayList of records returned in the response
-- fieldsObjectKey-value pairs representing attributes of a ledger entry
--- ledgerEntryTypeStringType of ledger entry. Example: CREDIT
--- cpsIdNumberUnique customer points summary ID
--- configMetadataNullConfiguration metadata; null if not present
--- pointsLedgerIdNumberUnique identifier of the ledger entry
--- createdOnNumberTimestamp when the ledger entry was created in milliseconds
--- pointsCategoryNameStringName of the points category. Example: Flux_REGULAR
--- eventSubjectIdNumberUnique identifier for the event subject
--- processingTimeNumberTimestamp when the event was processed in milliseconds
--- alternateCurrencyNameStringName of the alternate currency used. Example: Flux
--- pointsNumberNumber of points credited or debited
--- categoryTypeStringType of the points category. Example: ALTERNATE_CURRENCIES
--- eventTypeIdNumberUnique identifier for the event type
--- sourceProgramIdNumberProgram ID from which the event originated
--- entityMetadataStringMetadata about the entity
--- requestIdStringIdentifier that links the event to the original request
--- customerIdNumberUnique identifier of the customer
--- eventTimeNumberTimestamp of when the event occurred in milliseconds
--- eventNameStringName of the event. Example: TransactionAdd
--- genericEventIdNullGeneric event ID if present; null if not applicable
--- eventLogIdNumberUnique identifier of the event log
--- tillIdNumberIdentifier for the till
--- uniqueIdStringUnique ID associated with the ledger record

Sample Response

{
    "request_id": "1483ca2f-ad6b-43b0-ba00-9bca8125df13",
    "data": {
        "records": [
            {
                "fields": {
                    "ledgerEntryType": {
                        "string_value": "CREDIT"
                    },
                    "cpsId": {
                        "number_value": 85912155
                    },
                    "configMetadata": {
                        "null_value": "NULL_VALUE"
                    },
                    "pointsLedgerId": {
                        "number_value": 64554870
                    },
                    "createdOn": {
                        "number_value": 1744382856000
                    },
                    "pointsCategoryName": {
                        "string_value": "Flux_REGULAR"
                    },
                    "eventSubjectId": {
                        "number_value": 2152201202
                    },
                    "processingTime": {
                        "number_value": 1743107884000
                    },
                    "alternateCurrencyName": {
                        "string_value": "Flux"
                    },
                    "points": {
                        "number_value": 1370.25
                    },
                    "categoryType": {
                        "string_value": "ALTERNATE_CURRENCIES"
                    },
                    "eventTypeId": {
                        "number_value": 15
                    },
                    "sourceProgramId": {
                        "number_value": 2809
                    },
                    "entityMetadata": {
                        "string_value": "{\\"pointInTimeSlabs\\": [{\\"programId\\": 2809, \\"isDefaultProgram\\": true, \\"pointInTimeSlabName\\": \\"Diamond\\", \\"pointInTimeSlabNumber\\": 5}]}"
                    },
                    "requestId": {
                        "string_value": "e7a4344912bde36e4bd9994eb9d96f76"
                    },
                    "customerId": {
                        "number_value": 387457911
                    },
                    "eventTime": {
                        "number_value": 1743107884000
                    },
                    "eventName": {
                        "string_value": "TransactionAdd"
                    },
                    "genericEventId": {
                        "null_value": "NULL_VALUE"
                    },
                    "eventLogId": {
                        "number_value": 37188433
                    },
                    "tillId": {
                        "number_value": 50691660
                    },
                    "uniqueId": {
                        "string_value": "7eCwyq507M"
                    }
                }
            },
            {
                "fields": {
                    "ledgerEntryType": {
                        "string_value": "CREDIT"
                    },
                    "cpsId": {
                        "number_value": 85912155
                    },
                    "configMetadata": {
                        "null_value": "NULL_VALUE"
                    },
                    "pointsLedgerId": {
                        "number_value": 64554867
                    },
                    "createdOn": {
                        "number_value": 1744382854000
                    },
                    "pointsCategoryName": {
                        "string_value": "Flux_REGULAR"
                    },
                    "eventSubjectId": {
                        "number_value": 2152201200
                    },
                    "processingTime": {
                        "number_value": 1741873476000
                    },
                    "alternateCurrencyName": {
                        "string_value": "Flux"
                    },
                    "points": {
                        "number_value": 300
                    },
                    "categoryType": {
                        "string_value": "ALTERNATE_CURRENCIES"
                    },
                    "eventTypeId": {
                        "number_value": 15
                    },
                    "sourceProgramId": {
                        "number_value": 2809
                    },
                    "entityMetadata": {
                        "string_value": "{\\"pointInTimeSlabs\\": [{\\"programId\\": 2809, \\"isDefaultProgram\\": true, \\"pointInTimeSlabName\\": \\"Diamond\\", \\"pointInTimeSlabNumber\\": 5}]}"
                    },
                    "requestId": {
                        "string_value": "e7a4344912bde36e4bd9994eb9d96f76"
                    },
                    "customerId": {
                        "number_value": 387457911
                    },
                    "eventTime": {
                        "number_value": 1741873476000
                    },
                    "eventName": {
                        "string_value": "TransactionAdd"
                    },
                    "genericEventId": {
                        "null_value": "NULL_VALUE"
                    },
                    "eventLogId": {
                        "number_value": 37188431
                    },
                    "tillId": {
                        "number_value": 50691660
                    },
                    "uniqueId": {
                        "string_value": "13QwzvQmiM"
                    }
                }
            }
        ]
    }
}


Error Code

Error CodeDescription
400Bad Request
404Not Found
500Internal Server Error
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!