Powersoft 365 API Documentation

list_loyalty_points_transactions


POST /list_loyalty_points_transactions

To get the TOTAL COUNT of records for multiple search criteria.

Use this method with only_counted = 'Y' FIRST to determine how many total records there are for the given criteria.

After you call this method with only_counted = 'Y', then call again this method with only_counted = 'N', and pass the required paging parameters.

Returns

TOTAL COUNT of records for multiple search criteria (only_counted='Y').

To get a detailed list of loyalty points transactions for multiple search criteria.

Returns

Detailed list of loyalty points transactions for multiple search criteria.

To get a summary list of loyalty points transactions for multiple search criteria.

Returns

Summary list of loyalty points transactions for multiple search criteria.


field type description
api_credentials
token string Credentials provided by Powersoft that allow access to the API
filter_define
only_counted string 'Y' = brings only the total of records found based on user filter criteria. 'N' = brings the list of the records found based on user filter criteria.
page_number integer The page number in the entire list. eg Page 1.
page_size integer The number of rows to return, eg. 100 rows. Maximum allowed per page is 500 records.
report_type string 'Detail' = displays the detailed loyalty points transactions entries. 'Summary' = displays a summarized loyalty points transactions with totals for each group passed. Required.
from_date string From date/time. The date must be provided in format yyyy-mm-dd HH:mm:ss. Required.
to_date string To date/time. The date must be provided in format yyyy-mm-dd HH:mm:ss. Required.
primary_group string The primary group.
secondary_group string The secondary group. If the report type is 'Summary' at least one group must be provided. Accepted values for both primary and secondary group are:
  • Date - transaction date.
  • Month - transaction month.
  • TransactionType - transaction type.
  • DocumentType - document type.
  • Customer - loyalty points transaction customer.
  • Store - store of loyalty points transaction.
transaction_type_selection string Comma separated list of loyalty points transaction type. Optional. The values accepted in the list are:
  • ADDITION - addition of points.
  • REMOVAL - removal of points.
  • REDEEM - redeemption of points.
document_type_selection string Comma separated list of loyalty points document type. Optional. The values accepted in the list are:
  • Sale - sale invoice.
  • SaleReturn - sale return.
  • Adjustment - adjustment.
  • Voucher365 - 365 voucher usage.
  • APIVoucher - third party voucher usage like API.
  • SaleOrder - sale order.
customer_code_365_selection string Comma separated list of 365 customers codes ('10001,10003, ...'). Optional.
store_code_365_selection string Comma separated list of 365 stores codes ('001,002, ...'). Optional.
sorting
field_name string The field name the sorting is applied. It is used only for detailed loyalty points transactions list. Optional. If the value is not provided the default sorting is by session date/time descending and item code ascending. Allowed values are:
  • Date - transaction date.
  • SessionDateTime - transaction session date/time.
  • TransactionType - transaction type.
  • TransactionType - transaction document type.
  • CustomerCode - transaction customer code.
  • CustomerName - transaction customer name.
  • StoreCode - transaction store code.
  • StoreName - transaction store name.
sorting_direction string The direction the sorting is applied. Required. Allowed values are ascending and descending.