Sign in
DepositLedger

List LedgerLines

Use this endpoint to retrieve a list of DepositLedgerDailyChange resources.

get/shop/reports/deposit-ledger-v2/list

Query parameters

site_idstring uuid

Retrieve the deposit ledger details for this site.

pageinteger

The page to retrieve results from

datestring date
Example:2023-05-05

Retrieve the deposit ledger details as at this date.

Response

The list of DepositLedgerDailyChange resources was successfully retrieved

Example response

{
  "data": [
    {
      "type": "basket",
      "reference": "TRY00",
      "description": "dan@example.com",
      "ledger_balance": 5000,
      "ledger_balances": {
        "deposit": 5000,
        "deposit_redemption": 3500
      }
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.