Class: BaseDocument<ModelType>

payment/BaseDocument.BaseDocument

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

• BaseDocument

  ↳ DebitNote

  ↳ Invoice

• constructor

• recipientId
• payeeAddr
• requestorWalletAddress
• paymentPlatform
• agreementId
• paymentDueDate
• status
• id
• model
• provider

• getStatus

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

BaseDocument<ModelType>

src/payment/BaseDocument.ts:28

• Readonly recipientId: string

src/payment/BaseDocument.ts:19

• Readonly payeeAddr: string

src/payment/BaseDocument.ts:20

• Readonly requestorWalletAddress: string

src/payment/BaseDocument.ts:21

• Readonly paymentPlatform: string

src/payment/BaseDocument.ts:22

• Readonly agreementId: string

src/payment/BaseDocument.ts:23

• Optional Readonly paymentDueDate: string

src/payment/BaseDocument.ts:24

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

src/payment/BaseDocument.ts:26

• Readonly id: string

src/payment/BaseDocument.ts:29

• Protected model: ModelType

src/payment/BaseDocument.ts:30

• Readonly provider: ProviderInfo

src/payment/BaseDocument.ts:31

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

Tells what's the current status of the document

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

src/payment/BaseDocument.ts:45