Class AppliedCustomerBillingRate

java.lang.Object
de.hybris.platform.billmanagementtmfwebservices.v1.dto.AppliedCustomerBillingRate

@Validated @Generated(value="de.hybris.platform.billmanagementtmfwebservices.swagger.BillManagementCodegen", date="2022-10-21T20:35:24.704Z") public class AppliedCustomerBillingRate extends Object
A customer bill displays applied billing rates created before or during the billing process.
  • Constructor Details

    • AppliedCustomerBillingRate

      public AppliedCustomerBillingRate()
  • Method Details

    • id

    • getId

      @NotNull public @NotNull String getId()
      Unique identifier of the customer applied billing rate
      Returns:
      id
    • setId

      public void setId(String id)
    • href

      public AppliedCustomerBillingRate href(String href)
    • getHref

      public String getHref()
      Reference of the customer applied billing rate
      Returns:
      href
    • setHref

      public void setHref(String href)
    • date

      public AppliedCustomerBillingRate date(Date date)
    • getDate

      @Valid public @Valid Date getDate()
      Creation date of the applied billing rate
      Returns:
      date
    • setDate

      public void setDate(Date date)
    • description

      public AppliedCustomerBillingRate description(String description)
    • getDescription

      public String getDescription()
      Additional data to be displayed on the bill for this customer applied billing rate
      Returns:
      description
    • setDescription

      public void setDescription(String description)
    • isBilled

      public AppliedCustomerBillingRate isBilled(Boolean isBilled)
    • isIsBilled

      public Boolean isIsBilled()
      If isBilled = true then bill should be provided, if false then billingAccount should be provided
      Returns:
      isBilled
    • setIsBilled

      public void setIsBilled(Boolean isBilled)
    • name

      public AppliedCustomerBillingRate name(String name)
    • getName

      public String getName()
      Name of the customer applied billing rate
      Returns:
      name
    • setName

      public void setName(String name)
    • type

      public AppliedCustomerBillingRate type(String type)
    • getType

      public String getType()
      Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)
      Returns:
      type
    • setType

      public void setType(String type)
    • appliedTax

      public AppliedCustomerBillingRate appliedTax(List<AppliedBillingTaxRate> appliedTax)
    • addAppliedTaxItem

      public AppliedCustomerBillingRate addAppliedTaxItem(AppliedBillingTaxRate appliedTaxItem)
    • getAppliedTax

      @Valid public @Valid List<AppliedBillingTaxRate> getAppliedTax()
      Get appliedTax
      Returns:
      appliedTax
    • setAppliedTax

      public void setAppliedTax(List<AppliedBillingTaxRate> appliedTax)
    • bill

      public AppliedCustomerBillingRate bill(BillRef bill)
    • getBill

      @Valid public @Valid BillRef getBill()
      Get bill
      Returns:
      bill
    • setBill

      public void setBill(BillRef bill)
    • billingAccount

      public AppliedCustomerBillingRate billingAccount(BillingAccountRef billingAccount)
    • getBillingAccount

      @Valid public @Valid BillingAccountRef getBillingAccount()
      Get billingAccount
      Returns:
      billingAccount
    • setBillingAccount

      public void setBillingAccount(BillingAccountRef billingAccount)
    • characteristic

      public AppliedCustomerBillingRate characteristic(List<AppliedBillingRateCharacteristic> characteristic)
    • addCharacteristicItem

      public AppliedCustomerBillingRate addCharacteristicItem(AppliedBillingRateCharacteristic characteristicItem)
    • getCharacteristic

      @Valid public @Valid List<AppliedBillingRateCharacteristic> getCharacteristic()
      Get characteristic
      Returns:
      characteristic
    • setCharacteristic

      public void setCharacteristic(List<AppliedBillingRateCharacteristic> characteristic)
    • periodCoverage

      public AppliedCustomerBillingRate periodCoverage(TimePeriod periodCoverage)
    • getPeriodCoverage

      @Valid public @Valid TimePeriod getPeriodCoverage()
      periodCoverage for RecurringCharge (RC) indicating the RC coverage period dates for different purposes, such as RC proration, display on bill, GL reporting, etc. periodCoverage for OC start and end date will be the same
      Returns:
      periodCoverage
    • setPeriodCoverage

      public void setPeriodCoverage(TimePeriod periodCoverage)
    • product

      public AppliedCustomerBillingRate product(ProductRef product)
    • getProduct

      @Valid public @Valid ProductRef getProduct()
      Usually this information should be provided by the PRODUCT, which implies that there is a valid reference to product. In this case, this property should be empty. For all other situations, a text or structured info could be provided using this property. Regular modelling would suggest tu use the reforvalue pattern for this case. It is not choosen here because it would generate declarational dependencies which would be hard to maintain.
      Returns:
      product
    • setProduct

      public void setProduct(ProductRef product)
    • taxExcludedAmount

      public AppliedCustomerBillingRate taxExcludedAmount(Money taxExcludedAmount)
    • getTaxExcludedAmount

      @Valid public @Valid Money getTaxExcludedAmount()
      Get taxExcludedAmount
      Returns:
      taxExcludedAmount
    • setTaxExcludedAmount

      public void setTaxExcludedAmount(Money taxExcludedAmount)
    • taxIncludedAmount

      public AppliedCustomerBillingRate taxIncludedAmount(Money taxIncludedAmount)
    • getTaxIncludedAmount

      @Valid public @Valid Money getTaxIncludedAmount()
      Get taxIncludedAmount
      Returns:
      taxIncludedAmount
    • setTaxIncludedAmount

      public void setTaxIncludedAmount(Money taxIncludedAmount)
    • atbaseType

      public AppliedCustomerBillingRate atbaseType(String atbaseType)
    • getAtbaseType

      public String getAtbaseType()
      When sub-classing, this defines the super-class
      Returns:
      atbaseType
    • setAtbaseType

      public void setAtbaseType(String atbaseType)
    • atschemaLocation

      public AppliedCustomerBillingRate atschemaLocation(String atschemaLocation)
    • getAtschemaLocation

      public String getAtschemaLocation()
      A URI to a JSON-Schema file that defines additional attributes and relationships
      Returns:
      atschemaLocation
    • setAtschemaLocation

      public void setAtschemaLocation(String atschemaLocation)
    • attype

      public AppliedCustomerBillingRate attype(String attype)
    • getAttype

      public String getAttype()
      When sub-classing, this defines the sub-class entity name
      Returns:
      attype
    • setAttype

      public void setAttype(String attype)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object