finance

Get Commission Ledger For Year

The commissions page ledger, in v1's shape.

Registered ahead of /commissions/ledger/{recipient_principal_id} so the literal path is not swallowed by the uuid route.

SCOPED (Frederick, 2026-09-06): this used to sum EVERY recipient's obligations into one company-wide ledger regardless of who asked -- commission_ledger_for_year now pins it to the caller's own id unless they hold sees_all_commissions, and returns scope on the wire so the page can say whose figures these are.

recipient_principal_id (2026-10-02, issue #2830): a sees_all_ commissions holder clicking one person on the "People" all-view asks for THAT person's own page this way -- commission_ledger_for_year already accepted this parameter internally (every call from list_commission_people_for_year uses it); this is just the wire finally exposing it. A caller WITHOUT sees_all_commissions gets the identical pinned-to-self result whether they pass this or not, exactly like every other list-shaped commission read (commission_scope. resolve_scope's own rule) -- it can only ever narrow what a sees_all holder asked for onto one person, never widen what a scoped caller sees past their own rows.

get/api/finance/commissions/ledger

Request

  • Base URL: https://api.pigeonly.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pigeonly.com/api/finance/commissions/ledger
  • Auth: none declared

Query parameters

yearinteger required
recipient_principal_idstring uuid nullable

Response

Successful Response

object required

Changes

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