List of reports related API requests

getReports

Retrieve an "X Report" or "Z Report".

X / Z Report is a report of POS transactions and payments. The output is identical, but an X report is typically printed during the day, and a Z report at the end of the day, after counting the cash drawer.

X / Z Report can be retrieved either as structured data or HTML.

For other reports, see the following API calls:



To get day's payment totals by type (before the cashier starts counting the cash in the drawer), see the API call getPointOfSaleDayTotals.


getAccountStatements

Retrieve all customers who have a non-zero balance (who have unpaid invoices, prepayments, store credit etc.). For each customer, API returns a link to PDF payment reminder document, and also links to all unpaid invoices in PDF format.

NB! The links are valid for one-time use ONLY. You should download the PDF's and e-mail or display them as needed, but the link should not be shown or forwarded to customer.


getCostOfGoodsSold

Get the cost of goods sold for a given period. API returns an array of all sales document rows in the selected period, and the cost for each row.

Erply calculates cost according to FIFO principle.

Usage guidelines: Note that the COGS of any sale may change at any time — Erply does not freeze cost at the moment when sale takes place. Many kinds of operations may adjust it, eg. entering or correcting a purchase invoice at a later date, adding freight costs, deleting other documents etc. Find out what are the accounting principles in your company and pull COGS only when all adjustments for the given period are done — eg. at the end of month.


getGiftCardRedeemings

Return an array of gift card redeemings.

This API call returns error 1006 if "Gift card extras" module is not enabled on this account.


getPointOfSaleDayTotals

Returns today's cash, card and other payment type totals for the specified register (point of sale).

This API call is for implementing a day closing procedure in POS. API provides day totals as recorded by ERPLY; cashier can then input actual counted amounts and reconcile the differences.

The returned totals include all payments that have taken place since the day was opened at the register. If you provide input parameter "openedUnixTime", API will check if a day was opened at that time; if it does not find that day opening event, an empty response is returned. If the parameter is omitted, API will automatically fetch the latest opening of the register.

This API call can also be called after the day closing procedure, should it be necessary.

If you are looking for X Report / Z Report printouts, see API call getReports.

To open or close the register, see POSOpenDay and POSCloseDay.


getProductStock

Retrieve your ERPLY inventory — quantities on hand, reserved amounts, Reorder Points and Restock Levels, FIFO costs, and most recent purchase prices.

By default, API returns all products that have a non-zero inventory quantity in the warehouse you specified. In other words, items with a zero inventory quantity are skipped.

However, if you use input parameters "changedSince" (all quantities that have changed since last synchronization), or "getProductsWithReorderPointDefined" / "getProductsWithRestockLevelDefined", API will also return items with zero inventory quantity.

To retrieve only a list of reserved inventory quantities, see getReservedStock.

If parameter warehouseID is not set, then API call will return the combined information of all warehouses.


getSalesReport

Get a sales report.

API returns a link to CSV file that contains the report. Field separator in the CSV is region- and configuration-specific — check getConfParameters, field "csv_field_separator".

If you want to display sales totals in graph format, and would like to retrieve a simpler data set, see the API calls getSalesTotalsByEmployeeAndDay, getSalesTotalsByEmployeeAndMonth, getSalesTotalsByWarehouseAndDay and getSalesTotalsByWarehouseAndMonth.

Purchases and Inventory Transfers are also available in report format. See getPurchaseReport and getInventoryTransferReport.


getSummaryInventoryReport

Get summary inventory report (all stores and locations).

For more detailed data, use getProductStock instead.


getAmountsOnOrder

Get product quantities on Purchase Orders that have not been fulfilled yet.