Retrieve Inventory Write-Offs.
Inventory Write-Off is a document that removes products from inventory; it contains 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. To delete one, see deleteInventoryWriteOff.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| inventoryWriteOffID | ID of Inventory Write-Off | integer | |
| inventoryWriteOffIDs | Multiple Inventory Write-Off IDs, separated by commas, such as: 1,2,3,4,5. | string | |
| warehouseID | Retrieve inventory write-offs of a specific location (warehouse, store). See getWarehouses. | integer | |
| dateFrom | Date (yyyy-mm-dd) | ||
| dateTo | Date (yyyy-mm-dd) | ||
| getCost | If set to 1, API also returns the cost. | integer | |
| searchAttributeName | Name of attribute to search from. Both "searchAttributeName" and "searchAttributeValue" have to be specified. Error 1030 will be returned if value is an array. | string | |
| searchAttributeValue | Attribute value to search for. Error 1030 will be returned if value is an array. | string | |
| changedSince | Retrieve 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) | |
| orderBy | Possible values: 'inventoryWriteOffID', 'date', 'lastModified'. By default, 'inventoryWriteOffID'. | string | |
| orderByDir | Sort direction: 'asc' (ascending order) or 'desc' (descending order). By default, items are sorted in ascending order. | string | |
| recordsOnPage | Number of records API should return. By default 20, at most 100. | integer | |
| pageNo | API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". | integer |
| Field name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| inventoryWriteOffID | integer | ID of inventory write-off | |||||||||||||||||||||
| inventoryWriteOffNo | integer | Inventory write-off number | |||||||||||||||||||||
| creatorID | integer | ||||||||||||||||||||||
| warehouseID | integer | ||||||||||||||||||||||
| stocktakingID | integer | ||||||||||||||||||||||
| inventoryID | integer | ||||||||||||||||||||||
| recipientID | integer | ||||||||||||||||||||||
| currencyCode | string | Currency code: EUR, USD. | |||||||||||||||||||||
| currencyRate | number | eg. 1.25543 Exchange rate of the inventory registration currency against system's default currency. |
|||||||||||||||||||||
| date | string | Format: yyyy-mm-dd. eg. 2010-01-29 | |||||||||||||||||||||
| inventoryTransactionDate | string | Format: yyyy-mm-dd. Inventory 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. |
|||||||||||||||||||||
| comments | string | ||||||||||||||||||||||
| reasonID | integer | ||||||||||||||||||||||
| confirmed | integer | 0 or 1 | |||||||||||||||||||||
| added | integer | Unix timestamp. Creation time. | |||||||||||||||||||||
| lastModified | integer | Unix timestamp. Last modification time. | |||||||||||||||||||||
| rows | array | Each row contains the following fields:
|
|||||||||||||||||||||
| attributes | array | Additional attributes. Each item looks like this:
|