Documentation
Documentation
Invoice
Close API Documentation
Invoice
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
    The total sum of all line items on the invoice, including taxes.
  • Billing Address
    The address associated with the invoice, used for billing purposes.
  • Completion
    The transaction completion this object is linked to.
  • Created On
    The date and time when the object was created.
  • Derecognized By
    The ID of the user the invoice was derecognized by.
  • Derecognized On
    The date and time when the invoice was derecognized, meaning it is no longer considered outstanding or valid in the system.
  • Due On
    The due date for payment of the invoice.
  • Environment
    The environment used when rendering resources.
  • External ID
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • ID
    A unique identifier for the object.
  • Language
    The language that is linked to the object.
  • Line Items
    The invoiced line items that will appear on the invoice document.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Linked Transaction
    The payment transaction this object is linked to.
  • Merchant Reference
    The merchant's reference used to identify the invoice.
  • Outstanding Amount
    The remaining amount the buyer owes to the merchant. A negative value indicates the invoice has been overpaid.
  • Paid On
    The date and time when the invoice was recorded as paid. May differ from the actual payment date due to processing delays.
  • 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
    The portion of the invoiced amount that corresponds to taxes.
  • Time Zone
    The time zone that this object is associated with.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.