Search

getInventoryWriteOffs

Retrieve Inventory Write-Offs.

Inventory Write-Off is a document that removes products from inventory; it has a list of items and quantities.

Products can be added to stock with Inventory Registrations (see getInventoryRegistrations) and moved between locations with Inventory Transfers (see getInventoryTransfers).

To create an Inventory Write-Off, see saveInventoryWriteOff.

Input parameters

Parameter nameDescriptionPossible valueRequired
inventoryWriteOffIDID of inventory write-offInteger
warehouseIDRetrieve inventory registrations of a specific location (warehouse, store). See getWarehouses.Integer
dateFromDate (yyyy-mm-dd)
dateToDate (yyyy-mm-dd)
getCostIf set to 1, API also returns the cost.Integer
changedSinceRetrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with ERPLY.Integer (Unix timestamp)
recordsOnPageNumber of records API should return. By default 20, at most 100.Integer
pageNoAPI 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 nameTypeDescription
inventoryWriteOffIDIntegerID of inventory write-off
inventoryWriteOffNoIntegerInventory write-off number
creatorIDInteger
warehouseIDInteger
inventoryIDInteger
recipientIDInteger
currencyCodeStringCurrency code: EUR, USD.
currencyRateDecimaleg. 1.25543
Exchange rate of the inventory registration currency against system's default currency.
dateDateeg. 2010-01-29
inventoryTransactionDateDateInventory transaction date.
This is the date on which the document was confirmed and when the items on this document were added into inventory, or removed from inventory. While "document date" can be edited by users at any time, "inventory transaction date" is always set by ERPLY and cannot be changed.
Inventory Reports and COGS reports are based on the inventory transaction date.
commentsString
reasonIDInteger
confirmedInteger0 or 1
addedUnix timestampCreation time.
lastModifiedUnix timestampLast modification time.
rowsArrayThe item has the following attributes:

productID - ID of the product
price - product price
amount - product amount
cost - API returns this attribute if parameter "getCost" is specified.