# dev.cocore.compute.listSettlements

> Published by [cocore.dev](https://lexicon.garden/identity/did:plc:5quuhkmwe2q4k3azfsgg7kdz)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:5quuhkmwe2q4k3azfsgg7kdz/dev.cocore.compute.listSettlements)
- [Documentation](https://lexicon.garden/lexicon/did:plc:5quuhkmwe2q4k3azfsgg7kdz/dev.cocore.compute.listSettlements/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:5quuhkmwe2q4k3azfsgg7kdz/dev.cocore.compute.listSettlements/examples)

## Definitions

### `dev.cocore.compute.listSettlements`

**Type**: `query`

Indexed `dev.cocore.compute.settlement` records (capped at 200), optionally filtered by the settled receipt URI and/or the requester DID (matched against the authorization URI prefix).

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `receipt` | `string` (at-uri) | No | Filter to settlements of this receipt URI. |
| `requester` | `string` (did) | No | Filter to settlements whose requester authorization is hosted by this DID. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `settlements` | `array` | Yes |  |

## Raw Schema

```json
{
  "id": "dev.cocore.compute.listSettlements",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "settlements"
          ],
          "properties": {
            "settlements": {
              "type": "array",
              "items": {
                "ref": "dev.cocore.defs#indexedRecord",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "receipt": {
            "type": "string",
            "format": "at-uri",
            "description": "Filter to settlements of this receipt URI."
          },
          "requester": {
            "type": "string",
            "format": "did",
            "description": "Filter to settlements whose requester authorization is hosted by this DID."
          }
        }
      },
      "description": "Indexed `dev.cocore.compute.settlement` records (capped at 200), optionally filtered by the settled receipt URI and/or the requester DID (matched against the authorization URI prefix)."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
