SudoSOS Backend

Appearance

SudoSOS Back-end API / balance / BalanceResponse

Interface: BalanceResponse ​

Extends ​

Properties ​

amount ​

ts
amount: DineroObjectResponse;

createdAt? ​

ts
optional createdAt: string;

Inherited from ​

BaseUserResponse.createdAt

date ​

ts
date: string;

fine? ​

ts
optional fine: DineroObjectResponse;

The amount of fines this user has at the current point in time, aka "now" (if any). Should be ignored if date is not now.

fineSince? ​

ts
optional fineSince: string;

Timestamp of the first fine

fineWaived? ​

ts
optional fineWaived: DineroObjectRequest;

The amount of fines that have been waived. Should be subtracted from the "fine" property to calculate the actual amount of fines the user has. Only represents the current point in time, aka "now" (if any). Should be ignored if date is not now.

firstName ​

ts
firstName: string;

Inherited from ​

BaseUserResponse.firstName

id ​

ts
id: number;

Inherited from ​

BaseUserResponse.id

lastName ​

ts
lastName: string;

Inherited from ​

BaseUserResponse.lastName

lastTransactionDate? ​

ts
optional lastTransactionDate: string;

The timestamp of this user's last transaction. NULL if this user has not made any transactions

lastTransactionId ​

ts
lastTransactionId: number;

The ID of the last transaction that was present when the balance was cached. -1 if the user has not made any transactions

lastTransferId ​

ts
lastTransferId: number;

The ID of the last transfer that was present when the balance was cached. -1 if the user has not made any transfers

memberId? ​

ts
optional memberId: number;

The external member ID of the user (e.g., GEWIS member ID), if any

nickname? ​

ts
optional nickname: string;

The nickname of the user

Inherited from ​

BaseUserResponse.nickname

nrFines ​

ts
nrFines: number;

type ​

ts
type: UserType;

updatedAt? ​

ts
optional updatedAt: string;

Inherited from ​

BaseUserResponse.updatedAt

version? ​

ts
optional version: number;

Inherited from ​

BaseUserResponse.version