Class: AgreementPaymentProcess

payment/agreement_payment_process.AgreementPaymentProcess

Process manager that controls the logic behind processing payments for an agreement (debit notes and invoices). The process is started automatically and ends when the final invoice is received. You can stop the process earlier by calling the stop method. You cannot restart the process after stopping it.

• constructor

• logger
• agreement
• allocation
• paymentModule

• addDebitNote
• addInvoice
• isFinished
• isStarted
• stop

• new AgreementPaymentProcess(agreement, allocation, paymentModule, options?, logger?): AgreementPaymentProcess

AgreementPaymentProcess

src/payment/agreement_payment_process.ts:59

• Readonly logger: Logger

src/payment/agreement_payment_process.ts:55

• Readonly agreement: Agreement

src/payment/agreement_payment_process.ts:60

• Readonly allocation: Allocation

src/payment/agreement_payment_process.ts:61

• Readonly paymentModule: PaymentModule

src/payment/agreement_payment_process.ts:62

▸ addDebitNote(debitNote): Promise<boolean>

Adds the debit note to the process avoiding race conditions

Promise<boolean>

src/payment/agreement_payment_process.ts:91

▸ addInvoice(invoice): Promise<boolean>

Adds the invoice to the process avoiding race conditions

Promise<boolean>

src/payment/agreement_payment_process.ts:98

▸ isFinished(): boolean

Tells if the process reached a point in which we can consider it as "finished"

boolean

src/payment/agreement_payment_process.ts:105

▸ isStarted(): boolean

boolean

src/payment/agreement_payment_process.ts:293

▸ stop(): void

void

src/payment/agreement_payment_process.ts:297