​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: RequestorApi, _base: Invoice): Invoice​

Parameters:

Returns: Invoice​

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

Properties

_api

• Private _api: RequestorApi

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

activityIds

• Optional activityIds: undefined | string[]

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

agreementId

• agreementId: string

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

amount

• amount: string

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

invoiceId

• invoiceId: string

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

issuerId

• issuerId: string

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

lastDebitNoteId

• Optional lastDebitNoteId: undefined | string

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

payeeAddr

• Optional payeeAddr: undefined | string

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

payerAddr

• Optional payerAddr: undefined | string

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

paymentDueDate

• paymentDueDate: string

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

paymentPlatform

• Optional paymentPlatform: undefined | string

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

recipientId

• recipientId: string

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

status

• status: InvoiceStatus

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

timestamp

• timestamp: string

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

Methods

accept

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

Parameters:

Returns: Promise<void>

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