Class: Invoice

payment/invoice.Invoice

An Invoice is an artifact issued by the Provider to the Requestor, in the context of a specific Agreement. It indicates the total Amount owed by the Requestor in this Agreement. No further Debit Notes shall be issued after the Invoice is issued. The issue of Invoice signals the Termination of the Agreement (if it hasn't been terminated already). No Activity execution is allowed after the Invoice is issued.

• BaseDocument<PaymentApi.InvoiceDTO>

  ↳ Invoice

• constructor

• activityIds
• amount
• timestamp
• recipientId
• model
• payeeAddr
• requestorWalletAddress
• paymentPlatform
• agreementId
• paymentDueDate
• status
• id
• provider

• getPreciseAmount
• isSameAs
• getStatus

• new Invoice(model, providerInfo): Invoice

Invoice

BaseDocument.constructor

src/payment/invoice.ts:30

• Optional Readonly activityIds: string[]

Activities IDs covered by this Invoice

src/payment/invoice.ts:18

• Readonly amount: string

Amount in the invoice

src/payment/invoice.ts:20

• Readonly timestamp: string

Invoice creation timestamp

src/payment/invoice.ts:22

• Readonly recipientId: string

Recipient ID

BaseDocument.recipientId

src/payment/invoice.ts:24

• Protected model: Invoice

BaseDocument.model

src/payment/invoice.ts:31

• Readonly payeeAddr: string

BaseDocument.payeeAddr

src/payment/BaseDocument.ts:20

• Readonly requestorWalletAddress: string

BaseDocument.requestorWalletAddress

src/payment/BaseDocument.ts:21

• Readonly paymentPlatform: string

BaseDocument.paymentPlatform

src/payment/BaseDocument.ts:22

• Readonly agreementId: string

BaseDocument.agreementId

src/payment/BaseDocument.ts:23

• Optional Readonly paymentDueDate: string

BaseDocument.paymentDueDate

src/payment/BaseDocument.ts:24

• Protected status: "ISSUED" | "RECEIVED" | "ACCEPTED" | "REJECTED" | "FAILED" | "SETTLED" | "CANCELLED"

BaseDocument.status

src/payment/BaseDocument.ts:26

• Readonly id: string

BaseDocument.id

src/payment/BaseDocument.ts:29

• Readonly provider: ProviderInfo

BaseDocument.provider

src/payment/BaseDocument.ts:31

▸ getPreciseAmount(): Decimal

Decimal

src/payment/invoice.ts:41

▸ isSameAs(invoice): boolean

Compares two invoices together and tells if they are the same thing

boolean

src/payment/invoice.ts:48

▸ getStatus(): "ISSUED" | "RECEIVED" | "ACCEPTED" | "REJECTED" | "FAILED" | "SETTLED" | "CANCELLED"

Tells what's the current status of the document

"ISSUED" | "RECEIVED" | "ACCEPTED" | "REJECTED" | "FAILED" | "SETTLED" | "CANCELLED"

BaseDocument.getStatus

src/payment/BaseDocument.ts:45