Powersoft 365 API Documentation

list_customer_transactions_history


POST /list_customer_transactions_history

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 customer transactions for multiple search criteria.

Returns

Detailed list of customer 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.
customer_code_365 string 365 customer code. Required.
report_type string 'All' = displays all transactions of the customer. 'Latest' = displays latest transaction per invoice type and item of the customer. Required.
from_date string From date. The date must be provided in format yyyy-mm-dd. Optional.
to_date string To date. The date must be provided in format yyyy-mm-dd. Optional.
primary_group string The primary group.
secondary_group string The secondary group. Accepted values for both primary and secondary group are:
  • Year - transaction year.
  • Month - transaction month.
  • Date - transaction date.
  • InvoiceType - transaction invoice type.
  • Store - transaction store.
  • Item - transaction item.
invoice_type_selection string Comma separated list of invoice types. Optional. The values accepted in the list are:
  • Sale - sale.
  • SaleReturn - sale return.
  • SaleOrder - sale order.
items_code_365_selection string Comma separated list of 365 items codes ('COKE,SALAD, ...'). 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 list. Optional. If the value is not provided the default sorting is by session date/time descending, item code and item name ascending. Allowed values are:
  • Year - transaction year.
  • Month - transaction month.
  • Date - transaction date.
  • SessionDateTime - transaction session date/time.
  • InvoiceType - transaction invoice type.
  • StoreCode - transaction store code.
  • StoreName - transaction store name.
  • ItemCode - item code.
  • ItemName - item name.
  • Quantity - quantity.
  • PriceExcl - price excluding VAT.
  • PriceIncl - price including VAT.
  • DiscountPercentage - discount percentage per line.
  • Discount - discount value per line.
  • ExtraDiscount - additional discount value per line.
  • TotalDiscount - total discount value per line.
  • NetAmount - net amount per line.
  • VatAmount - vat amount per line.
  • TotalAmount - total amount per line.
sorting_direction string The direction the sorting is applied. Required. Allowed values are ascending and descending.