expenditures

List Ledger Transactions

Paginated claim-period document ledger (Transaction history tab).

Admin-only consultant reference — auth is the same dependency pair as export_items_csv (see its docstring; don't collapse them). Money-in/out totals are computed over the CURRENT filter (not the page); rows with direction IS NULL (manual journals) are excluded from both totals. Note payments duplicate the invoices they settle, so all-types totals double-count — the type filter is the tool for clean sums.

get/claims/{claim_id}/expenditures/ledger

Request

  • Base URL
    https://api.claimkit.co (the document declares no server; this is the origin it was published from)
  • URL
    https://api.claimkit.co/claims/{claim_id}/expenditures/ledger
  • Auth
    none declared

Path parameters

claim_idinteger required

Query parameters

limitinteger
offsetinteger
source_type'invoice_accrec' | 'invoice_accpay' | 'bank_transaction' | 'credit_note' | 'payment' | 'overpayment' | 'prepayment' | 'manual_journal' nullable
searchstring nullable

Response

Successful Response

total_countinteger required
money_in_audnumber required
money_out_audnumber required
fy_labelstring required

Changes

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