Powersoft 365 API Documentation

list_cancellation_logging


POST /list_cancellation_logging

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 cancellation logging for multiple search criteria.

Returns

Detailed list of cancellation logging for multiple search criteria.

To get a summary list of cancellation logging for multiple search criteria.

Returns

Summary list of cancellation logging 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 logs found based on user filter criteria. 'N' = brings the list of the logs 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 cancellation log entries. 'Summary' = displays a summarized cancellation log 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 - cancellation log date.
  • ActionType - cancellation log action type.
  • Customer - customer of cancellation log.
  • Store - store of cancellation log.
  • User - user of cancellation log.
  • ItemCategory - item's category involved in cancellation log.
  • ItemDepartment - item's department involved in cancellation log.
  • Brand - item's brand involved in cancellation log.
  • Season - item's season involved in cancellation log.
  • Model - item's model involved in cancellation log.
  • Colour - item's colour involved in cancellation log.
  • Size - item's size involved in cancellation log.
  • Attribute1 - item's extra attribute 1 involved in cancellation log.
  • Attribute2 - item's extra attribute 2 involved in cancellation log.
  • Attribute3 - item's extra attribute 3 involved in cancellation log.
  • Attribute4 - item's extra attribute 4 involved in cancellation log.
  • Attribute5 - item's extra attribute 5 involved in cancellation log.
  • Attribute6 - item's extra attribute 6 involved in cancellation log.
action_type_selection string Comma separated list of cancellation log action type. Optional. The values accepted in the list are:
  • CancelledInvoice - cancelled invoice.
  • DeletedLine - line deletion from invoice.
  • Complimentary - free products in the invoice.
  • ClearTable - cleared table for restaurants.
  • DeletedBatch - deleted batches.
item_categories_selection string Comma separated list of 365 items categories codes ('DRINKS,FOOD,BEVERAGE ...'). Optional.
item_departments_selection string Comma separated list of 365 items departments codes ('BAR, KITCHEN ...'). Optional.
brands_selection string Comma separated list of 365 items brands codes ('GUCCI,ARMANI, ...'). Optional.
seasons_selection string Comma separated list of 365 items seasons codes ('S2026,W2026, ...'). Optional.
models_selection string Comma separated list of 365 items models codes ('MX001,MX002, ...'). Optional.
items_selection string Comma separated list of 365 items codes ('COKE,SALAD, ...'). Optional.
colours_selection string Comma separated list of 365 items colours codes ('BLACK,RED,WHITE ...'). Optional.
sizes_selection string Comma separated list of 365 items sizes codes ('S,L,M,XXL ...'). Optional.
sizes_group_selection string Comma separated list of 365 items size groups codes ('S-XXL,KIDS, ...'). Optional.
material_selection string Comma separated list of 365 items materials codes ('SILK,COTTON,LINEN, ...'). Optional.
attributes_1_selection string Comma separated list of 365 items extra attribute 1 codes ('A11,A12, ...'). Optional.
attributes_2_selection string Comma separated list of 365 items extra attribute 2 codes ('A21,A22, ...'). Optional.
attributes_3_selection string Comma separated list of 365 items extra attribute 3 codes ('A31,A32, ...'). Optional.
attributes_4_selection string Comma separated list of 365 items extra attribute 4 codes ('A41,A42, ...'). Optional.
attributes_5_selection string Comma separated list of 365 items extra attribute 5 codes ('A51,A52, ...'). Optional.
attributes_6_selection string Comma separated list of 365 items extra attribute 6 codes ('A61,A62, ...'). Optional.
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.
user_code_365_selection string Comma separated list of 365 users codes ('Powersoft,Cashier, ...'). Optional.
sorting
field_name string The field name the sorting is applied. It is used only for detailed cancellation log 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 - cancellation log date.
  • SessionDateTime - cancellation log session date/time.
  • ActionType - cancellation log action type.
  • CustomerCode - cancellation log customer code.
  • CustomerName - cancellation log customer name.
  • StoreCode - cancellation log store code.
  • StoreName - cancellation log store name.
  • User - cancellation log user.
  • ItemCode - item code.
  • ItemName - item name.
sorting_direction string The direction the sorting is applied. Required. Allowed values are ascending and descending.