Package de.hybris.platform.tuawebservicesresources.v2.dto

Class CustomerBill

java.lang.Object
de.hybris.platform.tuawebservicesresources.v2.dto.CustomerBill
public class CustomerBill extends Object
The billing account receives all charges (recurring, one time and usage) of the offers and products assigned to it during order process. Periodically according to billing cycle specifications attached to the billing account or as a result of an event, a customer bill (aka invoice) is produced. This customer bill concerns different related parties which play a role on it : for example, a customer bill is produced by an operator, is sent to a bill receiver and has to be paid by a payer. A payment method could be assigned to the customer bill to build the call of payment. Lettering process enables to assign automatically or manually incoming amount from payments to customer bills (payment items). A tax item is created for each tax rate used in the customer bill. The financial account represents a financial entity which records all customer’s accounting events : payment amount are recorded as credit and invoices amount are recorded as debit. It gives the customer overall balance (account balance). The customer bill is linked to one or more documents that can be downloaded via a provided url.

  • Constructor Details

    • CustomerBill

      public CustomerBill()

  • Method Details

    • id

      public CustomerBill id(String id)

    • getId

      public String getId()
      Unique identifier of he bill
      Returns:
      id

    • setId

      public void setId(String id)

    • href

      public CustomerBill href(String href)

    • getHref

      public String getHref()
      Bill unique reference
      Returns:
      href

    • setHref

      public void setHref(String href)

    • billDate

      public CustomerBill billDate(Date billDate)

    • getBillDate

      @Valid public @Valid Date getBillDate()
      Bill date
      Returns:
      billDate

    • setBillDate

      public void setBillDate(Date billDate)

    • billNo

      public CustomerBill billNo(String billNo)

    • getBillNo

      public String getBillNo()
      Bill reference known by the customer or the party and displayed on the bill. Could be different from the id
      Returns:
      billNo

    • setBillNo

      public void setBillNo(String billNo)

    • category

      public CustomerBill category(String category)

    • getCategory

      public String getCategory()
      Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note for example
      Returns:
      category

    • setCategory

      public void setCategory(String category)

    • lastUpdate

      public CustomerBill lastUpdate(Date lastUpdate)

    • getLastUpdate

      @Valid public @Valid Date getLastUpdate()
      Date of bill last update
      Returns:
      lastUpdate

    • setLastUpdate

      public void setLastUpdate(Date lastUpdate)

    • nextBillDate

      public CustomerBill nextBillDate(Date nextBillDate)

    • getNextBillDate

      @Valid public @Valid Date getNextBillDate()
      ). Approximate date of the next bill production given for information (only used for onCycle bill)
      Returns:
      nextBillDate

    • setNextBillDate

      public void setNextBillDate(Date nextBillDate)

    • paymentDueDate

      public CustomerBill paymentDueDate(Date paymentDueDate)

    • getPaymentDueDate

      @Valid public @Valid Date getPaymentDueDate()
      Date at which the amount due should have been paid
      Returns:
      paymentDueDate

    • setPaymentDueDate

      public void setPaymentDueDate(Date paymentDueDate)

    • runType

      public CustomerBill runType(String runType)

    • getRunType

      public String getRunType()
      onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)
      Returns:
      runType

    • setRunType

      public void setRunType(String runType)

    • amountDue

      public CustomerBill amountDue(Money amountDue)

    • getAmountDue

      @Valid public @Valid Money getAmountDue()
      Get amountDue
      Returns:
      amountDue

    • setAmountDue

      public void setAmountDue(Money amountDue)

    • appliedPayment

      public CustomerBill appliedPayment(List<AppliedPayment> appliedPayment)

    • addAppliedPaymentItem

      public CustomerBill addAppliedPaymentItem(AppliedPayment appliedPaymentItem)

    • getAppliedPayment

      @Valid public @Valid List<AppliedPayment> getAppliedPayment()
      Get appliedPayment
      Returns:
      appliedPayment

    • setAppliedPayment

      public void setAppliedPayment(List<AppliedPayment> appliedPayment)

    • billDocument

      public CustomerBill billDocument(List<AttachmentRefOrValue> billDocument)

    • addBillDocumentItem

      public CustomerBill addBillDocumentItem(AttachmentRefOrValue billDocumentItem)

    • getBillDocument

      @Valid public @Valid List<AttachmentRefOrValue> getBillDocument()
      Get billDocument
      Returns:
      billDocument

    • setBillDocument

      public void setBillDocument(List<AttachmentRefOrValue> billDocument)

    • billingAccount

      public CustomerBill billingAccount(BillingAccountRef billingAccount)

    • getBillingAccount

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

    • setBillingAccount

      public void setBillingAccount(BillingAccountRef billingAccount)

    • billingPeriod

      public CustomerBill billingPeriod(TimePeriod billingPeriod)

    • getBillingPeriod

      @Valid public @Valid TimePeriod getBillingPeriod()
      Get billingPeriod
      Returns:
      billingPeriod

    • setBillingPeriod

      public void setBillingPeriod(TimePeriod billingPeriod)

    • financialAccount

      public CustomerBill financialAccount(FinancialAccountRef financialAccount)

    • getFinancialAccount

      @Valid public @Valid FinancialAccountRef getFinancialAccount()
      Get financialAccount
      Returns:
      financialAccount

    • setFinancialAccount

      public void setFinancialAccount(FinancialAccountRef financialAccount)

    • paymentMethod

      public CustomerBill paymentMethod(PaymentMethodRef paymentMethod)

    • getPaymentMethod

      @Valid public @Valid PaymentMethodRef getPaymentMethod()
      Get paymentMethod
      Returns:
      paymentMethod

    • setPaymentMethod

      public void setPaymentMethod(PaymentMethodRef paymentMethod)

    • relatedParty

      public CustomerBill relatedParty(List<RelatedPartyRef> relatedParty)

    • addRelatedPartyItem

      public CustomerBill addRelatedPartyItem(RelatedPartyRef relatedPartyItem)

    • getRelatedParty

      @Valid public @Valid List<RelatedPartyRef> getRelatedParty()
      Get relatedParty
      Returns:
      relatedParty

    • setRelatedParty

      public void setRelatedParty(List<RelatedPartyRef> relatedParty)

    • remainingAmount

      public CustomerBill remainingAmount(Money remainingAmount)

    • getRemainingAmount

      @Valid public @Valid Money getRemainingAmount()
      Get remainingAmount
      Returns:
      remainingAmount

    • setRemainingAmount

      public void setRemainingAmount(Money remainingAmount)

    • state

      public CustomerBill state(StateValue state)

    • getState

      @Valid public @Valid StateValue getState()
      Get state
      Returns:
      state

    • setState

      public void setState(StateValue state)

    • taxExcludedAmount

      public CustomerBill taxExcludedAmount(Money taxExcludedAmount)

    • getTaxExcludedAmount

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

    • setTaxExcludedAmount

      public void setTaxExcludedAmount(Money taxExcludedAmount)

    • taxIncludedAmount

      public CustomerBill taxIncludedAmount(Money taxIncludedAmount)

    • getTaxIncludedAmount

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

    • setTaxIncludedAmount

      public void setTaxIncludedAmount(Money taxIncludedAmount)

    • taxItem

      public CustomerBill taxItem(List<TaxItem> taxItem)

    • addTaxItemItem

      public CustomerBill addTaxItemItem(TaxItem taxItemItem)

    • getTaxItem

      @Valid public @Valid List<TaxItem> getTaxItem()
      Get taxItem
      Returns:
      taxItem

    • setTaxItem

      public void setTaxItem(List<TaxItem> taxItem)

    • atBaseType

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