Documentation
Documentation
Dunning Flow
Close API Documentation
Dunning Flow
States
  • Create
    The create state indicates that the Dunning Flow is in creation.
  • Active
    The active state indicates that the Dunning Flow is active and may be used.
  • Inactive
    The inactive state indicates that the Dunning Flow is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Dunning Flow is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Conditions
    If a dunning flow meets all selected conditions, the dunning flow will be used to process the dunning case. If the conditions are not met the next dunning flow in line will be chosen according to the priorities.
  • ID
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Name
    The dunning flow name is used internally to identify the configuration in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
  • 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.
  • Priority
    The priority orders the dunning flows. As such the priority determines together with the conditions the dunning flow the selection mechanism for a particular invoice. A change of the priority affects all future selections.
  • State
    The object's current state.
  • Type
    The type of the flow controls the way fees and interest rates are calculated. You can choose from predefined fees for some jurisdictions.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.