Skip to main content
GET
Who owes the organization, and for how long

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Query Parameters

clubId
integer

Only what is owed at this club.

billingEntityId
integer

Only what is owed to this selling company, for an organization that trades through more than one.

byPerson
boolean
default:false

One row per person rather than per household.

owedFor
enum<string>

Only the rows owing something for this many months or longer.

Available options:
month1,
month2,
month3,
month4Plus
limit
integer
default:100

How many rows a page holds.

Required range: 1 <= x <= 500
offset
integer
default:0

How many rows to skip.

Required range: x >= 0

Response

A page of the report

asOf
string<date>

Today on the organization's clock: the figures are the ledger now.

currency
string
byPerson
boolean

Whether each person has a row of their own, rather than a household row.

walletShown
boolean

Whether Wallet balances are shown: not when the report is narrowed to a company other than the default one.

totals
object

Over every row of the report, not only this page.

total
integer

Every row of the report, across all pages.

limit
integer
offset
integer
rows
object[]

Biggest Amount Due first, then the people holding only Wallet money, by balance.