Account

Extends

Account

Properties

agentId?

optional agentId: string;

The id of agent that created the resource

Inherited from

bkper.Account.agentId

archived?

optional archived: boolean;

Archived accounts are kept for history

Inherited from

bkper.Account.archived

balance?

optional balance: string;

The current account balance, when querying transactions.

Inherited from

bkper.Account.balance

balanceVerified?

optional balanceVerified: boolean;

Whether the account balance has been verified/audited

Inherited from

bkper.Account.balanceVerified

createdAt?

optional createdAt: string;

The creation timestamp, in milliseconds

Inherited from

bkper.Account.createdAt

credit?

optional credit: boolean;

Credit nature or Debit otherwise

Inherited from

bkper.Account.credit

groups?

optional groups: Group[];

The groups of the account

Inherited from

bkper.Account.groups

hasTransactionPosted?

optional hasTransactionPosted: boolean;

Tell if the account has transaction posted

Inherited from

bkper.Account.hasTransactionPosted

id?

optional id: string;

The unique id that identifies the Account in the Book

Inherited from

bkper.Account.id

name?

optional name: string;

The name of the Account

Inherited from

bkper.Account.name

normalizedName?

optional normalizedName: string;

The name of the Account, lowercase, without spaces or special characters

Inherited from

bkper.Account.normalizedName

permanent?

optional permanent: boolean;

Permanent are such as bank accounts, customers or the like

Inherited from

bkper.Account.permanent

properties?

optional properties: object;

The key/value custom properties of the Account

Index Signature

[name: string]: string

Inherited from

bkper.Account.properties

type?

optional type: "ASSET" | "LIABILITY" | "INCOMING" | "OUTGOING";

The type of the account

Inherited from

bkper.Account.type

updatedAt?

optional updatedAt: string;

The last update timestamp, in milliseconds

Inherited from

bkper.Account.updatedAt