Class Item
java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.billing.order.Item
@ApiType("SoftLayer_Billing_Order_Item") public class Item extends Entity
Every individual item that a SoftLayer customer is billed for is recorded in the SoftLayer_Billing_Item data type. Billing items range from server chassis to hard drives to control panels, bandwidth quota upgrades and port upgrade charges. Softlayer [[SoftLayer_Billing_Invoice|invoices]] are generated from the cost of a customer's billing items. Billing items are copied from the product catalog as they're ordered by customers to create a reference between an account and the billable items they own.
Billing items exist in a tree relationship. Items are associated with each other by parent/child relationships. Component items such as CPU's, RAM, and software each have a parent billing item for the server chassis they're associated with. Billing Items with a null parent item do not have an associated parent item.
Billing items exist in a tree relationship. Items are associated with each other by parent/child relationships. Component items such as CPU's, RAM, and software each have a parent billing item for the server chassis they're associated with. Billing Items with a null parent item do not have an associated parent item.
- See Also:
- SoftLayer_Billing_Order_Item
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Item.Mask
static interface
Item.Service
The SoftLayer_Billing_Order_Item datatype provides information regarding a single ordered item.static interface
Item.ServiceAsync
-
Field Summary
Fields Modifier and Type Field Description protected Item
billingItem
The SoftLayer_Billing_Item tied to the order item.protected Long
bundledItemCount
A count of the other items included with an ordered item.protected List<Item>
bundledItems
The other items included with an ordered item.protected Category
category
The item category tied to an order item.protected String
categoryCode
The category code for the order item.protected boolean
categoryCodeSpecified
protected List<Item>
children
The child order items for an order item.protected Long
childrenCount
A count of the child order items for an order item.protected String
description
friendly description of purchase item.protected boolean
descriptionSpecified
protected String
domainName
The domain name of the server as designated by the purchaser at the time of order placement.protected boolean
domainNameSpecified
protected String
globalIdentifier
A hardware's universally unique identifier.protected Generic
hardwareGenericComponent
The component type tied to an order item.protected String
hostName
The hostname of the server as designated by the purchaser at the time of order placement.protected boolean
hostNameSpecified
protected BigDecimal
hourlyRecurringFee
The amount of money charged per hourly for an order item, if applicable, and only if it was ordered this day.protected boolean
hourlyRecurringFeeSpecified
protected Long
id
protected boolean
idSpecified
protected Item
item
The SoftLayer_Product_Item tied to an order item.protected Long
itemCategoryAnswerCount
A count of this is an item's category answers.protected List<Answer>
itemCategoryAnswers
This is an item's category answers.protected Long
itemId
The SoftLayer_Product_Item ID for this order item.protected boolean
itemIdSpecified
protected Package
itemPackage
The SoftLayer_Product_Package an order item is a part of.protected Price
itemPrice
The SoftLayer_Product_Item_Price tied to an order item.protected BigDecimal
itemPriceId
the item price id (SoftLayer_Product_Item_Price->id) of the ordered item.protected boolean
itemPriceIdSpecified
protected BigDecimal
laborAfterTaxAmount
An order item's labor fee total after taxes.protected boolean
laborAfterTaxAmountSpecified
protected BigDecimal
laborFee
The labor fee, if any.protected boolean
laborFeeSpecified
protected BigDecimal
laborFeeTaxRate
The rate at which labor fees are taxed if you are a taxable customer.protected boolean
laborFeeTaxRateSpecified
protected BigDecimal
laborTaxAmount
An order item's labor tax amount.protected boolean
laborTaxAmountSpecified
protected Location
location
The location of an ordered item.protected List<Item>
nextOrderChildren
protected Long
nextOrderChildrenCount
A count ofprotected Item
oldBillingItem
This is only populated when an upgrade order is placed.protected BigDecimal
oneTimeAfterTaxAmount
An order item's one-time fee total after taxes.protected boolean
oneTimeAfterTaxAmountSpecified
protected BigDecimal
oneTimeFee
The amount of money charged as a one-time charge for an order item, if applicable.protected boolean
oneTimeFeeSpecified
protected BigDecimal
oneTimeFeeTaxRate
The rate at which one time fees are taxed if you are a taxable customer.protected boolean
oneTimeFeeTaxRateSpecified
protected BigDecimal
oneTimeTaxAmount
An order item's one-time tax amount.protected boolean
oneTimeTaxAmountSpecified
protected Order
order
The order to which this item belongs.protected GregorianCalendar
orderApprovalDate
protected Item
parent
The parent order item ID for an item.protected Long
parentId
protected boolean
parentIdSpecified
protected Preset
preset
The SoftLayer_Product_Package_Preset related to this order item.protected Long
presetId
The id for the preset configuration ordered.protected boolean
presetIdSpecified
protected Promotion
promoCode
protected Long
promoCodeId
protected boolean
promoCodeIdSpecified
protected Long
quantity
the quantity of the ordered item in a quote.protected boolean
quantitySpecified
protected BigDecimal
recurringAfterTaxAmount
An order item's recurring fee total after taxes.protected boolean
recurringAfterTaxAmountSpecified
protected BigDecimal
recurringFee
The amount of money charged per month for an order item, if applicable.protected boolean
recurringFeeSpecified
protected BigDecimal
recurringTaxAmount
An order item's recurring tax amount.protected boolean
recurringTaxAmountSpecified
protected Long
redundantPowerSupplyCount
A count of power supplies contained within this SoftLayer_Billing_Orderprotected BigDecimal
setupAfterTaxAmount
An order item's setup fee total after taxes.protected boolean
setupAfterTaxAmountSpecified
protected BigDecimal
setupFee
The setup fee, if any.protected Long
setupFeeDeferralMonths
The month set up fee deferral.protected boolean
setupFeeDeferralMonthsSpecified
protected boolean
setupFeeSpecified
protected BigDecimal
setupFeeTaxRate
The rate at which setup fees are taxed if you are a taxable customer.protected boolean
setupFeeTaxRateSpecified
protected BigDecimal
setupTaxAmount
An order item's setup tax amount.protected boolean
setupTaxAmountSpecified
protected Description
softwareDescription
For ordered items that are software items, a full description of that software can be found with this property.protected Long
storageGroupCount
A count of the drive storage groups that are attached to this billing order item.protected List<Order>
storageGroups
The drive storage groups that are attached to this billing order item.protected BigDecimal
totalRecurringAmount
The recurring fee of an ordered item.protected Item
upgradeItem
The next SoftLayer_Product_Item in the upgrade path for this order item. -
Constructor Summary
Constructors Constructor Description Item()
-
Method Summary
-
Field Details
-
billingItem
The SoftLayer_Billing_Item tied to the order item. -
bundledItems
The other items included with an ordered item. -
category
The item category tied to an order item. -
children
The child order items for an order item. All server order items should have children. These children are considered a part of the server. -
globalIdentifier
A hardware's universally unique identifier. -
hardwareGenericComponent
The component type tied to an order item. All hardware-specific items should have a generic hardware component. -
item
The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold. -
itemCategoryAnswers
This is an item's category answers. -
itemPrice
The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item. -
location
The location of an ordered item. This is usually the same as the server it is being ordered with. Otherwise it describes the location of the additional service being ordered. -
nextOrderChildren
-
oldBillingItem
This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened. -
order
The order to which this item belongs. The order contains all the information related to the items included in an order -
orderApprovalDate
-
itemPackage
The SoftLayer_Product_Package an order item is a part of. -
parent
The parent order item ID for an item. Items that are associated with a server will have a parent. The parent will be the server item itself. -
preset
The SoftLayer_Product_Package_Preset related to this order item. -
promoCode
-
redundantPowerSupplyCount
A count of power supplies contained within this SoftLayer_Billing_Order -
softwareDescription
For ordered items that are software items, a full description of that software can be found with this property. -
storageGroups
The drive storage groups that are attached to this billing order item. -
totalRecurringAmount
The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis. -
upgradeItem
The next SoftLayer_Product_Item in the upgrade path for this order item. -
categoryCode
The category code for the order item. -
categoryCodeSpecified
protected boolean categoryCodeSpecified -
description
friendly description of purchase item. -
descriptionSpecified
protected boolean descriptionSpecified -
domainName
The domain name of the server as designated by the purchaser at the time of order placement. -
domainNameSpecified
protected boolean domainNameSpecified -
hostName
The hostname of the server as designated by the purchaser at the time of order placement. -
hostNameSpecified
protected boolean hostNameSpecified -
hourlyRecurringFee
The amount of money charged per hourly for an order item, if applicable, and only if it was ordered this day. hourlyRecurringFee is measured in US Dollars ($USD). -
hourlyRecurringFeeSpecified
protected boolean hourlyRecurringFeeSpecified -
id
-
idSpecified
protected boolean idSpecified -
itemId
The SoftLayer_Product_Item ID for this order item. -
itemIdSpecified
protected boolean itemIdSpecified -
itemPriceId
the item price id (SoftLayer_Product_Item_Price->id) of the ordered item. -
itemPriceIdSpecified
protected boolean itemPriceIdSpecified -
laborAfterTaxAmount
An order item's labor fee total after taxes. This does not include any child invoice items. -
laborAfterTaxAmountSpecified
protected boolean laborAfterTaxAmountSpecified -
laborFee
The labor fee, if any. This is a one time charge. -
laborFeeSpecified
protected boolean laborFeeSpecified -
laborFeeTaxRate
The rate at which labor fees are taxed if you are a taxable customer. -
laborFeeTaxRateSpecified
protected boolean laborFeeTaxRateSpecified -
laborTaxAmount
An order item's labor tax amount. This does not include any child invoice items. -
laborTaxAmountSpecified
protected boolean laborTaxAmountSpecified -
oneTimeAfterTaxAmount
An order item's one-time fee total after taxes. This does not include any child invoice items. -
oneTimeAfterTaxAmountSpecified
protected boolean oneTimeAfterTaxAmountSpecified -
oneTimeFee
The amount of money charged as a one-time charge for an order item, if applicable. oneTimeFee is measured in US Dollars ($USD). -
oneTimeFeeSpecified
protected boolean oneTimeFeeSpecified -
oneTimeFeeTaxRate
The rate at which one time fees are taxed if you are a taxable customer. -
oneTimeFeeTaxRateSpecified
protected boolean oneTimeFeeTaxRateSpecified -
oneTimeTaxAmount
An order item's one-time tax amount. This does not include any child invoice items. -
oneTimeTaxAmountSpecified
protected boolean oneTimeTaxAmountSpecified -
parentId
-
parentIdSpecified
protected boolean parentIdSpecified -
presetId
The id for the preset configuration ordered. -
presetIdSpecified
protected boolean presetIdSpecified -
promoCodeId
-
promoCodeIdSpecified
protected boolean promoCodeIdSpecified -
quantity
the quantity of the ordered item in a quote. -
quantitySpecified
protected boolean quantitySpecified -
recurringAfterTaxAmount
An order item's recurring fee total after taxes. This does not include any child invoice items. -
recurringAfterTaxAmountSpecified
protected boolean recurringAfterTaxAmountSpecified -
recurringFee
The amount of money charged per month for an order item, if applicable. recurringFee is measured in US Dollars ($USD). -
recurringFeeSpecified
protected boolean recurringFeeSpecified -
recurringTaxAmount
An order item's recurring tax amount. This does not include any child invoice items. -
recurringTaxAmountSpecified
protected boolean recurringTaxAmountSpecified -
setupAfterTaxAmount
An order item's setup fee total after taxes. This does not include any child invoice items. -
setupAfterTaxAmountSpecified
protected boolean setupAfterTaxAmountSpecified -
setupFee
The setup fee, if any. This is a one time charge. -
setupFeeSpecified
protected boolean setupFeeSpecified -
setupFeeDeferralMonths
The month set up fee deferral. -
setupFeeDeferralMonthsSpecified
protected boolean setupFeeDeferralMonthsSpecified -
setupFeeTaxRate
The rate at which setup fees are taxed if you are a taxable customer. -
setupFeeTaxRateSpecified
protected boolean setupFeeTaxRateSpecified -
setupTaxAmount
An order item's setup tax amount. This does not include any child invoice items. -
setupTaxAmountSpecified
protected boolean setupTaxAmountSpecified -
bundledItemCount
A count of the other items included with an ordered item. -
childrenCount
A count of the child order items for an order item. All server order items should have children. These children are considered a part of the server. -
itemCategoryAnswerCount
A count of this is an item's category answers. -
nextOrderChildrenCount
A count of -
storageGroupCount
A count of the drive storage groups that are attached to this billing order item.
-
-
Constructor Details
-
Item
public Item()
-
-
Method Details
-
getBillingItem
-
setBillingItem
-
getBundledItems
-
getCategory
-
setCategory
-
getChildren
-
getGlobalIdentifier
-
setGlobalIdentifier
-
getHardwareGenericComponent
-
setHardwareGenericComponent
-
getItem
-
setItem
-
getItemCategoryAnswers
-
getItemPrice
-
setItemPrice
-
getLocation
-
setLocation
-
getNextOrderChildren
-
getOldBillingItem
-
setOldBillingItem
-
getOrder
-
setOrder
-
getOrderApprovalDate
-
setOrderApprovalDate
-
getItemPackage
-
setItemPackage
-
getParent
-
setParent
-
getPreset
-
setPreset
-
getPromoCode
-
setPromoCode
-
getRedundantPowerSupplyCount
-
setRedundantPowerSupplyCount
-
getSoftwareDescription
-
setSoftwareDescription
-
getStorageGroups
-
getTotalRecurringAmount
-
setTotalRecurringAmount
-
getUpgradeItem
-
setUpgradeItem
-
getCategoryCode
-
setCategoryCode
-
isCategoryCodeSpecified
public boolean isCategoryCodeSpecified() -
unsetCategoryCode
public void unsetCategoryCode() -
getDescription
-
setDescription
-
isDescriptionSpecified
public boolean isDescriptionSpecified() -
unsetDescription
public void unsetDescription() -
getDomainName
-
setDomainName
-
isDomainNameSpecified
public boolean isDomainNameSpecified() -
unsetDomainName
public void unsetDomainName() -
getHostName
-
setHostName
-
isHostNameSpecified
public boolean isHostNameSpecified() -
unsetHostName
public void unsetHostName() -
getHourlyRecurringFee
-
setHourlyRecurringFee
-
isHourlyRecurringFeeSpecified
public boolean isHourlyRecurringFeeSpecified() -
unsetHourlyRecurringFee
public void unsetHourlyRecurringFee() -
getId
-
setId
-
isIdSpecified
public boolean isIdSpecified() -
unsetId
public void unsetId() -
getItemId
-
setItemId
-
isItemIdSpecified
public boolean isItemIdSpecified() -
unsetItemId
public void unsetItemId() -
getItemPriceId
-
setItemPriceId
-
isItemPriceIdSpecified
public boolean isItemPriceIdSpecified() -
unsetItemPriceId
public void unsetItemPriceId() -
getLaborAfterTaxAmount
-
setLaborAfterTaxAmount
-
isLaborAfterTaxAmountSpecified
public boolean isLaborAfterTaxAmountSpecified() -
unsetLaborAfterTaxAmount
public void unsetLaborAfterTaxAmount() -
getLaborFee
-
setLaborFee
-
isLaborFeeSpecified
public boolean isLaborFeeSpecified() -
unsetLaborFee
public void unsetLaborFee() -
getLaborFeeTaxRate
-
setLaborFeeTaxRate
-
isLaborFeeTaxRateSpecified
public boolean isLaborFeeTaxRateSpecified() -
unsetLaborFeeTaxRate
public void unsetLaborFeeTaxRate() -
getLaborTaxAmount
-
setLaborTaxAmount
-
isLaborTaxAmountSpecified
public boolean isLaborTaxAmountSpecified() -
unsetLaborTaxAmount
public void unsetLaborTaxAmount() -
getOneTimeAfterTaxAmount
-
setOneTimeAfterTaxAmount
-
isOneTimeAfterTaxAmountSpecified
public boolean isOneTimeAfterTaxAmountSpecified() -
unsetOneTimeAfterTaxAmount
public void unsetOneTimeAfterTaxAmount() -
getOneTimeFee
-
setOneTimeFee
-
isOneTimeFeeSpecified
public boolean isOneTimeFeeSpecified() -
unsetOneTimeFee
public void unsetOneTimeFee() -
getOneTimeFeeTaxRate
-
setOneTimeFeeTaxRate
-
isOneTimeFeeTaxRateSpecified
public boolean isOneTimeFeeTaxRateSpecified() -
unsetOneTimeFeeTaxRate
public void unsetOneTimeFeeTaxRate() -
getOneTimeTaxAmount
-
setOneTimeTaxAmount
-
isOneTimeTaxAmountSpecified
public boolean isOneTimeTaxAmountSpecified() -
unsetOneTimeTaxAmount
public void unsetOneTimeTaxAmount() -
getParentId
-
setParentId
-
isParentIdSpecified
public boolean isParentIdSpecified() -
unsetParentId
public void unsetParentId() -
getPresetId
-
setPresetId
-
isPresetIdSpecified
public boolean isPresetIdSpecified() -
unsetPresetId
public void unsetPresetId() -
getPromoCodeId
-
setPromoCodeId
-
isPromoCodeIdSpecified
public boolean isPromoCodeIdSpecified() -
unsetPromoCodeId
public void unsetPromoCodeId() -
getQuantity
-
setQuantity
-
isQuantitySpecified
public boolean isQuantitySpecified() -
unsetQuantity
public void unsetQuantity() -
getRecurringAfterTaxAmount
-
setRecurringAfterTaxAmount
-
isRecurringAfterTaxAmountSpecified
public boolean isRecurringAfterTaxAmountSpecified() -
unsetRecurringAfterTaxAmount
public void unsetRecurringAfterTaxAmount() -
getRecurringFee
-
setRecurringFee
-
isRecurringFeeSpecified
public boolean isRecurringFeeSpecified() -
unsetRecurringFee
public void unsetRecurringFee() -
getRecurringTaxAmount
-
setRecurringTaxAmount
-
isRecurringTaxAmountSpecified
public boolean isRecurringTaxAmountSpecified() -
unsetRecurringTaxAmount
public void unsetRecurringTaxAmount() -
getSetupAfterTaxAmount
-
setSetupAfterTaxAmount
-
isSetupAfterTaxAmountSpecified
public boolean isSetupAfterTaxAmountSpecified() -
unsetSetupAfterTaxAmount
public void unsetSetupAfterTaxAmount() -
getSetupFee
-
setSetupFee
-
isSetupFeeSpecified
public boolean isSetupFeeSpecified() -
unsetSetupFee
public void unsetSetupFee() -
getSetupFeeDeferralMonths
-
setSetupFeeDeferralMonths
-
isSetupFeeDeferralMonthsSpecified
public boolean isSetupFeeDeferralMonthsSpecified() -
unsetSetupFeeDeferralMonths
public void unsetSetupFeeDeferralMonths() -
getSetupFeeTaxRate
-
setSetupFeeTaxRate
-
isSetupFeeTaxRateSpecified
public boolean isSetupFeeTaxRateSpecified() -
unsetSetupFeeTaxRate
public void unsetSetupFeeTaxRate() -
getSetupTaxAmount
-
setSetupTaxAmount
-
isSetupTaxAmountSpecified
public boolean isSetupTaxAmountSpecified() -
unsetSetupTaxAmount
public void unsetSetupTaxAmount() -
getBundledItemCount
-
setBundledItemCount
-
getChildrenCount
-
setChildrenCount
-
getItemCategoryAnswerCount
-
setItemCategoryAnswerCount
-
getNextOrderChildrenCount
-
setNextOrderChildrenCount
-
getStorageGroupCount
-
setStorageGroupCount
-
asService
-
service
-
service
-
service
-