am.noz.at.spl.group

noz.am

Documentation

Optional group or trip metadata inside a ledger Space. Multiple groups may share one Space when they have the same members.

main record

Optional group or trip metadata inside a ledger Space. Multiple groups may share one Space when they have the same members.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

defaultCurrency string Required

Uppercase ISO 4217 currency code, such as EUR or USD.

maxLength: 3 bytesminLength: 3 bytes
groupId string Required

No description available.

maxLength: 64 bytesminLength: 1 bytes
kind string Required

No description available.

Allowed: group, trip, household, couple, other
name string Required

No description available.

maxLength: 256 bytesminLength: 1 bytesmaxGraphemes: 80 graphemes
schemaVersion integer Required

No description available.

simplifyDebts boolean Required

No description available.

timezone string Required

IANA time-zone name used for recurring expenses.

maxLength: 64 bytesminLength: 1 bytes
updatedAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "schemaVersion",
      "groupId",
      "name",
      "kind",
      "defaultCurrency",
      "timezone",
      "simplifyDebts",
      "members",
      "createdAt",
      "updatedAt"
    ],
    "properties": {
      "kind": {
        "enum": [
          "group",
          "trip",
          "household",
          "couple",
          "other"
        ],
        "type": "string"
      },
      "name": {
        "type": "string",
        "maxLength": 256,
        "minLength": 1,
        "maxGraphemes": 80
      },
      "groupId": {
        "type": "string",
        "maxLength": 64,
        "minLength": 1
      },
      "members": {
        "type": "array",
        "items": {
          "ref": "lex:am.noz.at.spl.group#member",
          "type": "ref"
        },
        "maxLength": 250,
        "minLength": 1
      },
      "timezone": {
        "type": "string",
        "maxLength": 64,
        "minLength": 1,
        "description": "IANA time-zone name used for recurring expenses."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime"
      },
      "schemaVersion": {
        "type": "integer",
        "const": 1
      },
      "simplifyDebts": {
        "type": "boolean"
      },
      "defaultCurrency": {
        "type": "string",
        "maxLength": 3,
        "minLength": 3,
        "description": "Uppercase ISO 4217 currency code, such as EUR or USD."
      }
    }
  },
  "description": "Optional group or trip metadata inside a ledger Space. Multiple groups may share one Space when they have the same members."
}
member object

No description available.

Properties

active boolean Required

No description available.

did string did Required

A decentralized identifier (DID).

joinedAt string datetime Required

An RFC 3339 formatted timestamp.

role string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "did",
    "role",
    "joinedAt",
    "active"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "role": {
      "enum": [
        "owner",
        "admin",
        "member"
      ],
      "type": "string"
    },
    "active": {
      "type": "boolean"
    },
    "joinedAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}

Lexicon Garden

@