---
title: "List LedgerLines"
method: GET
path: "/shop/reports/ledger-lines"
tags: ["LedgerLines"]
---

# List LedgerLines

`GET /shop/reports/ledger-lines`

Use this endpoint to retrieve a list of `LedgerLine` resources associated with a `Site`.

## Query parameters

- `site_id` string, uuid
- `page` integer
- `ledger_date_from` string, date
- `ledger_date_to` string, date
- `type` 'revenue' | 'charge'
- `revenue_centre` string
- `payment_processor` string
- `payment_processor_type_id` string
- `voucher_code_id` string, object-id

## Response `200`

The list of `LedgerLines` resources was successfully retrieved

- ListLedgerLinesResponse
  - `data` LedgerLine[], required
    - `id` string, object-id, required — The ID of the ledger line.
    - `gross_amount` integer, required — The gross amount of the ledger line.
    - `net_amount` integer, required — The net amount of the ledger line.
    - `type` 'charge' | 'revenue', required — The type of the ledger line, i.e. a charge (payment or refund) or revenue.
    - `description` string, required — A description of the ledger line.
    - `revenue_centre` string, nullable, required — Contains the revenue centre ID if this line is for revenue.
    - `revenue_centre_name` string, nullable, required — A friendly name for the revenue centre.
    - `payment_processor` string, nullable, required — A key for the payment processor if this line is for a charge.
    - `payment_processor_friendly` string, nullable, required — A friendly name for the payment processor and type if this line is for a charge.
    - `mapped_value` string, nullable — The value that this line's revenue centre or payment processor was mapped to for the integration.
    - `ledger_date` string, date-time, required — The date and time the ledger event occurred.
    - `currency` string, required — The currency of the ledger line. See [Supported Currencies](/endpoints/Meta#metaSupportedCurrencies) for a list of supported currencies.
    - `payable` PayableSummary, required — A summary of the model that the ledger line or posting relates to, usually a basket.
      - `id` string, object-id, required — The ID of the payable model.
      - `type` 'basket' | 'customer' | 'membership' | 'import', required — The type of the payable model.
      - `reference` string, required — A reference for the payable model.
      - `description` string — Further details about the payable model
    - `causer` CauserSummary, required — A summary of the model that caused the posting or line to be generated.
      - `id` string, object-id, required — The ID of the causer model.
      - `type` 'basket' | 'basket_item' | 'payment' | 'refund' | 'membership_charge' | 'voucher_code', required — The type of the causer model.
      - `reference` string — A reference for the causer.
    - `status` 'pending' | 'final', nullable, required — The status of the ledger line. Lines without a status are assumed to be final.
    - `created_at` string, date-time, required — The date and time the ledger posting was created.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)