CompleteOffer (TurnOnline.biz Ecosystem Administration 0.35 API)

java.lang.Object
- biz.turnonline.ecosystem.widget.shared.rest.billing.CompleteOffer

```
public class CompleteOffer
extends Object
```
The complete definition of the offer that is based on order.

Constructor Summary

Constructors
Constructor and Description

CompleteOffer()

Constructors
Constructor and Description
`CompleteOffer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Date`	`getBeginOn()` Proposal of the start date if applicable.
`Date`	`getCreatedDate()` A date when offer has been created.
`String`	`getCurrency()` The currency alphabetic code based on the ISO 4217.
`Customer`	`getCustomer()` A customer to be invoiced.
`String`	`getDescription()`
`Date`	`getExpiration()`
`Integer`	`getExpirationDays()`
`Long`	`getId()` The unique offer identification.
`String`	`getInvoiceType()` Get invoiceType
`List<PricingItem>`	`getItems()` The list of order items to be placed at invoice.
`Date`	`getLastBillingDate()` The last billing date.
`String`	`getLogo()` The supplier's company logo, a full URL of the image served from CDN.
`Date`	`getModificationDate()` The date of the last modification of offer values.
`Boolean`	`getMultipleRecipients()`
`Date`	`getNextBillingDate()` The next (future) billing date.
`Integer`	`getNumberOfDays()` The number of days to calculate due date.
`String`	`getPeriodicity()` The current periodicity of the offer.
`String`	`getPicture()` The serving URL of the picture associated with the offer.
`String`	`getSnippet()` The short description of the offer.
`Sponsor`	`getSponsor()`
`String`	`getStatus()` The current status of the offer.
`Creditor`	`getSupplier()` The supplier account that represents a business at TurnOnline.biz Ecosystem.
`String`	`getTitle()` The offer title.
`Double`	`getTotalPrice()` The offer total price as a sum of all checked in order items and its amount including target rounding mode.
`Double`	`getTotalPriceExclVat()` The offer total price as a sum of all checked in order items and its amount including target rounding mode.
`Double`	`getTotalVatAmount()` The offer total amount of VAT as a sum of all checked in order items including target rounding mode.
`Double`	`getTotalVatBase()` The offer total VAT base as a sum of all checked in order items and its amount.
`CompleteOffer`	`setBeginOn(Date beginOn)`
`CompleteOffer`	`setCreatedDate(Date createdDate)`
`CompleteOffer`	`setCurrency(String currency)`
`CompleteOffer`	`setCustomer(Customer customer)`
`CompleteOffer`	`setDescription(String description)`
`CompleteOffer`	`setExpiration(Date expiration)`
`CompleteOffer`	`setExpirationDays(Integer expirationDays)`
`CompleteOffer`	`setId(Long id)`
`CompleteOffer`	`setInvoiceType(String invoiceType)`
`CompleteOffer`	`setItems(List<PricingItem> items)`
`CompleteOffer`	`setLastBillingDate(Date lastBillingDate)`
`CompleteOffer`	`setLogo(String logo)`
`CompleteOffer`	`setModificationDate(Date modificationDate)`
`CompleteOffer`	`setMultipleRecipients(Boolean multipleRecipients)`
`CompleteOffer`	`setNextBillingDate(Date nextBillingDate)`
`CompleteOffer`	`setNumberOfDays(Integer numberOfDays)`
`CompleteOffer`	`setPeriodicity(String periodicity)`
`CompleteOffer`	`setPicture(String picture)`
`CompleteOffer`	`setSnippet(String snippet)`
`CompleteOffer`	`setSponsor(Sponsor sponsor)`
`CompleteOffer`	`setStatus(String status)`
`CompleteOffer`	`setSupplier(Creditor supplier)`
`CompleteOffer`	`setTitle(String title)`
`CompleteOffer`	`setTotalPrice(Double totalPrice)`
`CompleteOffer`	`setTotalPriceExclVat(Double totalPriceExclVat)`
`CompleteOffer`	`setTotalVatAmount(Double totalVatAmount)`
`CompleteOffer`	`setTotalVatBase(Double totalVatBase)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CompleteOffer
```
public CompleteOffer()
```
- Method Detail
  - getBeginOn
```
public Date getBeginOn()
```
    Proposal of the start date if applicable.
  - setBeginOn
```
public CompleteOffer setBeginOn(Date beginOn)
```
  - getCreatedDate
```
public Date getCreatedDate()
```
    A date when offer has been created. Populated by the service.
  - setCreatedDate
```
public CompleteOffer setCreatedDate(Date createdDate)
```
  - getCurrency
```
public String getCurrency()
```
    The currency alphabetic code based on the ISO 4217. The value is being based on the order item that is first within the list. If list is empty, none currency will be set.
  - setCurrency
```
public CompleteOffer setCurrency(String currency)
```
  - getCustomer
```
public Customer getCustomer()
```
    A customer to be invoiced.
  - setCustomer
```
public CompleteOffer setCustomer(Customer customer)
```
  - getDescription
```
public String getDescription()
```
  - setDescription
```
public CompleteOffer setDescription(String description)
```
  - getExpiration
```
public Date getExpiration()
```
  - setExpiration
```
public CompleteOffer setExpiration(Date expiration)
```
  - getExpirationDays
```
public Integer getExpirationDays()
```
  - setExpirationDays
```
public CompleteOffer setExpirationDays(Integer expirationDays)
```
  - getId
```
public Long getId()
```
    The unique offer identification.
  - setId
```
public CompleteOffer setId(Long id)
```
  - getInvoiceType
```
public String getInvoiceType()
```
    Get invoiceType
  - setInvoiceType
```
public CompleteOffer setInvoiceType(String invoiceType)
```
  - getItems
```
public List<PricingItem> getItems()
```
    The list of order items to be placed at invoice. Taken either as a product from the product catalog or a custom definition. The root pricing item of the pricing tree structure must be either type of OrderItem or Standard (PricingItem ‘itemType’ property value). Otherwise validation error will be returned as a bad request.
  - setItems
```
public CompleteOffer setItems(List<PricingItem> items)
```
  - getLastBillingDate
```
public Date getLastBillingDate()
```
    The last billing date. An invoicing that has been already executed. Set by the service.
  - setLastBillingDate
```
public CompleteOffer setLastBillingDate(Date lastBillingDate)
```
  - getLogo
```
public String getLogo()
```
    The supplier's company logo, a full URL of the image served from CDN.
  - setLogo
```
public CompleteOffer setLogo(String logo)
```
  - getModificationDate
```
public Date getModificationDate()
```
    The date of the last modification of offer values. Managed solely by the service. RFC 3339
  - setModificationDate
```
public CompleteOffer setModificationDate(Date modificationDate)
```
  - getMultipleRecipients
```
public Boolean getMultipleRecipients()
```
  - setMultipleRecipients
```
public CompleteOffer setMultipleRecipients(Boolean multipleRecipients)
```
  - getNextBillingDate
```
public Date getNextBillingDate()
```
    The next (future) billing date. A concrete value is being based on the periodicity and evaluated by the service.
  - setNextBillingDate
```
public CompleteOffer setNextBillingDate(Date nextBillingDate)
```
  - getNumberOfDays
```
public Integer getNumberOfDays()
```
    The number of days to calculate due date. An user defined value.
  - setNumberOfDays
```
public CompleteOffer setNumberOfDays(Integer numberOfDays)
```
  - getPeriodicity
```
public String getPeriodicity()
```
    The current periodicity of the offer.
  - setPeriodicity
```
public CompleteOffer setPeriodicity(String periodicity)
```
  - getPicture
```
public String getPicture()
```
    The serving URL of the picture associated with the offer. Served from the content delivery network (CDN).
  - setPicture
```
public CompleteOffer setPicture(String picture)
```
  - getSnippet
```
public String getSnippet()
```
    The short description of the offer. It might be a short description one of the product from the order. Alternatively it might be also a direct message to the target customer. The max length is set to 500 characters.
  - setSnippet
```
public CompleteOffer setSnippet(String snippet)
```
  - getSponsor
```
public Sponsor getSponsor()
```
  - setSponsor
```
public CompleteOffer setSponsor(Sponsor sponsor)
```
  - getStatus
```
public String getStatus()
```
    The current status of the offer. Client is allowed to set only one of the following value: TRIALING, ACTIVE, SUSPENDED.
  - setStatus
```
public CompleteOffer setStatus(String status)
```
  - getSupplier
```
public Creditor getSupplier()
```
    The supplier account that represents a business at TurnOnline.biz Ecosystem.
  - setSupplier
```
public CompleteOffer setSupplier(Creditor supplier)
```
  - getTitle
```
public String getTitle()
```
    The offer title. A text that should take an user attention. The max length is set to 100 characters.
  - setTitle
```
public CompleteOffer setTitle(String title)
```
  - getTotalPrice
```
public Double getTotalPrice()
```
    The offer total price as a sum of all checked in order items and its amount including target rounding mode. Including VAT.
  - setTotalPrice
```
public CompleteOffer setTotalPrice(Double totalPrice)
```
  - getTotalPriceExclVat
```
public Double getTotalPriceExclVat()
```
    The offer total price as a sum of all checked in order items and its amount including target rounding mode. The price is excluding VAT in case company is VAT payer, otherwise price is final and same as value of totalPrice property.
  - setTotalPriceExclVat
```
public CompleteOffer setTotalPriceExclVat(Double totalPriceExclVat)
```
  - getTotalVatAmount
```
public Double getTotalVatAmount()
```
    The offer total amount of VAT as a sum of all checked in order items including target rounding mode.
  - setTotalVatAmount
```
public CompleteOffer setTotalVatAmount(Double totalVatAmount)
```
  - getTotalVatBase
```
public Double getTotalVatBase()
```
    The offer total VAT base as a sum of all checked in order items and its amount.
  - setTotalVatBase
```
public CompleteOffer setTotalVatBase(Double totalVatBase)
```

Class CompleteOffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompleteOffer

Method Detail

getBeginOn

setBeginOn

getCreatedDate

setCreatedDate

getCurrency

setCurrency

getCustomer

setCustomer

getDescription

setDescription

getExpiration

setExpiration

getExpirationDays

setExpirationDays

getId

setId

getInvoiceType

setInvoiceType

getItems

setItems

getLastBillingDate

setLastBillingDate

getLogo

setLogo

getModificationDate

setModificationDate

getMultipleRecipients

setMultipleRecipients

getNextBillingDate

setNextBillingDate

getNumberOfDays

setNumberOfDays

getPeriodicity

setPeriodicity

getPicture

setPicture

getSnippet

setSnippet

getSponsor

setSponsor

getStatus

setStatus

getSupplier

setSupplier

getTitle

setTitle

getTotalPrice

setTotalPrice

getTotalPriceExclVat

setTotalPriceExclVat

getTotalVatAmount

setTotalVatAmount

getTotalVatBase

setTotalVatBase