SudoSOS Back-end API / transfers / Transfer

Class: Transfer

TypeORM entity for the transfer table. A single money movement on or off SudoSOS; one of from or to may be null when the counterparty lives outside the system (a Stripe deposit, a bank payout). The domain that originated the movement keeps a OneToOne back-reference, which is how the type of a transfer (deposit, fine, payout, ...) is identified at read time.

Extends

• BaseEntity

Constructors

Constructor

new Transfer(): Transfer;

Returns

Transfer

Inherited from

BaseEntity.constructor

Properties

Property	Modifier	Type	Description	Inherited from
amountInclVat	public	Dinero	-	-
createdAt	readonly	Date	The creation date of the object.	BaseEntity.createdAt
creditInvoice	public	Invoice	-	-
deposit	public	StripeDeposit	-	-
description?	public	string	If the transfer is of type 'custom', this contains a description of the transfer.	-
fine	public	Fine	-	-
from?	public	User	The account from which the transfer is subtracted. Can be null if money was deposited.	-
fromId?	public	number	-	-
id	readonly	number	-	BaseEntity.id
inactiveAdministrativeCost	public	InactiveAdministrativeCost	-	-
invoice	public	Invoice	-	-
payoutRequest	public	PayoutRequest	-	-
sellerPayout	public	SellerPayout	-	-
to?	public	User	The account to which the transaction is added. Can be null if money was paid out.	-
toId?	public	number	-	-
updatedAt	readonly	Date	The last update date of the object.	BaseEntity.updatedAt
vat?	public	VatGroup	The vat group of the transfer	-
version	readonly	number	The current version of the object.	BaseEntity.version
waivedFines	public	UserFineGroup	-	-
writeOff	public	WriteOff	-	-