Newer Version Available

This content describes an older version of this product. View Latest

Transaction Ledger Summary

Retrieve an aggregate view on the transaction journal and the loyalty ledger records.
Resource
1/loyalty/programs/${programName}/members/${membershipNumber}/transaction-ledger-summary
Resource Examples
1https://yourInstance.salesforce.com/services/data/v62.0/loyalty/programs/NTO/members/M1/transaction-ledger-summary
1https://yourInstance.salesforce.com/services/data/v62.0/loyalty/programs/NTO/members/M1/transaction-ledger-summary?journalSubTypeName={provide_value}
1https://yourInstance.salesforce.com/services/data/v62.0/loyalty/programs/NTO/members/M1/transaction-ledger-summary?pageNumber=2&journalTypeName={name}&journalSubTypeName={provide_value}
Available version
58.0
Requires Chatter
No
HTTP methods
GET
Query parameters for GET
Parameter Name Type Description Required or Optional Available Version
journalSubTypeName String Returns the transaction journals filtered by the specified journal subtype. Optional 58.0
additionalTransactionJournalAttributes String Returns the list of transaction journal fields. Optional 58.0
journalTypeName String Returns the transaction journals filtered by the specified journal type. Optional 58.0
pageNumber Integer Returns the transaction journals for the specified page number.

The API returns the first page by default. Each page contains 200 transaction journals, which are sorted according to the date the transaction journal record was created.

Note

Optional 58.0
periodEndDate String Returns the transaction journals filtered by the specified end date. Optional 58.0
periodStartDate String Returns the transaction journals filtered by the specified start date. Optional 58.0
Response body for GET
Transaction Journal Summary Output