# am.noz.at.spl.settlement

> Published by [noz.am](https://lexicon.garden/identity/did:plc:lmkzmvv6sdxntwtyxpg7fqqq)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:lmkzmvv6sdxntwtyxpg7fqqq/am.noz.at.spl.settlement)
- [Documentation](https://lexicon.garden/lexicon/did:plc:lmkzmvv6sdxntwtyxpg7fqqq/am.noz.at.spl.settlement/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:lmkzmvv6sdxntwtyxpg7fqqq/am.noz.at.spl.settlement/examples)

## Definitions

### `am.noz.at.spl.settlement`

**Type**: `record`

An immutable record of money paid between two ledger members, optionally filed in a group.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `note` | `string` | No |  |
| `toDid` | `string` (did) | Yes |  |
| `voided` | `boolean` | Yes |  |
| `fromDid` | `string` (did) | Yes |  |
| `groupId` | `string` | No | Optional organizational group or trip within the ledger Space. |
| `currency` | `string` | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `minorUnit` | `integer` | Yes |  |
| `occurredAt` | `string` (datetime) | Yes |  |
| `amountMinor` | `integer` | Yes |  |
| `settlementId` | `string` | Yes |  |
| `schemaVersion` | `integer` | Yes |  |
| `paymentReference` | `string` | No | Optional opaque reference from a payment integration; never store credentials or secrets. |

## Raw Schema

```json
{
  "id": "am.noz.at.spl.settlement",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "schemaVersion",
          "settlementId",
          "fromDid",
          "toDid",
          "currency",
          "minorUnit",
          "amountMinor",
          "occurredAt",
          "createdAt",
          "voided"
        ],
        "properties": {
          "note": {
            "type": "string",
            "maxLength": 2000,
            "maxGraphemes": 300
          },
          "toDid": {
            "type": "string",
            "format": "did"
          },
          "voided": {
            "type": "boolean"
          },
          "fromDid": {
            "type": "string",
            "format": "did"
          },
          "groupId": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1,
            "description": "Optional organizational group or trip within the ledger Space."
          },
          "currency": {
            "type": "string",
            "maxLength": 3,
            "minLength": 3
          },
          "createdAt": {
            "type": "string",
            "format": "datetime"
          },
          "minorUnit": {
            "type": "integer",
            "maximum": 4,
            "minimum": 0
          },
          "occurredAt": {
            "type": "string",
            "format": "datetime"
          },
          "amountMinor": {
            "type": "integer",
            "minimum": 1
          },
          "settlementId": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1
          },
          "schemaVersion": {
            "type": "integer",
            "const": 1
          },
          "paymentReference": {
            "type": "string",
            "maxLength": 500,
            "description": "Optional opaque reference from a payment integration; never store credentials or secrets."
          }
        }
      },
      "description": "An immutable record of money paid between two ledger members, optionally filed in a group."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```