Finance
Methods of @cobuntu/embed for the community's ledger, settlements and totals. Setup, sessions and errors are on the
client overview; each method links to its endpoint in the
REST API reference.
finance (community ledger)
finance.entries
entries(params?)
Route: GET /finance/entries
Returns: { data: FinanceEntry[], nextCursor, hasMore, asOf }
finance.payouts
payouts(params?)
Route: GET /finance/payouts
Returns: { data: FinancePayout[], nextCursor, hasMore, asOf }
finance.summary
summary(params?)
Route: GET /finance/summary
Returns: { data: FinanceSummaryBucket[], window, asOf }
finance.depositStatement
depositStatement(id)
Route: GET /finance/deposits/:id/statement
Returns: { data: RemittanceStatement, asOf }
Secret key only. READ_FINANCE for the ledger; READ_FINANCE_PII as well if
you need buyer identity rather than the opaque buyerRef.
Read each entry's role before its net. On a COMMISSION_RECIPIENT entry
the community keeps only its commission, and gross is the member's sale
value — summing gross gives a number that looks like revenue and is not.
Page with cursor, taking the value from nextCursor or from an individual
entry's own cursor. Never build one from id. See
Finance.