API reference

Stock-based compensation runs

Each month's stock-based compensation as its close posted it, split by department, with the entry behind it.

List stock-based compensation by month

GET/v1/sbc_expense_runs

client.sbcExpenseRuns.list()

Each month's stock-based compensation as its close posted it, the newest first, split by department.

Name	Type	Description
`limit`Query	integer	Page size, 1–200. Default 50
`cursor`Query	string or null	The `next_cursor` of the previous page.

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

curl

curl "https://api.ledgerit.ai/v1/sbc_expense_runs" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

The objects these operations take and return.

Name	Type	Description
`amount`Required	string	The month's stock-based compensation, net.
`by_department`Required	array of DepartmentAmountOut	The amount split by department.
`currency`Required	string
`entry_id`Required	string	The entry that posted it.
`id`Required	string	An id that starts with `sbc_run_`.
`period_ends_on`Required	string (date)	The month it expensed, by its last day.
`recorded_at`Required	string (date-time)
`reversed`Required	boolean	Whether that entry was reversed; the next close expenses it again.
`version`Required	integer	1, or more when the month was closed again and something had changed.

Name	Type	Description
`amount`Required	string	The department's share of the run; below zero when expense was taken back.
`department`Required	DepartmentRef

Name	Type	Description
`id`Required	string	An id that starts with `dimv_`.
`name`Required	string