getTaxExemptions

Retrieve sales documents where tax exemption was applied. (Customer supplied a tax exemption certificate number and their tax rate for that sale was reduced.)

With this information, it is possible to build a "Tax Exemption Report".

Please note that this API call only lists those occasions where tax exemption was manually activated in POS. Sales to customers who have the "Tax Exempt" check box checked on their customer card, are NOT listed.

This API call is only available if your account has Classic back office (not Berlin back office), and you must be using at least back office version 4.5.0. Otherwise, this API call will return error code 1006.

Input parameters

Parameter name Description Possible value Required
dateStart  Date range filter.  ISO date (yyyy-mm-dd)  yes  
dateEnd  Date range filter.  ISO date (yyyy-mm-dd)  yes  
warehouseID  Filter by warehouse ID.  Integer    
recordsOnPage  Number of records API should return. By default 20, at most 500.  Integer    
pageNo  API returns at most recordsOnPage items at a time. To retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1".  Integer    

Response

Field name Type Description
invoiceID  Integer  Invoice ID.  
invoiceNumber  String  Invoice number.  
customerID  Integer  Customer ID.  
warehouseID  Integer  Warehouse ID.  
date  ISO date (yyyy-mm-dd)  Invoice date.  
taxExemptCertificateNumber  String  Tax exemption certificate number.  
amountExempted  Decimal  Amount of tax reduction. (Amount of money the customer saved, compared to if the sale had had default tax rates.)