PurchaseOrder (TurnOnline.biz Ecosystem Administration 0.35 API)

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

public final class PurchaseOrder
extends Object

Constructor Summary

Constructors
Constructor and Description

PurchaseOrder()

Constructors
Constructor and Description
`PurchaseOrder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`formattedName()` Returns the formatted name of the purchase order, a message for end user.
`Date`	`getBeginOn()` The date of first invoice issue.
`Date`	`getCreatedDate()` A date when purchase order has been created.
`Creditor`	`getCreditor()` The account that represents a business at TurnOnline.biz Ecosystem to whom money will be credited.
`String`	`getCurrency()` The currency alphabetic code based on the ISO 4217.
`Customer`	`getCustomer()` Invoiced customer.
`Long`	`getId()` The unique purchase order identification.
`List<IncomingInvoice>`	`getInvoices()` List of already issued invoices based on this Order, where number of records is limited by value from the query parameter.
`String`	`getInvoiceType()` Get invoiceType
`List<PricingItem>`	`getItems()` The list of order items to be placed at invoice.
`Date`	`getLastBillingDate()` The last billing date.
`Date`	`getModificationDate()` The date of the last modification of purchase order values.
`Date`	`getNextBillingDate()` The next (future) billing date.
`Integer`	`getNumberOfDays()` The number of days to calculate due date.
`String`	`getPeriodicity()` The current periodicity of the purchase order.
`String`	`getStatus()` The current status of the purchase order.
`Double`	`getTotalPrice()` The purchase order total price as a sum of all checked in order items and its amount including target rounding mode.
`Double`	`getTotalPriceExclVat()` The purchase order total price as a sum of all checked in order items and its amount including target rounding mode.
`Double`	`getTotalVatAmount()` The purchase order total amount of VAT as a sum of all checked in order items including target rounding mode.
`Double`	`getTotalVatBase()` The purchase order total VAT base as a sum of all checked in order items and its amount.
`PurchaseOrder`	`setBeginOn(Date beginOn)`
`PurchaseOrder`	`setCreatedDate(Date createdDate)`
`PurchaseOrder`	`setCreditor(Creditor creditor)`
`PurchaseOrder`	`setCurrency(String currency)`
`PurchaseOrder`	`setCustomer(Customer customer)`
`PurchaseOrder`	`setId(Long id)`
`PurchaseOrder`	`setInvoices(List<IncomingInvoice> invoices)`
`PurchaseOrder`	`setInvoiceType(String invoiceType)`
`PurchaseOrder`	`setItems(List<PricingItem> items)`
`PurchaseOrder`	`setLastBillingDate(Date lastBillingDate)`
`PurchaseOrder`	`setModificationDate(Date modificationDate)`
`PurchaseOrder`	`setNextBillingDate(Date nextBillingDate)`
`PurchaseOrder`	`setNumberOfDays(Integer numberOfDays)`
`PurchaseOrder`	`setPeriodicity(String periodicity)`
`PurchaseOrder`	`setStatus(String status)`
`PurchaseOrder`	`setTotalPrice(Double totalPrice)`
`PurchaseOrder`	`setTotalPriceExclVat(Double totalPriceExclVat)`
`PurchaseOrder`	`setTotalVatAmount(Double totalVatAmount)`
`PurchaseOrder`	`setTotalVatBase(Double totalVatBase)`

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

- Constructor Detail
  - PurchaseOrder
```
public PurchaseOrder()
```
- Method Detail
  - getBeginOn
```
public Date getBeginOn()
```
    The date of first invoice issue. Might be selected by the user.
  - setBeginOn
```
public PurchaseOrder setBeginOn(Date beginOn)
```
  - getCreatedDate
```
public Date getCreatedDate()
```
    A date when purchase order has been created. Populated by the service.
  - setCreatedDate
```
public PurchaseOrder setCreatedDate(Date createdDate)
```
  - getCreditor
```
public Creditor getCreditor()
```
    The account that represents a business at TurnOnline.biz Ecosystem to whom money will be credited.
  - setCreditor
```
public PurchaseOrder setCreditor(Creditor creditor)
```
  - 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 PurchaseOrder setCurrency(String currency)
```
  - getCustomer
```
public Customer getCustomer()
```
    Invoiced customer.
  - setCustomer
```
public PurchaseOrder setCustomer(Customer customer)
```
  - getId
```
public Long getId()
```
    The unique purchase order identification.
  - setId
```
public PurchaseOrder setId(Long id)
```
  - getInvoices
```
public List<IncomingInvoice> getInvoices()
```
    List of already issued invoices based on this Order, where number of records is limited by value from the query parameter. By default no invoices will be included in the response until the query parameter 'invoices' will be present with a positive integer value. This number represents a limit of max number of expected incoming invoices to be included in the result. If no incoming invoice yet has been issued, the property 'invoices' will be missing in the result whatever was the value of query parameter. Ordered by incoming invoice modification date (descending).
  - setInvoices
```
public PurchaseOrder setInvoices(List<IncomingInvoice> invoices)
```
  - getInvoiceType
```
public String getInvoiceType()
```
    Get invoiceType
  - setInvoiceType
```
public PurchaseOrder 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 PurchaseOrder 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 PurchaseOrder setLastBillingDate(Date lastBillingDate)
```
  - getModificationDate
```
public Date getModificationDate()
```
    The date of the last modification of purchase order values. Managed solely by the service. RFC 3339
  - setModificationDate
```
public PurchaseOrder setModificationDate(Date modificationDate)
```
  - 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 PurchaseOrder setNextBillingDate(Date nextBillingDate)
```
  - getNumberOfDays
```
public Integer getNumberOfDays()
```
    The number of days to calculate due date. An user defined value.
  - setNumberOfDays
```
public PurchaseOrder setNumberOfDays(Integer numberOfDays)
```
  - getPeriodicity
```
public String getPeriodicity()
```
    The current periodicity of the purchase order.
  - setPeriodicity
```
public PurchaseOrder setPeriodicity(String periodicity)
```
  - getStatus
```
public String getStatus()
```
    The current status of the purchase order. Client is allowed to set only one of the following value: TRIALING, ACTIVE, SUSPENDED.
  - setStatus
```
public PurchaseOrder setStatus(String status)
```
  - getTotalPrice
```
public Double getTotalPrice()
```
    The purchase order total price as a sum of all checked in order items and its amount including target rounding mode. Including VAT.
  - setTotalPrice
```
public PurchaseOrder setTotalPrice(Double totalPrice)
```
  - getTotalPriceExclVat
```
public Double getTotalPriceExclVat()
```
    The purchase order 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 PurchaseOrder setTotalPriceExclVat(Double totalPriceExclVat)
```
  - getTotalVatAmount
```
public Double getTotalVatAmount()
```
    The purchase order total amount of VAT as a sum of all checked in order items including target rounding mode.
  - setTotalVatAmount
```
public PurchaseOrder setTotalVatAmount(Double totalVatAmount)
```
  - getTotalVatBase
```
public Double getTotalVatBase()
```
    The purchase order total VAT base as a sum of all checked in order items and its amount.
  - setTotalVatBase
```
public PurchaseOrder setTotalVatBase(Double totalVatBase)
```
  - formattedName
```
public String formattedName()
```
    Returns the formatted name of the purchase order, a message for end user. The composition of the creditor business name and the purchase order ID.
    
    Returns:
    
    the purchase order formatted name

Class PurchaseOrder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PurchaseOrder

Method Detail

getBeginOn

setBeginOn

getCreatedDate

setCreatedDate

getCreditor

setCreditor

getCurrency

setCurrency

getCustomer

setCustomer

getId

setId

getInvoices

setInvoices

getInvoiceType

setInvoiceType

getItems

setItems

getLastBillingDate

setLastBillingDate

getModificationDate

setModificationDate

getNextBillingDate

setNextBillingDate

getNumberOfDays

setNumberOfDays

getPeriodicity

setPeriodicity

getStatus

setStatus

getTotalPrice

setTotalPrice

getTotalPriceExclVat

setTotalPriceExclVat

getTotalVatAmount

setTotalVatAmount

getTotalVatBase

setTotalVatBase

formattedName