---
title: "List LedgerLinePostings"
method: GET
path: "/shop/ledger-line-postings"
tags: ["LedgerLinePostings"]
---

# List LedgerLinePostings

`GET /shop/ledger-line-postings`

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

## Query parameters

- `site_id` string, uuid
- `status` 'success' | 'resolved' | 'error' | 'in_progress' | 'not_started'
- `sort` string
- `sort_direction` 'asc' | 'desc'
- `page` integer
- `created_at_from` string, date
- `created_at_to` string, date
- `succeeded_at_from` string, date
- `succeeded_at_to` string, date

## Response `200`

The list of `LedgerLinePostings` resources was successfully retrieved

- ListLedgerLinePostingsResponse
  - `data` LedgerLinePosting[], required
    - `id` string, object-id, required — The ID of this ledger line posting.
    - `site_id` string, uuid, required — The ID of the site this ledger line posting belongs to.
    - `created_at` string, date-time, required — The date and time the ledger posting was created.
    - `integration` string, required — An identifier for the integration the posting was for.
    - `integration_name` string, required — A user-friendly name for the integration.
    - `integration_is_async` boolean — Whether the integration works asynchronously.
    - `status` 'success' | 'resolved' | 'error' | 'in_progress' | 'not_started' | 'nothing_to_post', required — The status of the posting.
    - `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.
    - `last_error` string — The last error encountered when attempting to post this record.
    - `last_error_at` string, date-time — The date and time of the last error.
    - `succeeded_at` string, date-time — The date and time the posting succeeded.
    - `lines` 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` object, 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
    - `aggregations` object[], required
      - `id` string — The id of this aggregation
      - `name` string — The friendly name for this aggregation
      - `options` object[] — The options for this aggregation
        - `id` string — The id of this aggregation option
        - `name` string — The friendly name of this aggregation option
        - `count` integer — The count of this aggregation option
    - `last_succeeded_at` string, date-time, nullable, required — The date and time a ledger line posting last succeeded
    - `last_error_at` string, date-time, nullable, required — The date and time a ledger line posting last errored
    - `total_succeeded` integer, required — The total number of succeeded postings
    - `total_errored` integer, required — The total number of errored postings
    - `success_rate` number, required — The success rate to 2 decimal places
  - `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)