> This page is for API.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.spreadspace.app/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.spreadspace.app/_mcp/server.

# List loan credit memos

GET https://api.spreadspace.app/api/loans/{loan_id}/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).

Reference: https://docs.spreadspace.app/api/api-reference/loan-credit-memos/list

## Authentication

- `Authorization` header (bearer token, required) — Bearer token. Use `ss_live_…` for live data or `ss_test_…` for the sandbox (test mode). See [Authentication](https://docs.spreadspace.app/api/authentication).

## Request

### Path parameters

- `loan_id` (string, required) — The loan's id.

### Headers

- `SpreadSpace-Version` (string, optional) — Pin the API version, e.g. `2026-10-07`. Omit to get the latest. See [Versioning](https://docs.spreadspace.app/api/versioning).

## Response

### 200

OK

- `list of LoanMemoSummaryResponse`

## Errors

### 400 Bad Request Error

Bad request: validation failed, the cursor is malformed, or the API version is unknown.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

### 401 Unauthorized Error

Unauthorized: the bearer token or API key is missing or invalid.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

### 402 Payment Required Error

Payment required: the standard error envelope with `type` `subscription_required` when the workspace has no active or trialing subscription, or `billing_required` where a plan entitlement applies.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

### 403 Forbidden Error

Forbidden: authentication succeeded but the caller is not permitted to perform this action, for example an API key missing the required scope, an embed session reaching a loan it was not minted for, or a feature outside the workspace's plan.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

### 404 Not Found Error

Not found: the resource does not exist or is not visible to the calling tenant.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

### 429 Too Many Requests Error

Too many requests: the rate limit was hit, or an idempotency-key replay is still in progress.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

### 500 Internal Server Error

Internal server error: an unexpected failure. Quote the `request_id` in support tickets. A mutation sent with an `Idempotency-Key` replays this fault under that key rather than re-running; confirm the resource state before resending with a new key.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

## Types

### LoanMemoSummaryResponse

One saved memo on a loan, metadata only. `render_state` is `none`, `rendering`, `ready`, or `stale`; a stale memo was edited after its latest PDF was rendered. `finalized_at` says when the memo was finalized and is null while it is still open; a finalized memo reports on its final PDF and is never stale. `spread_snapshots` names the spread figures a finalized memo was approved on, and `figures_status` says whether they still stand.

- `id` (string, required)
- `name` (string, required)
- `updated_at` (datetime, required)
- `render_state` (enum, required)
  - Allowed values: `none`, `rendering`, `ready`, `stale`
- `spread_snapshots` (list of MemoSpreadSnapshot, required) — 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_at` (datetime, optional, nullable)
- `figures_status` (enum, optional) — `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: `unchanged`, `moved`

### ApiErrorBody

Inner body of the canonical API error envelope.

- `type` (string, required) — Stable error type identifier. Pattern-match on this value, not the human-readable message.
- `message` (string, required) — Human-readable error message. Subject to wording changes; do not parse.
- `request_id` (string, optional, nullable) — Per-request correlation ID (matches `X-Request-ID` response header). Quote in support tickets.
- `details` (map from string to string, optional, nullable) — Structured detail. Some error types populate documented keys in every environment: a version conflict (409) carries `current_version`, the version the resource is actually at, so the client can reload and re-apply. Free-form diagnostic detail beyond those keys appears in development environments only. An `insufficient_credits` 402 carries `balance_usd`, `reserved_usd`, `in_flight_docs`, `incoming_docs` and `per_doc_reservation_usd` as decimal strings.

### MemoSpreadSnapshot

One entity's spread figures a finalized credit memo was approved on: the `final` attribute snapshot its figure exhibits cite, that snapshot's version, and the entity the figures belong to. A pointer, not the figures: read them from `GET /api/loans/{loan_id}/attributes/{snapshot_id}`. Carried by `memo.finalized` and `memo.reopened` and by the memo list.

- `snapshot_id` (string, required) — The `final` attribute snapshot the memo's figures for this entity came from.
- `version` (integer, required) — That snapshot's per-loan version number.
- `entity` (MemoSpreadSnapshotEntity, required) — The entity the figures belong to.

### MemoSpreadSnapshotEntity

The entity a memo's pinned spread figures belong to: its scope `key` and display `name`.

- `key` (string, required) — The scope key, `business:...` or `person:...`, or `whole-loan` for the loan's own figures, such as a Global DSCR.
- `name` (string, optional, nullable) — The entity's display name. Null when none was stated.

## Examples

**Response**

```json
[
  {
    "id": "5d4c3b2a19087f6e5d4c3b2a",
    "name": "Credit memo",
    "updated_at": "2024-04-10T14:40:00.183231+00:00",
    "render_state": "ready",
    "spread_snapshots": [
      {
        "snapshot_id": "8a7b6c5d4e3f2a1b0c9d8e7f",
        "version": 2,
        "entity": {
          "key": "business:acme corporation",
          "name": "Acme Corporation"
        }
      }
    ],
    "finalized_at": "2024-04-10T14:46:12.204118+00:00",
    "figures_status": "unchanged"
  },
  {
    "id": "9e8d7c6b5a4f3e2d1c0b9a8f",
    "name": "Annual review memo",
    "updated_at": "2024-04-08T11:02:00.592569+00:00",
    "render_state": "none",
    "spread_snapshots": [],
    "finalized_at": null,
    "figures_status": null
  }
]
```

**SDK Code**

```python
import requests

url = "https://api.spreadspace.app/api/loans/9f8b7c6d5e4a3b2c1d0e4f5a/memos"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.spreadspace.app/api/loans/9f8b7c6d5e4a3b2c1d0e4f5a/memos';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spreadspace.app/api/loans/9f8b7c6d5e4a3b2c1d0e4f5a/memos"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.spreadspace.app/api/loans/9f8b7c6d5e4a3b2c1d0e4f5a/memos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.spreadspace.app/api/loans/9f8b7c6d5e4a3b2c1d0e4f5a/memos")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.spreadspace.app/api/loans/9f8b7c6d5e4a3b2c1d0e4f5a/memos', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.spreadspace.app/api/loans/9f8b7c6d5e4a3b2c1d0e4f5a/memos");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.spreadspace.app/api/loans/9f8b7c6d5e4a3b2c1d0e4f5a/memos")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```