Interface PaymentScheduleEntry.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PaymentScheduleEntry.Builder,PaymentScheduleEntry>, SdkBuilder<PaymentScheduleEntry.Builder,PaymentScheduleEntry>, SdkPojo
Enclosing class:
PaymentScheduleEntry
@Mutable @NotThreadSafe public static interface PaymentScheduleEntry.Builder extends SdkPojo, CopyableBuilder<PaymentScheduleEntry.Builder,PaymentScheduleEntry>

  • Method Details

    • chargeDateOffset

      PaymentScheduleEntry.Builder chargeDateOffset(String chargeDateOffset)

      The time between the start date of the renewed agreement and the date this installment is charged. The duration is represented in the ISO 8601 format in either whole months or whole days (for example, P1M for 1 month or P30D for 30 days). All installments in a schedule use the same unit.

      Parameters:
      chargeDateOffset - The time between the start date of the renewed agreement and the date this installment is charged. The duration is represented in the ISO 8601 format in either whole months or whole days (for example, P1M for 1 month or P30D for 30 days). All installments in a schedule use the same unit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • chargePercentage

      PaymentScheduleEntry.Builder chargePercentage(String chargePercentage)

      The percentage of the total contract value of the renewed agreement that is charged in this installment. Valid values range from 0.01 to 100.00, with up to two decimal places.

      Parameters:
      chargePercentage - The percentage of the total contract value of the renewed agreement that is charged in this installment. Valid values range from 0.01 to 100.00, with up to two decimal places.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dayOfMonth

      PaymentScheduleEntry.Builder dayOfMonth(Integer dayOfMonth)

      The day of the month on which this installment is charged, from 1 to 31. Use this field to anchor the charge to a specific calendar day within the month identified by ChargeDateOffset. This field is supported only when ChargeDateOffset is expressed in months.

      Parameters:
      dayOfMonth - The day of the month on which this installment is charged, from 1 to 31. Use this field to anchor the charge to a specific calendar day within the month identified by ChargeDateOffset. This field is supported only when ChargeDateOffset is expressed in months.
      Returns:
      Returns a reference to this object so that method calls can be chained together.