list_stock_batch_invoice


Changelog

April 17, 2026
  • POST method added new properties customer_phone and agent_comments in the header object of the response

POST /list_stock_batch_invoice

To get the TOTAL COUNT of list of stock batch 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 stock batch 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 'I' = Only the batch sales invoices. 'C' = Only the batch sale return. 'all' = All the batch invoices
invoice_system_status string 'pending' = Only the pending batch invoices.'completed' = Only the completed batch invoices. 'partialcompleted' = Only the partial completed batch invoices. 'all' = All the batch invoices
invoice_status_selection string A comma separated list of 365 batch invoice status (eg 'NEW,INPROC,ACCEPTED,...). If the value is empty then no search for criteria by batch invoice status is applied.
item_department_selection string A comma separated list of 365 item departments code (eg 'BAR,KITCHEN,...). If the value is empty then no search for criteria by item department is applied.
shopping_cart_code_selection string A comma separated list of shopping cart numbers (eg 'CART1101010,CART101664,...'). If the value is empty then no search criteria by shopping cart is applied.
invoice_365_code_selection string A comma separated list of 365 batch invoice numbers (eg '100003B1,991001B4,...'). If the value is empty then no search criteria by invoice number is applied.
invoice_customer_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_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_mobile_selection string A comma separated list of customers mobile numbers (eg '96XXXXX,...'). If the value is empty then no search criteria by customer mobile number is applied.
invoice_store_selection string A comma separated list of 365 stores codes (eg '001,100,...'). If the value is empty then no search criteria by store code is applied.
invoice_station_selection string A comma separated list of 365 stations codes (eg '1001,0001,...'). If the value is empty then no search criteria by station code is applied.
from_invoice_date_utc0 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
to_invoice_date_utc0 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
from_invoice_delivery_date_utc0 string Delivery 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
to_invoice_delivery_date_utc0 string Delivery 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:"ShoppingCartCode", "Invoice365Number", "ValueDateTime". If the value is not provided or is empty string then the list is ordered by default by batch invoice 365 number.
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 stock batch invoices for multiple search criteria (only_counted='Y').

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