Documentation
Installment Plan Slice

The installment plan slice defines a single slice of an installment plan.

States
  • Create
    The create state indicates that the Installment Plan Slice is in creation.
  • Active
    The active state indicates that the Installment Plan Slice is active and may be used.
  • Inactive
    The inactive state indicates that the Installment Plan Slice is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Installment Plan Slice is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Installment Plan
    The installment plan this slice belongs to.
  • Line Item Title
    The title of this slices line items. The title is visible to the buyer.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Period
    The period defines how much time passes between the last slice and this slice. The charge is triggered at the end of the period. When the slice should be charged immediately the period needs to be zero.
  • 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 controls in which order the slices are applied. The lower the value the higher the precedence.
  • Proportion
    The proportion defines how much of the total installment payment has to be paid in this slice. The value is summed up with the other slices and the ratio of all proportions compared to proportion of this slice determines how much the buyer has to pay in this slice.
  • State
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.