minca
ApiSchemasVariables

Variable: transaction

const transaction: object & Typed<{
  amount: {
     amount: string;
     currency: string;
  };
  category?: string;
  cleared?: boolean;
  date: string;
  note?: string;
  payee?: string;
}>;

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

Money in or out of an account: negative amounts are out.

Type Declaration

description

readonly description: "Money in or out of a std.money-account. To split a cost with others, use std.expense." = 'Money in or out of a std.money-account. To split a cost with others, use std.expense.';
readonly links: object;

links.in

readonly in: LinkDeclaration;

name

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

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.category

readonly category: object;

schema.properties.category.maxLength

maxLength: number = max;

schema.properties.category.minLength?

minLength?: number = min;

schema.properties.category.type

type: "string";

schema.properties.cleared

readonly cleared: object;

schema.properties.cleared.type

readonly type: "boolean" = 'boolean';

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.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.payee

readonly payee: object;

schema.properties.payee.maxLength

maxLength: number = max;

schema.properties.payee.minLength?

minLength?: number = min;

schema.properties.payee.type

type: "string";

schema.required

readonly required: readonly ["amount", "date"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Transaction" = 'Transaction';

On this page