​yajsapi / Exports / rest/payment / DebitNote

Class: DebitNote

​rest/payment.DebitNote

Hierarchy

• yDebitNote

  ↳ DebitNote

Table of contents

Constructors

• ​constructor​

Properties

• ​_api​

• ​activityId​

• ​agreementId​

• ​debitNoteId​

• ​issuerId​

• ​payeeAddr​

• ​payerAddr​

• ​paymentDueDate​

• ​paymentPlatform​

• ​previousDebitNoteId​

• ​recipientId​

• ​status​

• ​timestamp​

• ​totalAmountDue​

• ​usageCounterVector​

Methods

• ​accept​

Constructors

constructor

• new DebitNote(_api: RequestorApi, _base: DebitNote): DebitNote​

Parameters:

Returns: DebitNote​

Defined in: yajsapi/rest/payment.ts:68​

Properties

_api

• Private _api: RequestorApi

Defined in: yajsapi/rest/payment.ts:68​

activityId

• activityId: string

Defined in: yajsapi/rest/payment.ts:37​

agreementId

• agreementId: string

Defined in: yajsapi/rest/payment.ts:36​

debitNoteId

• debitNoteId: string

Defined in: yajsapi/rest/payment.ts:28​

issuerId

• issuerId: string

Defined in: yajsapi/rest/payment.ts:29​

payeeAddr

• Optional payeeAddr: undefined | string

Defined in: yajsapi/rest/payment.ts:31​

payerAddr

• Optional payerAddr: undefined | string

Defined in: yajsapi/rest/payment.ts:32​

paymentDueDate

• Optional paymentDueDate: undefined | string

Defined in: yajsapi/rest/payment.ts:40​

paymentPlatform

• Optional paymentPlatform: undefined | string

Defined in: yajsapi/rest/payment.ts:33​

previousDebitNoteId

• Optional previousDebitNoteId: undefined | string

Defined in: yajsapi/rest/payment.ts:34​

recipientId

• recipientId: string

Defined in: yajsapi/rest/payment.ts:30​

status

• status: InvoiceStatus

Defined in: yajsapi/rest/payment.ts:41​

timestamp

• timestamp: string

Defined in: yajsapi/rest/payment.ts:35​

totalAmountDue

• totalAmountDue: string

Defined in: yajsapi/rest/payment.ts:38​

usageCounterVector

• Optional usageCounterVector: undefined | object

Defined in: yajsapi/rest/payment.ts:39​

Methods

accept

▸ accept(amount: string | number, allocation: Allocation): Promise<void>

Parameters:

Returns: Promise<void>

Defined in: yajsapi/rest/payment.ts:77​