@loktin/sdk / spend-save / Enrollment

Interface: Enrollment

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:23

A user's enrolment with one integrator, as stored.

Extended by

• EnrollmentView

Properties

destination

readonly destination: Destination

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:33

---

integrator

readonly integrator: string

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:25

---

integratorFeeBps

readonly integratorFeeBps: number

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:26

---

loktinFeeBps

readonly loktinFeeBps: number

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:27

---

monthIndex

readonly monthIndex: number

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:41

The month savedThisMonth belongs to.

---

monthlyCap

readonly monthlyCap: bigint | undefined

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:32

---

pendingDay

readonly pendingDay: PendingDay | undefined

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:36

---

principal

readonly principal: bigint

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:38

The Spend & Save balance.

---

savedThisMonth

readonly savedThisMonth: bigint

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:42

---

shares

readonly shares: bigint

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:39

---

skim

readonly skim: object

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:28

percentBps

readonly percentBps: number | undefined

roundUpUnit

readonly roundUpUnit: bigint | undefined

---

totalSaved

readonly totalSaved: bigint

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:44

---

totalSpent

readonly totalSpent: bigint

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:43

---

user

readonly user: string

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:24

---

withdrawalDay

readonly withdrawalDay: number

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:35

The stored withdrawal day. A pending change may already apply: see effectiveWithdrawalDay.