Sign in
LedgerLines

List LedgerLines

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

get/shop/reports/ledger-lines

Query parameters

site_idstring uuid

Filter the list of LedgerLines by site

pageinteger

The page to retrieve results from

ledger_date_fromstring date
Example:2023-05-05

Filter the list of LedgerLines by ledger date from. This will include the given date.

ledger_date_tostring date
Example:2023-05-05

Filter the list of LedgerLines by ledger date to. This will include the given date.

type'revenue' | 'charge'
Example:revenue

Show LedgerLines of this type.

revenue_centrestring
Example:spa_retail

Filter the list of LedgerLines by the revenue centre.

payment_processorstring
Example:manual

Filter the list of LedgerLines by the payment processor.

payment_processor_type_idstring

Filter the list of LedgerLines by the payment processor type ID.

voucher_code_idstring object-id

Show LedgerLines for this voucher code.

Response

The list of LedgerLines resources was successfully retrieved

Example response

{
  "data": [
    {
      "gross_amount": 10000,
      "net_amount": 8333,
      "description": "Trybe Cash payment [TRY3Z] Jane Jenkins",
      "revenue_centre": "spa",
      "revenue_centre_name": "Spa",
      "payment_processor": "manual",
      "payment_processor_friendly": "Manual (Cash)",
      "mapped_value": "trybe_spa_revenue",
      "ledger_date": "2023-04-02T00:00:00+01:00",
      "currency": "gbp",
      "payable": {
        "reference": "TRY00",
        "description": "dan@example.com"
      },
      "causer": {
        "reference": "TRY00"
      },
      "created_at": "2023-05-05T11:38:29+01:00"
    }
  ],
  "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