Package com.softlayer.api.service.billing

Class Order

java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.billing.Order
@ApiType("SoftLayer_Billing_Order")
public class Order
extends Entity
The SoftLayer_Billing_Order data type contains general information relating to an individual order applied to a SoftLayer customer account or to a new customer. Personal information in this type such as names, addresses, and phone numbers are taken from the account's contact information at the time the order is generated for existing SoftLayer customer.
See Also:
SoftLayer_Billing_Order

  • Field Details

    • account

      @ApiProperty protected Account account
      The [[SoftLayer_Account|account]] to which an order belongs.

    • brand

      @ApiProperty protected Brand brand

    • cart

      @ApiProperty protected Cart cart
      A cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices. Not all orders will have a cart associated with them. See [[SoftLayer_Billing_Order_Cart]] for more information.

    • coreRestrictedItems

      @ApiProperty protected List<Item> coreRestrictedItems
      The [[SoftLayer_Billing_Order_Item (type)|order items]] that are core restricted

    • creditCardTransactions

      @ApiProperty protected List<Transaction> creditCardTransactions
      All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.

    • exchangeRate

      @ApiProperty protected ExchangeRate exchangeRate

    • initialInvoice

      @ApiProperty protected Invoice initialInvoice

    • items

      @ApiProperty protected List<Item> items
      The SoftLayer_Billing_Order_items included in an order.

    • orderApprovalDate

      @ApiProperty protected GregorianCalendar orderApprovalDate

    • orderNonServerMonthlyAmount

      @ApiProperty protected BigDecimal orderNonServerMonthlyAmount
      An order's non-server items total monthly fee.

    • orderServerMonthlyAmount

      @ApiProperty protected BigDecimal orderServerMonthlyAmount
      An order's server items total monthly fee.

    • orderTopLevelItems

      @ApiProperty protected List<Item> orderTopLevelItems
      An order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI.

    • orderTotalAmount

      @ApiProperty protected BigDecimal orderTotalAmount
      This amount represents the order's initial charge including set up fee and taxes.

    • orderTotalOneTime

      @ApiProperty protected BigDecimal orderTotalOneTime
      An order's total one time amount summing all the set up fees, the labor fees and the one time fees. Taxes will be applied for non-tax-exempt. This amount represents the initial fees that will be charged.

    • orderTotalOneTimeAmount

      @ApiProperty protected BigDecimal orderTotalOneTimeAmount
      An order's total one time amount. This amount represents the initial fees before tax.

    • orderTotalOneTimeTaxAmount

      @ApiProperty protected BigDecimal orderTotalOneTimeTaxAmount
      An order's total one time tax amount. This amount represents the tax that will be applied to the total charge, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.

    • orderTotalRecurring

      @ApiProperty protected BigDecimal orderTotalRecurring
      An order's total recurring amount. Taxes will be applied for non-tax-exempt. This amount represents the fees that will be charged on a recurring (usually monthly) basis.

    • orderTotalRecurringAmount

      @ApiProperty protected BigDecimal orderTotalRecurringAmount
      An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis.

    • orderTotalRecurringTaxAmount

      @ApiProperty protected BigDecimal orderTotalRecurringTaxAmount
      The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.

    • orderTotalSetupAmount

      @ApiProperty protected BigDecimal orderTotalSetupAmount
      An order's total setup fee.

    • orderType

      @ApiProperty protected Type orderType
      The type of an order. This lets you know where this order was generated from.

    • paypalTransactions

      @ApiProperty protected List<Transaction> paypalTransactions
      All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.

    • presaleEvent

      @ApiProperty protected Event presaleEvent

    • quote

      @ApiProperty protected Quote quote
      The quote of an order. This quote holds information about its expiration date, creation date, name and status. This information is tied to an order having the status 'QUOTE'

    • referralPartner

      @ApiProperty protected Account referralPartner
      The Referral Partner who referred this order. (Only necessary for new customer orders)

    • upgradeRequestFlag

      @ApiProperty protected Boolean upgradeRequestFlag
      This flag indicates an order is an upgrade.

    • userRecord

      @ApiProperty protected Customer userRecord
      The SoftLayer_User_Customer object tied to an order.

    • accountId

      @ApiProperty(canBeNullOrNotSet=true) protected Long accountId
      The account ID to which an order belongs.

    • accountIdSpecified

      protected boolean accountIdSpecified

    • createDate

      @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar createDate
      The point in time at which a billing item was created.

    • createDateSpecified

      protected boolean createDateSpecified

    • id

      @ApiProperty(canBeNullOrNotSet=true) protected Long id
      *

    • idSpecified

      protected boolean idSpecified

    • impersonatingUserRecordId

      @ApiProperty(canBeNullOrNotSet=true) protected Long impersonatingUserRecordId
      The SoftLayer_User_Customer id of the portal or API user who impersonated the user which submitted an order.

    • impersonatingUserRecordIdSpecified

      protected boolean impersonatingUserRecordIdSpecified

    • modifyDate

      @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar modifyDate
      The last time an order was updated.

    • modifyDateSpecified

      protected boolean modifyDateSpecified

    • orderQuoteId

      @ApiProperty(canBeNullOrNotSet=true) protected Long orderQuoteId
      The SoftLayer_Billing_Order_Quote id of the quote's user who finalized an order.

    • orderQuoteIdSpecified

      protected boolean orderQuoteIdSpecified

    • orderTypeId

      @ApiProperty(canBeNullOrNotSet=true) protected Long orderTypeId
      The SoftLayer_Billing_Order_Type id of the order.

    • orderTypeIdSpecified

      protected boolean orderTypeIdSpecified

    • presaleEventId

      @ApiProperty(canBeNullOrNotSet=true) protected Long presaleEventId

    • presaleEventIdSpecified

      protected boolean presaleEventIdSpecified

    • privateCloudOrderFlag

      @ApiProperty(canBeNullOrNotSet=true) protected Boolean privateCloudOrderFlag
      Flag indicating a private cloud solution order (Deprecated)

    • privateCloudOrderFlagSpecified

      protected boolean privateCloudOrderFlagSpecified

    • status

      @ApiProperty(canBeNullOrNotSet=true) protected String status
      Purchaser current status e.i. Approved, Pending_Approval

    • statusSpecified

      protected boolean statusSpecified

    • userRecordId

      @ApiProperty(canBeNullOrNotSet=true) protected Long userRecordId
      The SoftLayer_User_Customer id of the portal or API user who submitted an order.

    • userRecordIdSpecified

      protected boolean userRecordIdSpecified

    • coreRestrictedItemCount

      @ApiProperty protected Long coreRestrictedItemCount
      A count of the [[SoftLayer_Billing_Order_Item (type)|order items]] that are core restricted

    • creditCardTransactionCount

      @ApiProperty protected Long creditCardTransactionCount
      A count of all credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.

    • itemCount

      @ApiProperty protected Long itemCount
      A count of the SoftLayer_Billing_Order_items included in an order.

    • orderTopLevelItemCount

      @ApiProperty protected Long orderTopLevelItemCount
      A count of an order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI.

    • paypalTransactionCount

      @ApiProperty protected Long paypalTransactionCount
      A count of all PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.

  • Constructor Details

    • Order

      public Order()

  • Method Details

    • getAccount

      public Account getAccount()

    • setAccount

      public void setAccount​(Account account)

    • getBrand

      public Brand getBrand()

    • setBrand

      public void setBrand​(Brand brand)

    • getCart

      public Cart getCart()

    • setCart

      public void setCart​(Cart cart)

    • getCoreRestrictedItems

      public List<Item> getCoreRestrictedItems()

    • getCreditCardTransactions

      public List<Transaction> getCreditCardTransactions()

    • getExchangeRate

      public ExchangeRate getExchangeRate()

    • setExchangeRate

      public void setExchangeRate​(ExchangeRate exchangeRate)

    • getInitialInvoice

      public Invoice getInitialInvoice()

    • setInitialInvoice

      public void setInitialInvoice​(Invoice initialInvoice)

    • getItems

      public List<Item> getItems()

    • getOrderApprovalDate

      public GregorianCalendar getOrderApprovalDate()

    • setOrderApprovalDate

      public void setOrderApprovalDate​(GregorianCalendar orderApprovalDate)

    • getOrderNonServerMonthlyAmount

      public BigDecimal getOrderNonServerMonthlyAmount()

    • setOrderNonServerMonthlyAmount

      public void setOrderNonServerMonthlyAmount​(BigDecimal orderNonServerMonthlyAmount)

    • getOrderServerMonthlyAmount

      public BigDecimal getOrderServerMonthlyAmount()

    • setOrderServerMonthlyAmount

      public void setOrderServerMonthlyAmount​(BigDecimal orderServerMonthlyAmount)

    • getOrderTopLevelItems

      public List<Item> getOrderTopLevelItems()

    • getOrderTotalAmount

      public BigDecimal getOrderTotalAmount()

    • setOrderTotalAmount

      public void setOrderTotalAmount​(BigDecimal orderTotalAmount)

    • getOrderTotalOneTime

      public BigDecimal getOrderTotalOneTime()

    • setOrderTotalOneTime

      public void setOrderTotalOneTime​(BigDecimal orderTotalOneTime)

    • getOrderTotalOneTimeAmount

      public BigDecimal getOrderTotalOneTimeAmount()

    • setOrderTotalOneTimeAmount

      public void setOrderTotalOneTimeAmount​(BigDecimal orderTotalOneTimeAmount)

    • getOrderTotalOneTimeTaxAmount

      public BigDecimal getOrderTotalOneTimeTaxAmount()

    • setOrderTotalOneTimeTaxAmount

      public void setOrderTotalOneTimeTaxAmount​(BigDecimal orderTotalOneTimeTaxAmount)

    • getOrderTotalRecurring

      public BigDecimal getOrderTotalRecurring()

    • setOrderTotalRecurring

      public void setOrderTotalRecurring​(BigDecimal orderTotalRecurring)

    • getOrderTotalRecurringAmount

      public BigDecimal getOrderTotalRecurringAmount()

    • setOrderTotalRecurringAmount

      public void setOrderTotalRecurringAmount​(BigDecimal orderTotalRecurringAmount)

    • getOrderTotalRecurringTaxAmount

      public BigDecimal getOrderTotalRecurringTaxAmount()

    • setOrderTotalRecurringTaxAmount

      public void setOrderTotalRecurringTaxAmount​(BigDecimal orderTotalRecurringTaxAmount)

    • getOrderTotalSetupAmount

      public BigDecimal getOrderTotalSetupAmount()

    • setOrderTotalSetupAmount

      public void setOrderTotalSetupAmount​(BigDecimal orderTotalSetupAmount)

    • getOrderType

      public Type getOrderType()

    • setOrderType

      public void setOrderType​(Type orderType)

    • getPaypalTransactions

      public List<Transaction> getPaypalTransactions()

    • getPresaleEvent

      public Event getPresaleEvent()

    • setPresaleEvent

      public void setPresaleEvent​(Event presaleEvent)

    • getQuote

      public Quote getQuote()

    • setQuote

      public void setQuote​(Quote quote)

    • getReferralPartner

      public Account getReferralPartner()

    • setReferralPartner

      public void setReferralPartner​(Account referralPartner)

    • getUpgradeRequestFlag

      public Boolean getUpgradeRequestFlag()

    • setUpgradeRequestFlag

      public void setUpgradeRequestFlag​(Boolean upgradeRequestFlag)

    • getUserRecord

      public Customer getUserRecord()

    • setUserRecord

      public void setUserRecord​(Customer userRecord)

    • getAccountId

      public Long getAccountId()

    • setAccountId

      public void setAccountId​(Long accountId)

    • isAccountIdSpecified

      public boolean isAccountIdSpecified()

    • unsetAccountId

      public void unsetAccountId()

    • getCreateDate

      public GregorianCalendar getCreateDate()

    • setCreateDate

      public void setCreateDate​(GregorianCalendar createDate)

    • isCreateDateSpecified

      public boolean isCreateDateSpecified()

    • unsetCreateDate

      public void unsetCreateDate()

    • getId

      public Long getId()

    • setId

      public void setId​(Long id)

    • isIdSpecified

      public boolean isIdSpecified()

    • unsetId

      public void unsetId()

    • getImpersonatingUserRecordId

      public Long getImpersonatingUserRecordId()

    • setImpersonatingUserRecordId

      public void setImpersonatingUserRecordId​(Long impersonatingUserRecordId)

    • isImpersonatingUserRecordIdSpecified

      public boolean isImpersonatingUserRecordIdSpecified()

    • unsetImpersonatingUserRecordId

      public void unsetImpersonatingUserRecordId()

    • getModifyDate

      public GregorianCalendar getModifyDate()

    • setModifyDate

      public void setModifyDate​(GregorianCalendar modifyDate)

    • isModifyDateSpecified

      public boolean isModifyDateSpecified()

    • unsetModifyDate

      public void unsetModifyDate()

    • getOrderQuoteId

      public Long getOrderQuoteId()

    • setOrderQuoteId

      public void setOrderQuoteId​(Long orderQuoteId)

    • isOrderQuoteIdSpecified

      public boolean isOrderQuoteIdSpecified()

    • unsetOrderQuoteId

      public void unsetOrderQuoteId()

    • getOrderTypeId

      public Long getOrderTypeId()

    • setOrderTypeId

      public void setOrderTypeId​(Long orderTypeId)

    • isOrderTypeIdSpecified

      public boolean isOrderTypeIdSpecified()

    • unsetOrderTypeId

      public void unsetOrderTypeId()

    • getPresaleEventId

      public Long getPresaleEventId()

    • setPresaleEventId

      public void setPresaleEventId​(Long presaleEventId)

    • isPresaleEventIdSpecified

      public boolean isPresaleEventIdSpecified()

    • unsetPresaleEventId

      public void unsetPresaleEventId()

    • getPrivateCloudOrderFlag

      public Boolean getPrivateCloudOrderFlag()

    • setPrivateCloudOrderFlag

      public void setPrivateCloudOrderFlag​(Boolean privateCloudOrderFlag)

    • isPrivateCloudOrderFlagSpecified

      public boolean isPrivateCloudOrderFlagSpecified()

    • unsetPrivateCloudOrderFlag

      public void unsetPrivateCloudOrderFlag()

    • getStatus

      public String getStatus()

    • setStatus

      public void setStatus​(String status)

    • isStatusSpecified

      public boolean isStatusSpecified()

    • unsetStatus

      public void unsetStatus()

    • getUserRecordId

      public Long getUserRecordId()

    • setUserRecordId

      public void setUserRecordId​(Long userRecordId)

    • isUserRecordIdSpecified

      public boolean isUserRecordIdSpecified()

    • unsetUserRecordId

      public void unsetUserRecordId()

    • getCoreRestrictedItemCount

      public Long getCoreRestrictedItemCount()

    • setCoreRestrictedItemCount

      public void setCoreRestrictedItemCount​(Long coreRestrictedItemCount)

    • getCreditCardTransactionCount

      public Long getCreditCardTransactionCount()

    • setCreditCardTransactionCount

      public void setCreditCardTransactionCount​(Long creditCardTransactionCount)

    • getItemCount

      public Long getItemCount()

    • setItemCount

      public void setItemCount​(Long itemCount)

    • getOrderTopLevelItemCount

      public Long getOrderTopLevelItemCount()

    • setOrderTopLevelItemCount

      public void setOrderTopLevelItemCount​(Long orderTopLevelItemCount)

    • getPaypalTransactionCount

      public Long getPaypalTransactionCount()

    • setPaypalTransactionCount

      public void setPaypalTransactionCount​(Long paypalTransactionCount)

    • asService

      public Order.Service asService​(ApiClient client)

    • service

      public static Order.Service service​(ApiClient client)

    • service

      public static Order.Service service​(ApiClient client, Long id)