Class AppliedCustomerBillingRate
java.lang.Object
de.hybris.platform.tuawebservicesresources.v2.dto.AppliedCustomerBillingRate
@Validated
@Generated(value="de.hybris.platform.tuawebservicesresources.swagger.TmaCodegen",
date="2022-10-21T20:35:04.698Z")
public class AppliedCustomerBillingRate
extends Object
A customer bill displays applied billing rates created before or during the billing process.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAppliedTaxItem(AppliedBillingTaxRate appliedTaxItem) addCharacteristicItem(AppliedBillingRateCharacteristic characteristicItem) appliedTax(List<AppliedBillingTaxRate> appliedTax) atbaseType(String atbaseType) atschemaLocation(String atschemaLocation) billingAccount(BillingAccountRef billingAccount) characteristic(List<AppliedBillingRateCharacteristic> characteristic) description(String description) boolean@Valid List<AppliedBillingTaxRate>Get appliedTaxWhen sub-classing, this defines the super-classA URI to a JSON-Schema file that defines additional attributes and relationshipsWhen sub-classing, this defines the sub-class entity name@Valid BillRefgetBill()Get bill@Valid BillingAccountRefGet billingAccount@Valid List<AppliedBillingRateCharacteristic>Get characteristic@Valid DategetDate()Creation date of the applied billing rateAdditional data to be displayed on the bill for this customer applied billing rategetHref()Reference of the customer applied billing rate@NotNull StringgetId()Unique identifier of the customer applied billing rategetName()Name of the customer applied billing rate@Valid TimePeriodperiodCoverage for RecurringCharge (RC) indicating the RC coverage period dates for different purposes, such as RC proration, display on bill, GL reporting, etc.@Valid ProductRefUsually this information should be provided by the PRODUCT, which implies that there is a valid reference to product.@Valid MoneyGet taxExcludedAmount@Valid MoneyGet taxIncludedAmountgetType()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,...)inthashCode()If isBilled = true then bill should be provided, if false then billingAccount should be providedperiodCoverage(TimePeriod periodCoverage) product(ProductRef product) voidsetAppliedTax(List<AppliedBillingTaxRate> appliedTax) voidsetAtbaseType(String atbaseType) voidsetAtschemaLocation(String atschemaLocation) voidvoidvoidsetBillingAccount(BillingAccountRef billingAccount) voidsetCharacteristic(List<AppliedBillingRateCharacteristic> characteristic) voidvoidsetDescription(String description) voidvoidvoidsetIsBilled(Boolean isBilled) voidvoidsetPeriodCoverage(TimePeriod periodCoverage) voidsetProduct(ProductRef product) voidsetTaxExcludedAmount(Money taxExcludedAmount) voidsetTaxIncludedAmount(Money taxIncludedAmount) voidtaxExcludedAmount(Money taxExcludedAmount) taxIncludedAmount(Money taxIncludedAmount) toString()
-
Constructor Details
-
AppliedCustomerBillingRate
public AppliedCustomerBillingRate()
-
-
Method Details
-
id
-
getId
Unique identifier of the customer applied billing rate- Returns:
- id
-
setId
-
href
-
getHref
Reference of the customer applied billing rate- Returns:
- href
-
setHref
-
date
-
getDate
Creation date of the applied billing rate- Returns:
- date
-
setDate
-
description
-
getDescription
Additional data to be displayed on the bill for this customer applied billing rate- Returns:
- description
-
setDescription
-
isBilled
-
isIsBilled
If isBilled = true then bill should be provided, if false then billingAccount should be provided- Returns:
- isBilled
-
setIsBilled
-
name
-
getName
Name of the customer applied billing rate- Returns:
- name
-
setName
-
type
-
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
-
appliedTax
-
addAppliedTaxItem
-
getAppliedTax
Get appliedTax- Returns:
- appliedTax
-
setAppliedTax
-
bill
-
getBill
Get bill- Returns:
- bill
-
setBill
-
billingAccount
-
getBillingAccount
Get billingAccount- Returns:
- billingAccount
-
setBillingAccount
-
characteristic
public AppliedCustomerBillingRate characteristic(List<AppliedBillingRateCharacteristic> characteristic) -
addCharacteristicItem
public AppliedCustomerBillingRate addCharacteristicItem(AppliedBillingRateCharacteristic characteristicItem) -
getCharacteristic
Get characteristic- Returns:
- characteristic
-
setCharacteristic
-
periodCoverage
-
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
-
product
-
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
-
taxExcludedAmount
-
getTaxExcludedAmount
Get taxExcludedAmount- Returns:
- taxExcludedAmount
-
setTaxExcludedAmount
-
taxIncludedAmount
-
getTaxIncludedAmount
Get taxIncludedAmount- Returns:
- taxIncludedAmount
-
setTaxIncludedAmount
-
atbaseType
-
getAtbaseType
When sub-classing, this defines the super-class- Returns:
- atbaseType
-
setAtbaseType
-
atschemaLocation
-
getAtschemaLocation
A URI to a JSON-Schema file that defines additional attributes and relationships- Returns:
- atschemaLocation
-
setAtschemaLocation
-
attype
-
getAttype
When sub-classing, this defines the sub-class entity name- Returns:
- attype
-
setAttype
-
equals
-
hashCode
public int hashCode() -
toString
-