Class: DebitNote

payment/debit_note.DebitNote

A Debit Note is an artifact issued by the Provider to the Requestor, in the context of a specific Activity. It is a notification of Total Amount Due incurred by the Activity until the moment the Debit Note is issued. This is expected to be used as trigger for payment in upfront-payment or pay-as-you-go scenarios. NOTE: Only Debit Notes with non-null paymentDueDate are expected to trigger payments. NOTE: Debit Notes flag the current Total Amount Due, which is accumulated from the start of Activity. Debit Notes are expected to trigger payments, therefore payment amount for the newly received Debit Note is expected to be determined by difference of Total Payments for the Agreement vs Total Amount Due.

• BaseDocument<PaymentApi.DebitNoteDTO>

  ↳ DebitNote

• constructor

• id
• previousDebitNoteId
• timestamp
• activityId
• totalAmountDue
• usageCounterVector
• model
• recipientId
• payeeAddr
• requestorWalletAddress
• paymentPlatform
• agreementId
• paymentDueDate
• status
• provider

• getPreciseAmount
• getStatus

• new DebitNote(model, providerInfo): DebitNote

DebitNote

BaseDocument.constructor

src/payment/debit_note.ts:26

• Readonly id: string

BaseDocument.id

src/payment/debit_note.ts:14

• Optional Readonly previousDebitNoteId: string

src/payment/debit_note.ts:15

• Readonly timestamp: string

src/payment/debit_note.ts:16

• Readonly activityId: string

src/payment/debit_note.ts:17

• Readonly totalAmountDue: string

src/payment/debit_note.ts:18

• Optional Readonly usageCounterVector: object

src/payment/debit_note.ts:19

• Protected model: DebitNote

BaseDocument.model

src/payment/debit_note.ts:27

• Readonly recipientId: string

BaseDocument.recipientId

src/payment/BaseDocument.ts:19

• Readonly payeeAddr: string

BaseDocument.payeeAddr

src/payment/BaseDocument.ts:20

• Readonly requestorWalletAddress: string

BaseDocument.requestorWalletAddress

src/payment/BaseDocument.ts:21

• Readonly paymentPlatform: string

BaseDocument.paymentPlatform

src/payment/BaseDocument.ts:22

• Readonly agreementId: string

BaseDocument.agreementId

src/payment/BaseDocument.ts:23

• Optional Readonly paymentDueDate: string

BaseDocument.paymentDueDate

src/payment/BaseDocument.ts:24

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

BaseDocument.status

src/payment/BaseDocument.ts:26

• Readonly provider: ProviderInfo

BaseDocument.provider

src/payment/BaseDocument.ts:31

▸ getPreciseAmount(): Decimal

Decimal

src/payment/debit_note.ts:38

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

Tells what's the current status of the document

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

BaseDocument.getStatus

src/payment/BaseDocument.ts:45