All Superinterfaces:: Maskable, ResultLimitable, Service

Enclosing class:: Order

@ApiService("SoftLayer_Billing_Order")
public static interface Order.Service
extends Service

The SoftLayer_Billing_Order service controls the orders that are created whenever a SoftLayer customer's places a purchase. Orders exist in several states. The ones of concern are:
*'''QUOTE_PENDING''': Orders which have not been paid yet. Orders pending approval from a Softlayer customer.

Once an order is paid it moves from QUOTE_PENDING to PENDING_APPROVAL state.

Orders are created with contact information duplicated from the [[SoftLayer_Account (type)|SoftLayer_Account data type]] or by manual entry. We do this in order to maintain a history of an account's contact information as orders are generated.

Query the [[SoftLayer_Account]] service to get a list of orders for your account.

See Also:: SoftLayer_Billing_Order

Method Summary

Modifier and Type	Method	Description
`Boolean`	`approveModifiedOrder()`	When an order has been modified, the customer will need to approve the changes.
`Order.ServiceAsync`	`asAsync()`	Get an async version of this service
`Account`	`getAccount()`	The [[SoftLayer_Account\|account]] to which an order belongs.
`List<Order>`	`getAllObjects()`	This will get all billing orders for your account.
`Brand`	`getBrand()`
`Cart`	`getCart()`	A cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices.
`List<Item>`	`getCoreRestrictedItems()`	The [[SoftLayer_Billing_Order_Item (type)\|order items]] that are core restricted
`List<Transaction>`	`getCreditCardTransactions()`	All credit card transactions associated with this order.
`ExchangeRate`	`getExchangeRate()`
`Invoice`	`getInitialInvoice()`
`List<Item>`	`getItems()`	The SoftLayer_Billing_Order_items included in an order.
`Order`	`getObject()`	getObject retrieves the SoftLayer_Billing_Order object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Order service.
`GregorianCalendar`	`getOrderApprovalDate()`
`BigDecimal`	`getOrderNonServerMonthlyAmount()`	An order's non-server items total monthly fee.
`BigDecimal`	`getOrderServerMonthlyAmount()`	An order's server items total monthly fee.
`List<Status>`	`getOrderStatuses()`	Get a list of [[SoftLayer_Container_Billing_Order_Status]] objects.
`List<Item>`	`getOrderTopLevelItems()`	An order's top level items.
`BigDecimal`	`getOrderTotalAmount()`	This amount represents the order's initial charge including set up fee and taxes.
`BigDecimal`	`getOrderTotalOneTime()`	An order's total one time amount summing all the set up fees, the labor fees and the one time fees.
`BigDecimal`	`getOrderTotalOneTimeAmount()`	An order's total one time amount.
`BigDecimal`	`getOrderTotalOneTimeTaxAmount()`	An order's total one time tax amount.
`BigDecimal`	`getOrderTotalRecurring()`	An order's total recurring amount.
`BigDecimal`	`getOrderTotalRecurringAmount()`	An order's total recurring amount.
`BigDecimal`	`getOrderTotalRecurringTaxAmount()`	The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.
`BigDecimal`	`getOrderTotalSetupAmount()`	An order's total setup fee.
`Type`	`getOrderType()`	The type of an order.
`List<Transaction>`	`getPaypalTransactions()`	All PayPal transactions associated with this order.
`byte[]`	`getPdf()`	Retrieve a PDF record of a SoftLayer quote.
`String`	`getPdfFilename()`	Retrieve the default filename of an order PDF.
`Event`	`getPresaleEvent()`
`Quote`	`getQuote()`	The quote of an order.
`Order`	`getRecalculatedOrderContainer(String message, Boolean ignoreDiscountsFlag)`	Generate an [[SoftLayer_Container_Product_Order\|order container]] from a billing order.
`Receipt`	`getReceipt()`	Generate a [[SoftLayer_Container_Product_Order_Receipt]] object with all the order information.
`Account`	`getReferralPartner()`	The Referral Partner who referred this order.
`Boolean`	`getUpgradeRequestFlag()`	This flag indicates an order is an upgrade.
`Customer`	`getUserRecord()`	The SoftLayer_User_Customer object tied to an order.
`Boolean`	`isPendingEditApproval()`	When an order has been modified, it will contain a status indicating so.
`void`	`setMask(Order.Mask mask)`
`Order.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Order.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details
- asAsync
  
  Order.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Order.Mask withNewMask()
  
  Description copied from interface: Maskable
  
  Overwrite the existing mask on this service with a new one and return it
  
  Specified by:
  
  withNewMask in interface Maskable
- withMask
  
  Order.Mask withMask()
  
  Description copied from interface: Maskable
  
  Use the existing mask on this service or create it if not present
  
  Specified by:
  
  withMask in interface Maskable
- setMask
  
  void setMask(Order.Mask mask)
- approveModifiedOrder
  
  @ApiMethod(instanceRequired=true) Boolean approveModifiedOrder()
  
  When an order has been modified, the customer will need to approve the changes. This method will allow the customer to approve the changes.
  
  See Also:
  
  SoftLayer_Billing_Order::approveModifiedOrder
- getAllObjects
  
  @ApiMethod List<Order> getAllObjects()
  
  This will get all billing orders for your account.
  
  See Also:
  
  SoftLayer_Billing_Order::getAllObjects
- getObject
  
  @ApiMethod(instanceRequired=true) Order getObject()
  
  getObject retrieves the SoftLayer_Billing_Order object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Order service. You can only retrieve orders that are assigned to your portal user's account.
  
  See Also:
  
  SoftLayer_Billing_Order::getObject
- getOrderStatuses
  
  @ApiMethod List<Status> getOrderStatuses()
  
  Get a list of [[SoftLayer_Container_Billing_Order_Status]] objects.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderStatuses
- getPdf
  
  @ApiMethod(instanceRequired=true) byte[] getPdf()
  
  Retrieve a PDF record of a SoftLayer quote. If the order is not a quote, an error will be thrown.
  
  See Also:
  
  SoftLayer_Billing_Order::getPdf
- getPdfFilename
  
  @ApiMethod(instanceRequired=true) String getPdfFilename()
  
  Retrieve the default filename of an order PDF.
  
  See Also:
  
  SoftLayer_Billing_Order::getPdfFilename
- getRecalculatedOrderContainer
  
  @ApiMethod(instanceRequired=true) Order getRecalculatedOrderContainer(String message, Boolean ignoreDiscountsFlag)
  
  Generate an [[SoftLayer_Container_Product_Order|order container]] from a billing order. This will take into account promotions, reseller status, estimated taxes and all other standard order verification processes.
  
  See Also:
  
  SoftLayer_Billing_Order::getRecalculatedOrderContainer
- getReceipt
  
  @ApiMethod(instanceRequired=true) Receipt getReceipt()
  
  Generate a [[SoftLayer_Container_Product_Order_Receipt]] object with all the order information.
  
  See Also:
  
  SoftLayer_Billing_Order::getReceipt
- isPendingEditApproval
  
  @ApiMethod(instanceRequired=true) Boolean isPendingEditApproval()
  
  When an order has been modified, it will contain a status indicating so. This method checks that status and also verifies that the active user's account is the same as the account on the order.
  
  See Also:
  
  SoftLayer_Billing_Order::isPendingEditApproval
- getAccount
  
  @ApiMethod(instanceRequired=true) Account getAccount()
  
  The [[SoftLayer_Account|account]] to which an order belongs.
  
  See Also:
  
  SoftLayer_Billing_Order::getAccount
- getBrand
  
  @ApiMethod(instanceRequired=true) Brand getBrand()
  
  See Also:
  
  SoftLayer_Billing_Order::getBrand
- getCart
  
  @ApiMethod(instanceRequired=true) Cart getCart()
  
  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.
  
  See Also:
  
  SoftLayer_Billing_Order::getCart
- getCoreRestrictedItems
  
  @ApiMethod(instanceRequired=true) List<Item> getCoreRestrictedItems()
  
  The [[SoftLayer_Billing_Order_Item (type)|order items]] that are core restricted
  
  See Also:
  
  SoftLayer_Billing_Order::getCoreRestrictedItems
- getCreditCardTransactions
  
  @ApiMethod(instanceRequired=true) List<Transaction> getCreditCardTransactions()
  
  All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.
  
  See Also:
  
  SoftLayer_Billing_Order::getCreditCardTransactions
- getExchangeRate
  
  @ApiMethod(instanceRequired=true) ExchangeRate getExchangeRate()
  
  See Also:
  
  SoftLayer_Billing_Order::getExchangeRate
- getInitialInvoice
  
  @ApiMethod(instanceRequired=true) Invoice getInitialInvoice()
  
  See Also:
  
  SoftLayer_Billing_Order::getInitialInvoice
- getItems
  
  @ApiMethod(instanceRequired=true) List<Item> getItems()
  
  The SoftLayer_Billing_Order_items included in an order.
  
  See Also:
  
  SoftLayer_Billing_Order::getItems
- getOrderApprovalDate
  
  @ApiMethod(instanceRequired=true) GregorianCalendar getOrderApprovalDate()
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderApprovalDate
- getOrderNonServerMonthlyAmount
  
  @ApiMethod(instanceRequired=true) BigDecimal getOrderNonServerMonthlyAmount()
  
  An order's non-server items total monthly fee.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderNonServerMonthlyAmount
- getOrderServerMonthlyAmount
  
  @ApiMethod(instanceRequired=true) BigDecimal getOrderServerMonthlyAmount()
  
  An order's server items total monthly fee.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderServerMonthlyAmount
- getOrderTopLevelItems
  
  @ApiMethod(instanceRequired=true) List<Item> getOrderTopLevelItems()
  
  An order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderTopLevelItems
- getOrderTotalAmount
  
  @ApiMethod(instanceRequired=true) BigDecimal getOrderTotalAmount()
  
  This amount represents the order's initial charge including set up fee and taxes.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderTotalAmount
- getOrderTotalOneTime
  
  @ApiMethod(instanceRequired=true) BigDecimal getOrderTotalOneTime()
  
  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.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderTotalOneTime
- getOrderTotalOneTimeAmount
  
  @ApiMethod(instanceRequired=true) BigDecimal getOrderTotalOneTimeAmount()
  
  An order's total one time amount. This amount represents the initial fees before tax.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderTotalOneTimeAmount
- getOrderTotalOneTimeTaxAmount
  
  @ApiMethod(instanceRequired=true) BigDecimal getOrderTotalOneTimeTaxAmount()
  
  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.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderTotalOneTimeTaxAmount
- getOrderTotalRecurring
  
  @ApiMethod(instanceRequired=true) BigDecimal getOrderTotalRecurring()
  
  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.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderTotalRecurring
- getOrderTotalRecurringAmount
  
  @ApiMethod(instanceRequired=true) BigDecimal getOrderTotalRecurringAmount()
  
  An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderTotalRecurringAmount
- getOrderTotalRecurringTaxAmount
  
  @ApiMethod(instanceRequired=true) BigDecimal getOrderTotalRecurringTaxAmount()
  
  The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderTotalRecurringTaxAmount
- getOrderTotalSetupAmount
  
  @ApiMethod(instanceRequired=true) BigDecimal getOrderTotalSetupAmount()
  
  An order's total setup fee.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderTotalSetupAmount
- getOrderType
  
  @ApiMethod(instanceRequired=true) Type getOrderType()
  
  The type of an order. This lets you know where this order was generated from.
  
  See Also:
  
  SoftLayer_Billing_Order::getOrderType
- getPaypalTransactions
  
  @ApiMethod(instanceRequired=true) List<Transaction> getPaypalTransactions()
  
  All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.
  
  See Also:
  
  SoftLayer_Billing_Order::getPaypalTransactions
- getPresaleEvent
  
  @ApiMethod(instanceRequired=true) Event getPresaleEvent()
  
  See Also:
  
  SoftLayer_Billing_Order::getPresaleEvent
- getQuote
  
  @ApiMethod(instanceRequired=true) Quote getQuote()
  
  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'
  
  See Also:
  
  SoftLayer_Billing_Order::getQuote
- getReferralPartner
  
  @ApiMethod(instanceRequired=true) Account getReferralPartner()
  
  The Referral Partner who referred this order. (Only necessary for new customer orders)
  
  See Also:
  
  SoftLayer_Billing_Order::getReferralPartner
- getUpgradeRequestFlag
  
  @ApiMethod(instanceRequired=true) Boolean getUpgradeRequestFlag()
  
  This flag indicates an order is an upgrade.
  
  See Also:
  
  SoftLayer_Billing_Order::getUpgradeRequestFlag
- getUserRecord
  
  @ApiMethod(instanceRequired=true) Customer getUserRecord()
  
  The SoftLayer_User_Customer object tied to an order.
  
  See Also:
  
  SoftLayer_Billing_Order::getUserRecord

Interface Order.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details