Interface IZUGFeRDAllowanceCharge

  • All Known Implementing Classes:
    Allowance, Charge

    public interface IZUGFeRDAllowanceCharge
    The interface for allowances or charges, to be used by the pullprovider
    Author:
    AlexanderSchmidt
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default java.math.BigDecimal getBasisAmount()
      returns a basis the precentage is calculated from
      default java.lang.String getCategoryCode()
      the category ID why this has been applied
      default java.math.BigDecimal getPercent()
      returns a percentage, if relative abount, or null for absolute amounts
      java.lang.String getReason()
      get a description for the allowance/charge
      java.lang.String getReasonCode()
      get the code for the allowance/charge
      java.math.BigDecimal getTaxPercent()
      get the applicable tax percentage for the allowance/charge
      java.math.BigDecimal getTotalAmount​(IAbsoluteValueProvider trans)
      returns the absolute amount, even if it was relative in the first place
      boolean isCharge()
      is this in reality a charge and now allowance
    • Method Detail

      • getTotalAmount

        java.math.BigDecimal getTotalAmount​(IAbsoluteValueProvider trans)
        returns the absolute amount, even if it was relative in the first place
        Parameters:
        trans - the class delivering the initial value
        Returns:
        the calculated value (e.g. when percentage)
      • getPercent

        default java.math.BigDecimal getPercent()
        returns a percentage, if relative abount, or null for absolute amounts
        Returns:
        null or Percentage as Bigdecimal
      • getBasisAmount

        default java.math.BigDecimal getBasisAmount()
        returns a basis the precentage is calculated from
        Returns:
        null or the basis
      • getReason

        java.lang.String getReason()
        get a description for the allowance/charge
        Returns:
        the description
      • getReasonCode

        java.lang.String getReasonCode()
        get the code for the allowance/charge
        Returns:
        the code
      • getTaxPercent

        java.math.BigDecimal getTaxPercent()
        get the applicable tax percentage for the allowance/charge
        Returns:
        the percentage
      • getCategoryCode

        default java.lang.String getCategoryCode()
        the category ID why this has been applied
        Returns:
        default value Standard rate=S
      • isCharge

        boolean isCharge()
        is this in reality a charge and now allowance
        Returns:
        true if amnount to be treated negative