​yajsapi / Exports / rest/payment / Invoice

Class: Invoice

​rest/payment.Invoice

Hierarchy

• yInvoice

  ↳ Invoice

Table of contents

Constructors

• ​constructor​

Properties

• ​_api​

• ​activityIds​

• ​agreementId​

• ​amount​

• ​invoiceId​

• ​issuerId​

• ​lastDebitNoteId​

• ​payeeAddr​

• ​payerAddr​

• ​paymentDueDate​

• ​paymentPlatform​

• ​recipientId​

• ​status​

• ​timestamp​

Methods

• ​accept​

Constructors

constructor

• new Invoice(_api, _base)

Parameters

Overrides

yInvoice.constructor

Defined in

​yajsapi/rest/payment.ts:46​

Properties

_api

• Private _api: RequestorApi

Defined in

​yajsapi/rest/payment.ts:46​

activityIds

• Optional activityIds: string[]

Inherited from

yInvoice.activityIds

Defined in

​yajsapi/rest/payment.ts:22​

agreementId

• agreementId: string

Inherited from

yInvoice.agreementId

Defined in

​yajsapi/rest/payment.ts:21​

amount

• amount: string

Inherited from

yInvoice.amount

Defined in

​yajsapi/rest/payment.ts:23​

invoiceId

• invoiceId: string

Inherited from

yInvoice.invoiceId

Defined in

​yajsapi/rest/payment.ts:13​

issuerId

• issuerId: string

Inherited from

yInvoice.issuerId

Defined in

​yajsapi/rest/payment.ts:14​

lastDebitNoteId

• Optional lastDebitNoteId: string

Inherited from

yInvoice.lastDebitNoteId

Defined in

​yajsapi/rest/payment.ts:19​

payeeAddr

• Optional payeeAddr: string

Inherited from

yInvoice.payeeAddr

Defined in

​yajsapi/rest/payment.ts:16​

payerAddr

• Optional payerAddr: string

Inherited from

yInvoice.payerAddr

Defined in

​yajsapi/rest/payment.ts:17​

paymentDueDate

• paymentDueDate: string

Inherited from

yInvoice.paymentDueDate

Defined in

​yajsapi/rest/payment.ts:24​

paymentPlatform

• Optional paymentPlatform: string

Inherited from

yInvoice.paymentPlatform

Defined in

​yajsapi/rest/payment.ts:18​

recipientId

• recipientId: string

Inherited from

yInvoice.recipientId

Defined in

​yajsapi/rest/payment.ts:15​

status

• status: InvoiceStatus

Inherited from

yInvoice.status

Defined in

​yajsapi/rest/payment.ts:25​

timestamp

• timestamp: string

Inherited from

yInvoice.timestamp

Defined in

​yajsapi/rest/payment.ts:20​

Methods

accept

▸ accept(amount, allocation): Promise

Parameters

Returns

Promise

Defined in

​yajsapi/rest/payment.ts:55​