Get Custom Field Values for TransactionAdd event

The API retrieves custom field values mapped to event log IDs for TransactionAdd events from the ledger.

🚧

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/getTransactionAddExplodeLedger
HTTP methodGET
Pagination supported?Yes
Rate limitBased on Neo
Batch supportNA

Request query parameters

Parameter (Parameters marked with * are mandatory)Data TypeDescription
entity_id*LongUnique customer ID of the customer
cf_names*StringCustom field names for which to retrieve values.
event_log_ids*StringUnique identifier generated for the event at the time of its creation.
pageIntegerRetrieve details of a specific page. Page count starts from 1. Example: page=2 retrieves data on page 2.
countIntegerNumber of results to display per page. The default value is 10. The maximum supported value is 100.

Response parameters

ParameterDatatypeDescription
eventTypeIdIntegerUnique identifier for the event type
billIdLongUnique identifier for the bill
customerIdLongUnique identifier of the customer
eventTimeLongTimestamp of when the event occurred, in epoch milliseconds.
customFieldIdIntegerUnique identifier for the custom field
eventLogIdLongUnique identifier of the event log
tillIdLongIdentifier for the till
customFieldValueStringValue of the custom field. Example: CREDIT
customFieldNameStringName of the custom field. Example:ledgerentryname
uniqueIdStringUnique ID associated with the record
processingTimeLongTimestamp of when the event was processed, in epoch milliseconds.

Sample response

   [
      {
        "eventTypeId": 15,
        "billId": 2152306126,
        "customerId": 387970841,
        "eventTime": 1738481105000,
        "customFieldId": 6212,
        "eventLogId": 38769078,
        "tillId": 50692627,
        "customFieldValue": "CREDIT",
        "customFieldName": "ledgerentryname",
        "uniqueId": "tAfisFBDFB",
        "processingTime": 1738481105000
      }
    ]

Error codes

Error CodeDescription
400Bad Request
404Not Found
500Internal Server Error