JS API Reference

Class: BaseDocument<ModelType>

payment/BaseDocument.BaseDocument

Common properties and methods for payment related documents - Invoices and DebitNotes

Type parameters

NameType
ModelTypeextends BaseModel

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new BaseDocument<ModelType>(id, model, provider): BaseDocument<ModelType>

Type parameters

NameType
ModelTypeextends BaseModel

Parameters

NameType
idstring
modelModelType
providerProviderInfo

Returns

BaseDocument<ModelType>

Defined in

src/payment/BaseDocument.ts:28

Properties

recipientId

Readonly recipientId: string

Defined in

src/payment/BaseDocument.ts:19


payeeAddr

Readonly payeeAddr: string

Defined in

src/payment/BaseDocument.ts:20


requestorWalletAddress

Readonly requestorWalletAddress: string

Defined in

src/payment/BaseDocument.ts:21


paymentPlatform

Readonly paymentPlatform: string

Defined in

src/payment/BaseDocument.ts:22


agreementId

Readonly agreementId: string

Defined in

src/payment/BaseDocument.ts:23


paymentDueDate

Optional Readonly paymentDueDate: string

Defined in

src/payment/BaseDocument.ts:24


status

Protected status: "ISSUED" | "RECEIVED" | "ACCEPTED" | "REJECTED" | "FAILED" | "SETTLED" | "CANCELLED"

Defined in

src/payment/BaseDocument.ts:26


id

Readonly id: string

Defined in

src/payment/BaseDocument.ts:29


model

Protected model: ModelType

Defined in

src/payment/BaseDocument.ts:30


provider

Readonly provider: ProviderInfo

Defined in

src/payment/BaseDocument.ts:31

Methods

getStatus

getStatus(): "ISSUED" | "RECEIVED" | "ACCEPTED" | "REJECTED" | "FAILED" | "SETTLED" | "CANCELLED"

Tells what's the current status of the document

Returns

"ISSUED" | "RECEIVED" | "ACCEPTED" | "REJECTED" | "FAILED" | "SETTLED" | "CANCELLED"

Defined in

src/payment/BaseDocument.ts:45