Sign in
Reports

General ledger

A chronologically-sorted ledger of every revenue, payment, refund and revenue-reversal event at a site over the requested period. Use this for end-to-end financial reconciliation; for voucher-specific reconciliation see /shop/reports/voucher-ledger-detailed.

get/shop/reports/general-ledger

Query parameters

site_idstring uuid required

The site to compute the voucher ledger for.

date_fromstring date required
Example:2026-06-01

Start of the date range covered by the ledger.

date_tostring date required
Example:2026-06-30

End of the date range covered by the ledger.

Response

The ledger was successfully generated.

datestring date-time required
type'revenue' | 'payment' | 'refund' required
revenue_centrestring nullable
descriptionstring required
amountinteger

Total amount of the entry, in minor units. Negative for payments.

gross_amountinteger

Gross revenue amount, in minor units (revenue entries only).

net_amountinteger

Net revenue amount, in minor units (revenue entries only).

tax_amountinteger

Tax amount, in minor units (revenue entries only).

metaobject

Contextual references for the ledger entry — e.g. order_ref, basket_id, payment_id, or refund_id depending on the entry type.

Example response

[
  {
    "description": "Card payment"
  }
]

Changes

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