SudoSOS Back-end API / seller-payouts / SellerPayout

Class: SellerPayout

Extends

• PdfAbleClass<typeof default, this> & BasePayout<this>

Constructors

Constructor

new SellerPayout(): SellerPayout;

Returns

SellerPayout

Inherited from

PdfAble(BasePayout).constructor

Properties

Property	Modifier	Type	Description	Overrides	Inherited from
amount	public	Dinero	-	-	PdfAble(BasePayout).amount
createdAt	readonly	Date	-	-	PdfAble(BasePayout).createdAt
endDate	public	Date	-	-	-
id	readonly	number	-	-	PdfAble(BasePayout).id
pdf?	public	SellerPayoutPdf	The Pdf file.	PdfAble(BasePayout).pdf	-
pdfId?	public	number	The id of the Pdf file.	PdfAble(BasePayout).pdfId	-
pdfService	public	SellerPayoutPdfService	The service that creates the Pdf file. Can be either a byte-producing service plus optionally a stored-entity service.	PdfAble(BasePayout).pdfService	-
reference	public	string	-	-	-
requestedBy	public	User	-	-	PdfAble(BasePayout).requestedBy
startDate	public	Date	-	-	-
transfer?	public	Transfer	-	-	PdfAble(BasePayout).transfer
updatedAt	readonly	Date	-	-	PdfAble(BasePayout).updatedAt
version	readonly	number	-	-	PdfAble(BasePayout).version

Methods

createPdf()

createPdf(): Promise<Pdf>;

Create and persist the Pdf file, returning the Pdf entity. The configured pdfService must implement createPdfWithEntity, otherwise this throws.

Returns

Promise<Pdf>

Inherited from

PdfAble(BasePayout).createPdf

---

getOrCreatePdf()

getOrCreatePdf(force?): Promise<Pdf>;

Get the Pdf file. If the Pdf file is not current, create it.

Parameters

Parameter	Type	Default value	Description
force	boolean	false	If true, always create the Pdf file.

Returns

Promise<Pdf>

Inherited from

PdfAble(BasePayout).getOrCreatePdf

---

getOwner()

abstract getOwner(): Promise<User>;

Get the owner of the Pdf file.

Returns

Promise<User>

Inherited from

PdfAble(BasePayout).getOwner

---

getPdfParamHash()

getPdfParamHash(): Promise<string>;

Get the hash of the parameters of the Pdf file.

Returns

Promise<string>

Inherited from

PdfAble(BasePayout).getPdfParamHash

---

validatePdfHash()

validatePdfHash(): Promise<boolean>;

Validates if the Pdf matches the stored hash.

Returns

Promise<boolean>

Inherited from

PdfAble(BasePayout).validatePdfHash