SudoSOS Back-end API / transfers / Transfer

Class: Transfer

Extends

• UnstoredPdfAbleClass<typeof BaseEntity, this> & BaseEntity<this>

Constructors

Constructor

new Transfer(): Transfer;

Returns

Transfer

Inherited from

UnstoredPdfAble(BaseEntity).constructor

Properties

Property	Modifier	Type	Description	Overrides	Inherited from
amountInclVat	public	Dinero	-	-	-
createdAt	readonly	Date	-	-	UnstoredPdfAble(BaseEntity).createdAt
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	-	-	UnstoredPdfAble(BaseEntity).id
inactiveAdministrativeCost	public	InactiveAdministrativeCost	-	-	-
invoice	public	Invoice	-	-	-
payoutRequest	public	PayoutRequest	-	-	-
pdfService	public	TransferPdfService	The service that creates the Pdf buffer. Can be either a LaTeX-based service (UnstoredPdfService) or HTML-based service (HtmlUnstoredPdfService).	UnstoredPdfAble(BaseEntity).pdfService	-
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	-	-	UnstoredPdfAble(BaseEntity).updatedAt
vat?	public	VatGroup	The vat group of the transfer	-	-
version	readonly	number	-	-	UnstoredPdfAble(BaseEntity).version
waivedFines	public	UserFineGroup	-	-	-
writeOff	public	WriteOff	-	-	-

Methods

createPdf()

createPdf(): Promise<Buffer<ArrayBufferLike>>;

Create the Pdf buffer. This method generates the PDF and returns it as a Buffer.

Returns

Promise<Buffer<ArrayBufferLike>>

Inherited from

UnstoredPdfAble(BaseEntity).createPdf

---

createRaw()

createRaw(): Promise<Buffer<ArrayBufferLike>>;

Returns

Promise<Buffer<ArrayBufferLike>>

Inherited from

UnstoredPdfAble(BaseEntity).createRaw

---

createTex()

createTex(): Promise<Buffer<ArrayBufferLike>>;

Returns

Promise<Buffer<ArrayBufferLike>>

Deprecated

Use createRaw() instead

Inherited from

UnstoredPdfAble(BaseEntity).createTex

---

getPdfParamHash()

getPdfParamHash(): Promise<string>;

Returns

Promise<string>

Inherited from

UnstoredPdfAble(BaseEntity).getPdfParamHash