Documentation
Documentation
Bank Transaction
Close API Documentation
Bank Transaction
States
  • Upcoming
    The bank transaction was registered and waiting for settlement.
  • Settled
    The bank transaction was settled.
Properties
  • Adjustments
    Adjustments are changes made to the initial transaction amount, such as fees or corrections.
  • Created By
    The ID of the user the bank transaction was created by.
  • Created On
    The date and time when the object was created.
  • Currency Bank Account
    The currency bank account that sends or receives money based on the bank transaction's flow direction.
  • External ID
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • Flow Direction
    Indicates the direction of a bank transaction, specifying whether the amount flows into or out of the bank account.
  • ID
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Payment Date
    The payment date specifies the date on which the payment was processed.
  • 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.
  • Posting Amount
    The posting amount refers to the monetary value recorded for the bank transaction prior to any adjustments.
  • Reference
    A unique reference to identify the bank transaction.
  • Source
    The source indicates how the bank transaction was created.
  • State
    The object's current state.
  • Total Adjustment Amount Including Tax
    Represents the total value of all adjustments to the bank transaction, including tax.
  • Type
    The bank transaction's type.
  • Value Amount
    The value amount represents the net monetary value of the transaction after applicable deductions.
  • Value Date
    The value date indicates the date on which the transaction amount becomes effective.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.