minca
ApiSchemasVariables

Variable: settlement

const settlement: object & Typed<{
  amount: {
     amount: string;
     currency: string;
  };
  date?: string;
  from: string;
  note?: string;
  to: string;
}>;

Defined in: packages/core/src/schemas/library/money.ts:63

Money paid back between two people. Once written, who and how much stay as they are.

Type Declaration

description

readonly description: "Money paid back from one person to another." = 'Money paid back from one person to another.';

name

readonly name: "std.settlement" = 'std.settlement';

rules

readonly rules: object;

rules.fixed

readonly fixed: readonly ["from", "to", "amount"];

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.amount

readonly amount: object & object;
Type Declaration
properties
properties: object;
properties.amount
amount: object;
properties.amount.maxLength
maxLength: number = max;
properties.amount.minLength?
minLength?: number = min;
properties.amount.type
type: "string";
properties.currency
currency: object;
properties.currency.maxLength
maxLength: number = 3;
properties.currency.minLength
minLength: number = 3;
properties.currency.type
type: "string";
required
required: readonly ["amount", "currency"];
type
type: "object";
x-kind
readonly "x-kind": "money";

schema.properties.date

readonly date: object & object;
Type Declaration
maxLength
maxLength: number = 10;
minLength
minLength: number = 10;
type
type: "string";
x-kind
readonly "x-kind": "day";

schema.properties.from

readonly from: object & object;
Type Declaration
maxLength
maxLength: number = max;
minLength?
minLength?: number = min;
type
type: "string";
x-kind
readonly "x-kind": "did";

schema.properties.note

readonly note: object;

schema.properties.note.maxLength

maxLength: number = max;

schema.properties.note.minLength?

minLength?: number = min;

schema.properties.note.type

type: "string";

schema.properties.to

readonly to: object & object;
Type Declaration
maxLength
maxLength: number = max;
minLength?
minLength?: number = min;
type
type: "string";
x-kind
readonly "x-kind": "did";

schema.required

readonly required: readonly ["from", "to", "amount"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Settlement" = 'Settlement';

topics

readonly topics: readonly ["from", "to"];

On this page