rest_payment.debitnote.md

Class: DebitNote

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, _base)

Parameters

Name	Type
_api	RequestorApi
_base	DebitNote

Overrides

yDebitNote.constructor

Defined in

yajsapi/rest/payment.ts:71

Properties

_api

• Private _api: RequestorApi

Defined in

yajsapi/rest/payment.ts:71

activityId

• activityId: string

Inherited from

yDebitNote.activityId

Defined in

yajsapi/rest/payment.ts:38

agreementId

• agreementId: string

Inherited from

yDebitNote.agreementId

Defined in

yajsapi/rest/payment.ts:37

debitNoteId

• debitNoteId: string

Inherited from

yDebitNote.debitNoteId

Defined in

yajsapi/rest/payment.ts:29

issuerId

• issuerId: string

Inherited from

yDebitNote.issuerId

Defined in

yajsapi/rest/payment.ts:30

payeeAddr

• Optional payeeAddr: string

Inherited from

yDebitNote.payeeAddr

Defined in

yajsapi/rest/payment.ts:32

payerAddr

• Optional payerAddr: string

Inherited from

yDebitNote.payerAddr

Defined in

yajsapi/rest/payment.ts:33

paymentDueDate

• Optional paymentDueDate: string

Inherited from

yDebitNote.paymentDueDate

Defined in

yajsapi/rest/payment.ts:41

paymentPlatform

• Optional paymentPlatform: string

Inherited from

yDebitNote.paymentPlatform

Defined in

yajsapi/rest/payment.ts:34

previousDebitNoteId

• Optional previousDebitNoteId: string

Inherited from

yDebitNote.previousDebitNoteId

Defined in

yajsapi/rest/payment.ts:35

recipientId

• recipientId: string

Inherited from

yDebitNote.recipientId

Defined in

yajsapi/rest/payment.ts:31

status

• status: InvoiceStatus

Inherited from

yDebitNote.status

Defined in

yajsapi/rest/payment.ts:42

timestamp

• timestamp: string

Inherited from

yDebitNote.timestamp

Defined in

yajsapi/rest/payment.ts:36

totalAmountDue

• totalAmountDue: string

Inherited from

yDebitNote.totalAmountDue

Defined in

yajsapi/rest/payment.ts:39

usageCounterVector

• Optional usageCounterVector: object

Inherited from

yDebitNote.usageCounterVector

Defined in

yajsapi/rest/payment.ts:40

Methods

accept

▸ accept(amount, allocation): Promise

Parameters

Name	Type
amount	string | number
allocation	Allocation

Returns

Promise

Defined in

yajsapi/rest/payment.ts:80