Package de.hybris.platform.billingaccounttmfwebservices.v1.dto

Class BillingCycleSpecification

java.lang.Object
de.hybris.platform.billingaccounttmfwebservices.v1.dto.BillingCycleSpecification
@Validated @Generated(value="de.hybris.platform.billingaccounttmfwebservices.swagger.BaBillingAccountCodegen", date="2022-10-21T20:35:18.164Z") public class BillingCycleSpecification extends Object
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.

  • Constructor Details

    • BillingCycleSpecification

      public BillingCycleSpecification()

  • Method Details

    • id

      public BillingCycleSpecification id(String id)

    • getId

      public String getId()
      Unique identifier of the billing cycle specification
      Returns:
      id

    • setId

      public void setId(String id)

    • href

      public BillingCycleSpecification href(String href)

    • getHref

      public String getHref()
      Reference of the billing cycle specification
      Returns:
      href

    • setHref

      public void setHref(String href)

    • billingDateShift

      public BillingCycleSpecification billingDateShift(Integer billingDateShift)

    • getBillingDateShift

      public Integer getBillingDateShift()
      An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
      Returns:
      billingDateShift

    • setBillingDateShift

      public void setBillingDateShift(Integer billingDateShift)

    • billingPeriod

      public BillingCycleSpecification billingPeriod(String billingPeriod)

    • getBillingPeriod

      public String getBillingPeriod()
      A billing time period. It can be recurring, for example: week, month, quarter of year, year .
      Returns:
      billingPeriod

    • setBillingPeriod

      public void setBillingPeriod(String billingPeriod)

    • chargeDateOffset

      public BillingCycleSpecification chargeDateOffset(Integer chargeDateOffset)

    • getChargeDateOffset

      public Integer getChargeDateOffset()
      An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      Returns:
      chargeDateOffset

    • setChargeDateOffset

      public void setChargeDateOffset(Integer chargeDateOffset)

    • creditDateOffset

      public BillingCycleSpecification creditDateOffset(Integer creditDateOffset)

    • getCreditDateOffset

      public Integer getCreditDateOffset()
      An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      Returns:
      creditDateOffset

    • setCreditDateOffset

      public void setCreditDateOffset(Integer creditDateOffset)

    • description

      public BillingCycleSpecification description(String description)

    • getDescription

      public String getDescription()
      An explanation regarding this billing cycle specification
      Returns:
      description

    • setDescription

      public void setDescription(String description)

    • frequency

      public BillingCycleSpecification frequency(String frequency)

    • getFrequency

      public String getFrequency()
      Frequency of the billing cycle (monthly for instance)
      Returns:
      frequency

    • setFrequency

      public void setFrequency(String frequency)

    • mailingDateOffset

      public BillingCycleSpecification mailingDateOffset(Integer mailingDateOffset)

    • getMailingDateOffset

      public Integer getMailingDateOffset()
      An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      Returns:
      mailingDateOffset

    • setMailingDateOffset

      public void setMailingDateOffset(Integer mailingDateOffset)

    • name

      public BillingCycleSpecification name(String name)

    • getName

      @NotNull public @NotNull String getName()
      A short descriptive name
      Returns:
      name

    • setName

      public void setName(String name)

    • paymentDueDateOffset

      public BillingCycleSpecification paymentDueDateOffset(Integer paymentDueDateOffset)

    • getPaymentDueDateOffset

      public Integer getPaymentDueDateOffset()
      An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      Returns:
      paymentDueDateOffset

    • setPaymentDueDateOffset

      public void setPaymentDueDateOffset(Integer paymentDueDateOffset)

    • validFor

      public BillingCycleSpecification validFor(TimePeriod validFor)

    • getValidFor

      @Valid public @Valid TimePeriod getValidFor()
      The period for which the billing specification cycle is valid
      Returns:
      validFor

    • setValidFor

      public void setValidFor(TimePeriod validFor)

    • atbaseType

      public BillingCycleSpecification 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 BillingCycleSpecification 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 BillingCycleSpecification 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