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
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity 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 planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to 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
  • 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 number indicates the version of the entity. The version is incremented whenever the entity is changed.