Documentation
Documentation
Transaction Invoice
Close API Documentation
Transaction Invoice

The transaction invoice represents the invoice document for a particular transaction.

States
  • Create
    The invoice is in the process of the creation.
  • Not Applicable
    The invoice is managed externally and as such tracking of the state is not possible.
  • Open
    The payment is outstanding.
  • Overdue
    The transaction is not paid. It should have been arrived on the merchant's account.
  • Paid
    The amount is paid to the merchant's account.
  • Derecognized
    The invoice is derecognized.
  • Canceled
    The invoice has been canceled.
Properties
  • Amount
  • Billing Address
  • Completion
  • Created On
    The date on which the invoice is created on.
  • Derecognized By
    The id of the user which marked the invoice as derecognized.
  • Derecognized On
    The date on which the invoice is marked as derecognized.
  • Due On
    The date on which the invoice should be paid on.
  • Environment
  • External ID
    The external id helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
  • ID
    A unique identifier for the object.
  • Language
    The language that is linked to the object.
  • Line Items
  • Linked Space ID
    The ID of the space this object belongs to.
  • Linked Transaction
  • Merchant Reference
  • Outstanding Amount
    The outstanding amount indicates how much the buyer owes the merchant. A negative amount indicates that the invoice is overpaid.
  • Paid On
    The date on which the invoice is marked as paid. Eventually this date lags behind of the actual paid date.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Space View ID
    The ID of the space view this object is linked to.
  • State
    The object's current state.
  • Tax Amount
  • Time Zone
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.