list_loyalty_invoices

POST /list_loyalty_invoices

To get the TOTAL COUNT of list of loyalty invoices 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.

To get a list of loyalty invoices 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 invoices found based on user filter criteria. 'N' = brings the list of the invoices 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 10 rows
invoice_type	string	'sale' = Only the sales invoices. 'sale return' = Only the sale return. 'all' = All the invoices
invoice_number_selection	string	A comma separated list of 365 invoices numbers (eg 'IN10000003,IN10000004,...'). If the value is empty then no search criteria by invoice number is applied.
invoice_customer_code_selection	string	A comma separated list of 365 customers codes (eg '10000003,10000004,...'). If the value is empty then no search criteria by customer code is applied.
invoice_customer_name_selection	string	A comma separated list of 365 customers names (eg 'CUSTOMER1,CASH...'). If the value is empty then no search criteria by customer name is applied.
invoice_customer_email_selection	string	A comma separated list of customers emails address (eg 'jdoe@test.com,...'). If the value is empty then no search criteria by customer emails is applied.
invoice_customer_phone_selection	string	A comma separated list of customers phones numbers (eg '96XXXXX,...'). If the value is empty then no search criteria by customer phone number is applied.
invoice_agent_code_selection	string	A comma separated list of 365 agents codes (eg 'AG1,AG2...'). If the value is empty then no search criteria by agent code is applied.
from_date	string	From date. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date
to_date	string	To date. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date
session_date_from	string	Session date from . The date must be provided in format yyyy-mm-dd hh:MM:ss and is the Coordinated Universal Time (UTC). ie at time zone +0. Pass "" if you don't want selection by sesion date time
session_date_to	string	Session date to. The date must be provided in format yyyy-mm-dd hh:MM:ss and is the Coordinated Universal Time (UTC). ie at time zone +0. Pass "" if you don't want selection by sesion date time
sorting
field_name	string	The field name the sorting is applied. Optional. If the value is not provided the default sorting is by session date/time descending and invoice number. Allowed values are: CustomerCode - 365 customer code. CustomerName - customer name. InvoiceType - invoice type. InvoiceNumber - invoice number. InvoiceGrandTotal - invoice grand total. PointsEarned - number of points earned. PointsRedeemed - number of points redeemed. SessionDateTime - session date/time. StoreCode - 365 store code. StoreName - store name. ValueDate - value date.
sorting_direction	string	The direction the sorting is applied. Required. Allowed values are ascending and descending.

Returns

TOTAL COUNT of list of loyalty invoices for multiple search criteria (only_counted='Y').

List of loyalty invoices for multiple search criteria (only_counted='N').

---