list_customer_receipts
GET /list_customer_receipts
To get the TOTAL COUNT of the list of customers receipts.
Use this method FIRST to determine how many total records there are.
After you call this method, then call the method below, and pass the required paging parameters.
/list_customer_receipts?token=XXXXX
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
Returns
GET /list_customer_receipts
To get a list of the customers receipts.
/list_customer_receipts?token=XXXXXpage_number=1&page_size=10
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
| page_number |
The page number in the entire list. eg Page 1 |
| page_size |
The number of rows to return. eg 10 rows |
Returns
POST /list_customer_receipt
To get the TOTAL COUNT of customers receipts 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 customers receipts 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 number of customers receipts based on user filter criteria. 'N' = brings the list of the customers receipts 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 |
| receipt_type |
string |
The type of the receipt. There are accepted the folowing values: all - for all receipts, receipt - for money in, return - for money out |
| receipt_customer_selection |
string |
A comma separated list of 365 customer codes (eg '00100001,00100002...'). If the value is empty then no search criteria by customer is applied. |
| receipt_reference_number_selection |
string |
A comma separated list of reference numbers of the receipts (eg 'R00100001,H00100002...'). If the value is empty then no search criteria by reference number is applied. |
| receipt_payment_type_selection |
string |
A comma separated list of 365 payment type codes of the receipts (eg 'CASH,JCC...'). If the value is empty then no search criteria by payment type is applied. |
| receipt_cheque_number_selection |
string |
A comma separated list of cheque numbers of the receipts (eg 'CHQ1235,CH2569...'). If the value is empty then no search criteria by cheque number 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_by |
string |
List is ordered by the value provided. Allowed values:"TransactionNumber", "ReferenceNumber", "CustomerCode", "ReceiptDate". If the value is not provided or is empty string then the list is ordered by default by receipt date. |
| sorting_type |
string |
List is ordered ascending or descending by the value provided. Allowed values: "ascending" and "descending". Default value is ascending. |
Returns
TOTAL COUNT of list of receipts for multiple search criteria (only_counted='Y').
List of customers receipts for multiple search criteria (only_counted='N').