Get Points Ledger Information in Connected Orgs

get

https://{host}/v2.1/pointsLedger/getCustomerLedgerInfo

Query Params

identifierName

string

required

Identifier type to identify the customer or group. For user groups, the following identifiers are applicable: groupId, externalId, and primaryUserId. For customers, the applicable identifiers include mobile, email, externalId, cuid, and id.

identifierValue

string

required

Value of the specified identifier type of the customer.

source

string

required

Source in which the identifier is available.

accountId

string

For a source with multiple accounts, pass the specific accountId in which the customer identifier is available.

tillId

int32

Defaults to 10

Get the customer’s ledger information of a specific TILL. Pass the unique till ID.

limit

int32

Number of results to retrieve. Max value supported is 10.

offset

int32

Defaults to 0

Page number to show.

programId

int32

Retrieve the ledger details of a specific program. By default, details of all programs will be retrieved.

startDate

string

Get ledger information from on or after a specific date. Pass the start date in YYYY-MM-DDThh:mm:ss format. Default value is 90 days

endDate

string

Get ledger information until a specific date. Pass the end date in YYYY-MM-DDThh:mm:ss format. Default value is 90 days

includeTillConceptEvents

boolean

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

string

The type of ledger entries to fetch. By default, it fetches all the ledger entry types.

pointCategoryType

string

The point category type for which you want to fetch ledger details. By default, it fetches all the points category details.

type

string

Setting this field returns entries for type of user, whether individual customer or a group. Only two values are allowed here - CUTSOMER, USERGROUP2

isPrimaryUser

boolean

Returns entry for the primary member of a group, in case of usergroups.

excludeEvents

string

Exclude certain events if you dont want to retrieve entries from that event.

eventFilter

string

Retrieves the value of that particular event, which is passed in this filed. Eg. TransactionAdd, CustomerRegistration etc.

roles

string

These are the roles defined by the brands for members in a user group. For example, PRIMARY, SECONDARY, and so on.

includeLastOneYearData

boolean

If 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.

order

string

Sort the order of entries from date. ASC or DESC

isFilterBasedOnDate

boolean

Indicates whether the date filter should be applied when fetching data from the database.

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.

Headers

DATA-SCOPE-ORG

string

List of Organization IDs

DATA-SCOPE

string

required

The scope to authorize access (SELF, OTHER, ALL)

Responses

200200

400400