Skip to navigation

List loan credit memos

Lists the credit memos saved on a loan as metadata only, each with its render state.

Requires the memos:read scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Path parameters

loan_idstringRequired
The loan's id.

Headers

SpreadSpace-VersionstringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.

Response headers

X-Request-IDstringOptional
Correlation ID for this request. Quote it in support tickets.
SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

OK
idstring
namestring
updated_atdatetime
render_stateenum
Allowed values:
spread_snapshotslist of objects

The spread figures a finalized memo was approved on: one entry per entity its figure exhibits cite, naming the final attribute snapshot, its version and the entity. Empty while the memo is open, and on a memo with no figure exhibits.

finalized_atdatetime or nullOptional
figures_statusenumOptional

unchanged while the figures a finalized memo was approved on still stand; moved once a spread it cites is reopened, a document its figures were read from is re-extracted, a document is added to the loan after the memo was finalized, or the workspace’s chart of accounts changes. Null while the memo is open.

Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error