Package com.softlayer.api.service.billing.order

Class 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.
    See Also:
    SoftLayer_Billing_Order_Item

    • Field Detail

      • billingItem

        @ApiProperty
protected Item billingItem
        The SoftLayer_Billing_Item tied to the order item.

      • bundledItems

        @ApiProperty
protected List<Item> bundledItems
        The other items included with an ordered item.

      • children

        @ApiProperty
protected List<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

        @ApiProperty
protected String globalIdentifier
        A hardware's universally unique identifier.

      • hardwareGenericComponent

        @ApiProperty
protected Generic hardwareGenericComponent
        The component type tied to an order item. All hardware-specific items should have a generic hardware component.

      • item

        @ApiProperty
protected Item item
        The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold.

      • itemCategoryAnswers

        @ApiProperty
protected List<Answer> itemCategoryAnswers
        This is an item's category answers.

      • itemPrice

        @ApiProperty
protected Price itemPrice
        The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item.

      • location

        @ApiProperty
protected Location 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.

      • oldBillingItem

        @ApiProperty
protected Item 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

        @ApiProperty
protected Order order
        The order to which this item belongs. The order contains all the information related to the items included in an order

      • itemPackage

        @ApiProperty("package")
protected Package itemPackage
        The SoftLayer_Product_Package an order item is a part of.

      • parent

        @ApiProperty
protected Item 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

        @ApiProperty
protected Preset preset
        The SoftLayer_Product_Package_Preset related to this order item.

      • redundantPowerSupplyCount

        @ApiProperty
protected Long redundantPowerSupplyCount
        A count of power supplies contained within this SoftLayer_Billing_Order

      • softwareDescription

        @ApiProperty
protected Description softwareDescription
        For ordered items that are software items, a full description of that software can be found with this property.

      • storageGroups

        @ApiProperty
protected List<Order> storageGroups
        The drive storage groups that are attached to this billing order item.

      • totalRecurringAmount

        @ApiProperty
protected BigDecimal totalRecurringAmount
        The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis.

      • upgradeItem

        @ApiProperty
protected Item upgradeItem
        The next SoftLayer_Product_Item in the upgrade path for this order item.

      • categoryCodeSpecified

        protected boolean categoryCodeSpecified

      • descriptionSpecified

        protected boolean descriptionSpecified

      • domainNameSpecified

        protected boolean domainNameSpecified

      • hostNameSpecified

        protected boolean hostNameSpecified

      • hourlyRecurringFee

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal 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

      • idSpecified

        protected boolean idSpecified

      • itemIdSpecified

        protected boolean itemIdSpecified

      • itemPriceIdSpecified

        protected boolean itemPriceIdSpecified

      • laborAfterTaxAmountSpecified

        protected boolean laborAfterTaxAmountSpecified

      • laborFeeSpecified

        protected boolean laborFeeSpecified

      • laborFeeTaxRateSpecified

        protected boolean laborFeeTaxRateSpecified

      • laborTaxAmountSpecified

        protected boolean laborTaxAmountSpecified

      • oneTimeAfterTaxAmount

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal oneTimeAfterTaxAmount
        An order item's one-time fee total after taxes. This does not include any child invoice items.

      • oneTimeAfterTaxAmountSpecified

        protected boolean oneTimeAfterTaxAmountSpecified

      • oneTimeFee

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal 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

      • oneTimeFeeTaxRateSpecified

        protected boolean oneTimeFeeTaxRateSpecified

      • oneTimeTaxAmountSpecified

        protected boolean oneTimeTaxAmountSpecified

      • parentIdSpecified

        protected boolean parentIdSpecified

      • presetIdSpecified

        protected boolean presetIdSpecified

      • promoCodeIdSpecified

        protected boolean promoCodeIdSpecified

      • quantitySpecified

        protected boolean quantitySpecified

      • recurringAfterTaxAmount

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal recurringAfterTaxAmount
        An order item's recurring fee total after taxes. This does not include any child invoice items.

      • recurringAfterTaxAmountSpecified

        protected boolean recurringAfterTaxAmountSpecified

      • recurringFee

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal 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

      • recurringTaxAmountSpecified

        protected boolean recurringTaxAmountSpecified

      • setupAfterTaxAmountSpecified

        protected boolean setupAfterTaxAmountSpecified

      • setupFeeSpecified

        protected boolean setupFeeSpecified

      • setupFeeDeferralMonthsSpecified

        protected boolean setupFeeDeferralMonthsSpecified

      • setupFeeTaxRateSpecified

        protected boolean setupFeeTaxRateSpecified

      • setupTaxAmountSpecified

        protected boolean setupTaxAmountSpecified

      • bundledItemCount

        @ApiProperty
protected Long bundledItemCount
        A count of the other items included with an ordered item.

      • childrenCount

        @ApiProperty
protected Long 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

        @ApiProperty
protected Long itemCategoryAnswerCount
        A count of this is an item's category answers.

      • nextOrderChildrenCount

        @ApiProperty
protected Long nextOrderChildrenCount
        A count of

      • storageGroupCount

        @ApiProperty
protected Long storageGroupCount
        A count of the drive storage groups that are attached to this billing order item.

    • Constructor Detail

      • Item

        public Item()

    • Method Detail

      • getBillingItem

        public Item getBillingItem()

      • setBillingItem

        public void setBillingItem​(Item billingItem)

      • getBundledItems

        public List<Item> getBundledItems()

      • getCategory

        public Category getCategory()

      • setCategory

        public void setCategory​(Category category)

      • getChildren

        public List<Item> getChildren()

      • getGlobalIdentifier

        public String getGlobalIdentifier()

      • setGlobalIdentifier

        public void setGlobalIdentifier​(String globalIdentifier)

      • getHardwareGenericComponent

        public Generic getHardwareGenericComponent()

      • setHardwareGenericComponent

        public void setHardwareGenericComponent​(Generic hardwareGenericComponent)

      • getItem

        public Item getItem()

      • setItem

        public void setItem​(Item item)

      • getItemCategoryAnswers

        public List<Answer> getItemCategoryAnswers()

      • getItemPrice

        public Price getItemPrice()

      • setItemPrice

        public void setItemPrice​(Price itemPrice)

      • getLocation

        public Location getLocation()

      • setLocation

        public void setLocation​(Location location)

      • getNextOrderChildren

        public List<Item> getNextOrderChildren()

      • getOldBillingItem

        public Item getOldBillingItem()

      • setOldBillingItem

        public void setOldBillingItem​(Item oldBillingItem)

      • getOrder

        public Order getOrder()

      • setOrder

        public void setOrder​(Order order)

      • setOrderApprovalDate

        public void setOrderApprovalDate​(GregorianCalendar orderApprovalDate)

      • getItemPackage

        public Package getItemPackage()

      • setItemPackage

        public void setItemPackage​(Package itemPackage)

      • getParent

        public Item getParent()

      • setParent

        public void setParent​(Item parent)

      • getPreset

        public Preset getPreset()

      • setPreset

        public void setPreset​(Preset preset)

      • getPromoCode

        public Promotion getPromoCode()

      • setPromoCode

        public void setPromoCode​(Promotion promoCode)

      • getRedundantPowerSupplyCount

        public Long getRedundantPowerSupplyCount()

      • setRedundantPowerSupplyCount

        public void setRedundantPowerSupplyCount​(Long redundantPowerSupplyCount)

      • getSoftwareDescription

        public Description getSoftwareDescription()

      • setSoftwareDescription

        public void setSoftwareDescription​(Description softwareDescription)

      • getStorageGroups

        public List<Order> getStorageGroups()

      • getTotalRecurringAmount

        public BigDecimal getTotalRecurringAmount()

      • setTotalRecurringAmount

        public void setTotalRecurringAmount​(BigDecimal totalRecurringAmount)

      • getUpgradeItem

        public Item getUpgradeItem()

      • setUpgradeItem

        public void setUpgradeItem​(Item upgradeItem)

      • getCategoryCode

        public String getCategoryCode()

      • setCategoryCode

        public void setCategoryCode​(String categoryCode)

      • isCategoryCodeSpecified

        public boolean isCategoryCodeSpecified()

      • unsetCategoryCode

        public void unsetCategoryCode()

      • getDescription

        public String getDescription()

      • setDescription

        public void setDescription​(String description)

      • isDescriptionSpecified

        public boolean isDescriptionSpecified()

      • unsetDescription

        public void unsetDescription()

      • getDomainName

        public String getDomainName()

      • setDomainName

        public void setDomainName​(String domainName)

      • isDomainNameSpecified

        public boolean isDomainNameSpecified()

      • unsetDomainName

        public void unsetDomainName()

      • getHostName

        public String getHostName()

      • setHostName

        public void setHostName​(String hostName)

      • isHostNameSpecified

        public boolean isHostNameSpecified()

      • unsetHostName

        public void unsetHostName()

      • getHourlyRecurringFee

        public BigDecimal getHourlyRecurringFee()

      • setHourlyRecurringFee

        public void setHourlyRecurringFee​(BigDecimal hourlyRecurringFee)

      • isHourlyRecurringFeeSpecified

        public boolean isHourlyRecurringFeeSpecified()

      • unsetHourlyRecurringFee

        public void unsetHourlyRecurringFee()

      • getId

        public Long getId()

      • setId

        public void setId​(Long id)

      • isIdSpecified

        public boolean isIdSpecified()

      • unsetId

        public void unsetId()

      • getItemId

        public Long getItemId()

      • setItemId

        public void setItemId​(Long itemId)

      • isItemIdSpecified

        public boolean isItemIdSpecified()

      • unsetItemId

        public void unsetItemId()

      • getItemPriceId

        public BigDecimal getItemPriceId()

      • setItemPriceId

        public void setItemPriceId​(BigDecimal itemPriceId)

      • isItemPriceIdSpecified

        public boolean isItemPriceIdSpecified()

      • unsetItemPriceId

        public void unsetItemPriceId()

      • getLaborAfterTaxAmount

        public BigDecimal getLaborAfterTaxAmount()

      • setLaborAfterTaxAmount

        public void setLaborAfterTaxAmount​(BigDecimal laborAfterTaxAmount)

      • isLaborAfterTaxAmountSpecified

        public boolean isLaborAfterTaxAmountSpecified()

      • unsetLaborAfterTaxAmount

        public void unsetLaborAfterTaxAmount()

      • setLaborFee

        public void setLaborFee​(BigDecimal laborFee)

      • isLaborFeeSpecified

        public boolean isLaborFeeSpecified()

      • unsetLaborFee

        public void unsetLaborFee()

      • getLaborFeeTaxRate

        public BigDecimal getLaborFeeTaxRate()

      • setLaborFeeTaxRate

        public void setLaborFeeTaxRate​(BigDecimal laborFeeTaxRate)

      • isLaborFeeTaxRateSpecified

        public boolean isLaborFeeTaxRateSpecified()

      • unsetLaborFeeTaxRate

        public void unsetLaborFeeTaxRate()

      • getLaborTaxAmount

        public BigDecimal getLaborTaxAmount()

      • setLaborTaxAmount

        public void setLaborTaxAmount​(BigDecimal laborTaxAmount)

      • isLaborTaxAmountSpecified

        public boolean isLaborTaxAmountSpecified()

      • unsetLaborTaxAmount

        public void unsetLaborTaxAmount()

      • getOneTimeAfterTaxAmount

        public BigDecimal getOneTimeAfterTaxAmount()

      • setOneTimeAfterTaxAmount

        public void setOneTimeAfterTaxAmount​(BigDecimal oneTimeAfterTaxAmount)

      • isOneTimeAfterTaxAmountSpecified

        public boolean isOneTimeAfterTaxAmountSpecified()

      • unsetOneTimeAfterTaxAmount

        public void unsetOneTimeAfterTaxAmount()

      • getOneTimeFee

        public BigDecimal getOneTimeFee()

      • setOneTimeFee

        public void setOneTimeFee​(BigDecimal oneTimeFee)

      • isOneTimeFeeSpecified

        public boolean isOneTimeFeeSpecified()

      • unsetOneTimeFee

        public void unsetOneTimeFee()

      • getOneTimeFeeTaxRate

        public BigDecimal getOneTimeFeeTaxRate()

      • setOneTimeFeeTaxRate

        public void setOneTimeFeeTaxRate​(BigDecimal oneTimeFeeTaxRate)

      • isOneTimeFeeTaxRateSpecified

        public boolean isOneTimeFeeTaxRateSpecified()

      • unsetOneTimeFeeTaxRate

        public void unsetOneTimeFeeTaxRate()

      • getOneTimeTaxAmount

        public BigDecimal getOneTimeTaxAmount()

      • setOneTimeTaxAmount

        public void setOneTimeTaxAmount​(BigDecimal oneTimeTaxAmount)

      • isOneTimeTaxAmountSpecified

        public boolean isOneTimeTaxAmountSpecified()

      • unsetOneTimeTaxAmount

        public void unsetOneTimeTaxAmount()

      • getParentId

        public Long getParentId()

      • setParentId

        public void setParentId​(Long parentId)

      • isParentIdSpecified

        public boolean isParentIdSpecified()

      • unsetParentId

        public void unsetParentId()

      • getPresetId

        public Long getPresetId()

      • setPresetId

        public void setPresetId​(Long presetId)

      • isPresetIdSpecified

        public boolean isPresetIdSpecified()

      • unsetPresetId

        public void unsetPresetId()

      • getPromoCodeId

        public Long getPromoCodeId()

      • setPromoCodeId

        public void setPromoCodeId​(Long promoCodeId)

      • isPromoCodeIdSpecified

        public boolean isPromoCodeIdSpecified()

      • unsetPromoCodeId

        public void unsetPromoCodeId()

      • getQuantity

        public Long getQuantity()

      • setQuantity

        public void setQuantity​(Long quantity)

      • isQuantitySpecified

        public boolean isQuantitySpecified()

      • unsetQuantity

        public void unsetQuantity()

      • getRecurringAfterTaxAmount

        public BigDecimal getRecurringAfterTaxAmount()

      • setRecurringAfterTaxAmount

        public void setRecurringAfterTaxAmount​(BigDecimal recurringAfterTaxAmount)

      • isRecurringAfterTaxAmountSpecified

        public boolean isRecurringAfterTaxAmountSpecified()

      • unsetRecurringAfterTaxAmount

        public void unsetRecurringAfterTaxAmount()

      • getRecurringFee

        public BigDecimal getRecurringFee()

      • setRecurringFee

        public void setRecurringFee​(BigDecimal recurringFee)

      • isRecurringFeeSpecified

        public boolean isRecurringFeeSpecified()

      • unsetRecurringFee

        public void unsetRecurringFee()

      • getRecurringTaxAmount

        public BigDecimal getRecurringTaxAmount()

      • setRecurringTaxAmount

        public void setRecurringTaxAmount​(BigDecimal recurringTaxAmount)

      • isRecurringTaxAmountSpecified

        public boolean isRecurringTaxAmountSpecified()

      • unsetRecurringTaxAmount

        public void unsetRecurringTaxAmount()

      • getSetupAfterTaxAmount

        public BigDecimal getSetupAfterTaxAmount()

      • setSetupAfterTaxAmount

        public void setSetupAfterTaxAmount​(BigDecimal setupAfterTaxAmount)

      • isSetupAfterTaxAmountSpecified

        public boolean isSetupAfterTaxAmountSpecified()

      • unsetSetupAfterTaxAmount

        public void unsetSetupAfterTaxAmount()

      • setSetupFee

        public void setSetupFee​(BigDecimal setupFee)

      • isSetupFeeSpecified

        public boolean isSetupFeeSpecified()

      • unsetSetupFee

        public void unsetSetupFee()

      • getSetupFeeDeferralMonths

        public Long getSetupFeeDeferralMonths()

      • setSetupFeeDeferralMonths

        public void setSetupFeeDeferralMonths​(Long setupFeeDeferralMonths)

      • isSetupFeeDeferralMonthsSpecified

        public boolean isSetupFeeDeferralMonthsSpecified()

      • unsetSetupFeeDeferralMonths

        public void unsetSetupFeeDeferralMonths()

      • getSetupFeeTaxRate

        public BigDecimal getSetupFeeTaxRate()

      • setSetupFeeTaxRate

        public void setSetupFeeTaxRate​(BigDecimal setupFeeTaxRate)

      • isSetupFeeTaxRateSpecified

        public boolean isSetupFeeTaxRateSpecified()

      • unsetSetupFeeTaxRate

        public void unsetSetupFeeTaxRate()

      • getSetupTaxAmount

        public BigDecimal getSetupTaxAmount()

      • setSetupTaxAmount

        public void setSetupTaxAmount​(BigDecimal setupTaxAmount)

      • isSetupTaxAmountSpecified

        public boolean isSetupTaxAmountSpecified()

      • unsetSetupTaxAmount

        public void unsetSetupTaxAmount()

      • getBundledItemCount

        public Long getBundledItemCount()

      • setBundledItemCount

        public void setBundledItemCount​(Long bundledItemCount)

      • getChildrenCount

        public Long getChildrenCount()

      • setChildrenCount

        public void setChildrenCount​(Long childrenCount)

      • getItemCategoryAnswerCount

        public Long getItemCategoryAnswerCount()

      • setItemCategoryAnswerCount

        public void setItemCategoryAnswerCount​(Long itemCategoryAnswerCount)

      • getNextOrderChildrenCount

        public Long getNextOrderChildrenCount()

      • setNextOrderChildrenCount

        public void setNextOrderChildrenCount​(Long nextOrderChildrenCount)

      • getStorageGroupCount

        public Long getStorageGroupCount()

      • setStorageGroupCount

        public void setStorageGroupCount​(Long storageGroupCount)