Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InvoiceEvent

This event is sent when an invoice is sent, paid or cancelled to the integrator system.

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

_eid

_eid: string

Event unique id

_type

_type: EventType

Event type

_v

_v: string

Event format version / API version

Optional cancellationStatus

cancellationStatus?: "sent" | "paid" | "written_off" | "created" | "send_pending"

Cancellation lifecycle status. Set when the document has been (or is being) cancelled via a separate cancellation document (storno):

  • created - the cancellation document has been issued (PDF rendered)
  • send_pending - the cancellation document is queued for sending
  • sent - the cancellation document was sent
  • paid - the cancellation has been reconciled with a refund payment
  • written_off - terminal state coupled with status=written_off when the cancellation itself was written off

Absent on documents that have never been cancelled.

items

items: LineItem[]

The line items contained in the document

number

number: string

Document number

status

status: "sent" | "received" | "paid" | "written_off"

Main lifecycle status of the document:

  • sent/received - document was sent to or received from the official channel (usually email) to/from the accounting department of the integrators company.
  • paid - document was fully paid
  • written_off - the original document was written off because a cancellation was issued. Inspect cancellationStatus for the cancellation document's lifecycle.

type

type: "invoice" | "credit_note"

Whether the document is an invoice or credit note

Generated using TypeDoc