Web Service API Client
Web Service API
English (United States)
The installment plan allows to setup a template for an installment.
The create state indicates that the Installment Plan is in creation.
The active state indicates that the Installment Plan is active and may be used.
The inactive state indicates that the Installment Plan is inactive and may not be used.
The deleting state indicates that the Installment Plan is in the process to be deleted.
The deleted state marks the entity for purging from the database.
The base currency in which the installment fee and minimal amount are defined.
If a transaction meets all selected conditions the installment plan will be available to the customer to be selected.
The ID is the primary key of the entity. The ID identifies the entity uniquely.
The installment fee is a fixed amount that is charged additionally when applying this installment plan.
The interest rate is a percentage of the total amount that is charged additionally when applying this installment plan.
Linked Space ID
The linked space id holds the ID of the space to which the entity belongs to.
The installment plan can only be applied if the orders total is at least the defined minimal amount.
The installment plan name is used internally to identify the plan in administrative interfaces.For example it is used within search fields and hence it should be distinct and descriptive.
Payment Method Configurations
A installment plan can be enabled only for specific payment method configurations. Other payment methods will not be selectable by the buyer.
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.
The sort order controls in which order the installation plans are listed. The sort order is used to order the plans in ascending order.
The tax class determines the taxes which are applicable on all fees linked to the installment plan.
Terms and Conditions
The terms and conditions will be displayed to the customer when he or she selects this installment plan.
The title of the installment plan is used within the payment process. The title is visible to the buyer.
The version number indicates the version of the entity. The version is incremented whenever the entity is changed.