This call is deprecated. We recommend to use Point of Sale API instead.
The corresponding new call is: GET /v1/giftcard/redeem/, GET /v1/giftcard/redeem/sync or GET /v1/giftcard/redeem/{ids}.
Return an array of gift card redeemings.
This API call returns error 1006 if "Gift card extras" module is not enabled on this account.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| giftCardID | ID of gift card | integer | |
| 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) | |
| 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 |
|---|---|---|
| giftCardID | integer | ID of gift card |
| redeemed | Decimal | |
| remainingBalance | number | Remaining balance |
| invoiceID | integer | Invoice ID |
| invoiceNo | string | Invoice number |
| paymentID | integer | Payment ID |
| customerID | integer | Customer ID |
| warehouseID | integer | Warehouse ID |
| warehouseCode | string | Warehouse code |
| pointOfSaleID | integer | Point of sale ID |
| employeeID | integer | Employee ID |
| dateTime | string | ISO datetime (yyyy-mm-dd hh:mm:ss) |