Package com.softlayer.api.service.billing.invoice

Class Item

  • Direct Known Subclasses:
    Hardware
    @ApiType("SoftLayer_Billing_Invoice_Item")
public class Item
extends Entity
    Each billing invoice item makes up a record within an invoice. This provides you with a detailed record of everything related to an invoice item. When you are billed, our system takes active billing items and creates an invoice. These invoice items are a copy of your active billing items, and make up the contents of your invoice.
    See Also:
    SoftLayer_Billing_Invoice_Item

    • Field Detail

      • associatedChildren

        @ApiProperty
protected List<Item> associatedChildren
        An Invoice Item's associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.

      • associatedInvoiceItem

        @ApiProperty
protected Item associatedInvoiceItem
        An Invoice Item's associated invoice item. If this is populated, it means this is an orphaned invoice item, but logically belongs to the associated invoice item.

      • billingItem

        @ApiProperty
protected Item billingItem
        An Invoice Item's billing item, from which this item was generated.

      • children

        @ApiProperty
protected List<Item> children
        An Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children.

      • filteredAssociatedChildren

        @ApiProperty
protected List<Item> filteredAssociatedChildren
        An Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.

      • hourlyFlag

        @ApiProperty
protected Boolean hourlyFlag
        Indicating whether this invoice item is billed on an hourly basis.

      • nonZeroAssociatedChildren

        @ApiProperty
protected List<Item> nonZeroAssociatedChildren
        An Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.

      • parent

        @ApiProperty
protected Item parent
        Every item tied to a server should have a parent invoice item which is the server line item. This is how we associate items to a server.

      • product

        @ApiProperty
protected Item product
        The entry in the product catalog that a invoice item is based upon.

      • topLevelProductGroupName

        @ApiProperty
protected String topLevelProductGroupName
        A string representing the name of parent level product group of an invoice item.

      • totalOneTimeAmount

        @ApiProperty
protected BigDecimal totalOneTimeAmount
        An invoice Item's total, including any child invoice items if they exist.

      • totalOneTimeTaxAmount

        @ApiProperty
protected BigDecimal totalOneTimeTaxAmount
        An invoice Item's total, including any child invoice items if they exist.

      • totalRecurringAmount

        @ApiProperty
protected BigDecimal totalRecurringAmount
        An invoice Item's total, including any child invoice items if they exist.

      • totalRecurringTaxAmount

        @ApiProperty
protected BigDecimal totalRecurringTaxAmount
        A Billing Item's total, including any child billing items if they exist.'

      • usageChargeFlag

        @ApiProperty
protected Boolean usageChargeFlag
        Indicating whether this invoice item is for the usage charge.

      • associatedInvoiceItemIdSpecified

        protected boolean associatedInvoiceItemIdSpecified

      • billingItemIdSpecified

        protected boolean billingItemIdSpecified

      • categoryCodeSpecified

        protected boolean categoryCodeSpecified

      • createDateSpecified

        protected boolean createDateSpecified

      • descriptionSpecified

        protected boolean descriptionSpecified

      • domainName

        @ApiProperty(canBeNullOrNotSet=true)
protected String domainName
        The domain name of the invoiced item. This is only used on invoice items whose category is "server".

      • domainNameSpecified

        protected boolean domainNameSpecified

      • hostNameSpecified

        protected boolean hostNameSpecified

      • hourlyRecurringFee

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal hourlyRecurringFee
        The hourly recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD)

      • hourlyRecurringFeeSpecified

        protected boolean hourlyRecurringFeeSpecified

      • idSpecified

        protected boolean idSpecified

      • invoiceIdSpecified

        protected boolean invoiceIdSpecified

      • laborAfterTaxAmountSpecified

        protected boolean laborAfterTaxAmountSpecified

      • laborFeeSpecified

        protected boolean laborFeeSpecified

      • laborFeeTaxRateSpecified

        protected boolean laborFeeTaxRateSpecified

      • laborTaxAmountSpecified

        protected boolean laborTaxAmountSpecified

      • notes

        @ApiProperty(canBeNullOrNotSet=true)
protected String notes
        A note to help describe more about the item. This normally holds usernames, or some other bit of extra information.

      • notesSpecified

        protected boolean notesSpecified

      • oneTimeAfterTaxAmount

        @ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal oneTimeAfterTaxAmount
        An invoice 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
        If there are any one-time charges assessed, it will show up here represented by a floating point decimal in US Dollars ($USD)

      • oneTimeFeeSpecified

        protected boolean oneTimeFeeSpecified

      • oneTimeFeeTaxRateSpecified

        protected boolean oneTimeFeeTaxRateSpecified

      • oneTimeTaxAmountSpecified

        protected boolean oneTimeTaxAmountSpecified

      • parentIdSpecified

        protected boolean parentIdSpecified

      • productItemIdSpecified

        protected boolean productItemIdSpecified

      • recurringAfterTaxAmount

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

      • recurringAfterTaxAmountSpecified

        protected boolean recurringAfterTaxAmountSpecified

      • recurringFeeSpecified

        protected boolean recurringFeeSpecified

      • recurringFeeTaxRateSpecified

        protected boolean recurringFeeTaxRateSpecified

      • recurringTaxAmountSpecified

        protected boolean recurringTaxAmountSpecified

      • resourceTableId

        @ApiProperty(canBeNullOrNotSet=true)
protected Long resourceTableId
        A unique identifier for a SoftLayer Service that is associated to an invoice item.

      • resourceTableIdSpecified

        protected boolean resourceTableIdSpecified

      • serviceProviderIdSpecified

        protected boolean serviceProviderIdSpecified

      • setupAfterTaxAmountSpecified

        protected boolean setupAfterTaxAmountSpecified

      • setupFeeSpecified

        protected boolean setupFeeSpecified

      • setupFeeDeferralMonthsSpecified

        protected boolean setupFeeDeferralMonthsSpecified

      • setupFeeTaxRateSpecified

        protected boolean setupFeeTaxRateSpecified

      • setupTaxAmountSpecified

        protected boolean setupTaxAmountSpecified

      • associatedChildrenCount

        @ApiProperty
protected Long associatedChildrenCount
        A count of an Invoice Item's associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.

      • childrenCount

        @ApiProperty
protected Long childrenCount
        A count of an Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children.

      • filteredAssociatedChildrenCount

        @ApiProperty
protected Long filteredAssociatedChildrenCount
        A count of an Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.

      • nonZeroAssociatedChildrenCount

        @ApiProperty
protected Long nonZeroAssociatedChildrenCount
        A count of an Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.

    • Constructor Detail

      • Item

        public Item()

    • Method Detail

      • getAssociatedChildren

        public List<Item> getAssociatedChildren()

      • getAssociatedInvoiceItem

        public Item getAssociatedInvoiceItem()

      • setAssociatedInvoiceItem

        public void setAssociatedInvoiceItem​(Item associatedInvoiceItem)

      • getBillingItem

        public Item getBillingItem()

      • setBillingItem

        public void setBillingItem​(Item billingItem)

      • getCategory

        public Category getCategory()

      • setCategory

        public void setCategory​(Category category)

      • getChildren

        public List<Item> getChildren()

      • getFilteredAssociatedChildren

        public List<Item> getFilteredAssociatedChildren()

      • getHourlyFlag

        public Boolean getHourlyFlag()

      • setHourlyFlag

        public void setHourlyFlag​(Boolean hourlyFlag)

      • getInvoice

        public Invoice getInvoice()

      • setInvoice

        public void setInvoice​(Invoice invoice)

      • getLocation

        public Location getLocation()

      • setLocation

        public void setLocation​(Location location)

      • getNonZeroAssociatedChildren

        public List<Item> getNonZeroAssociatedChildren()

      • getParent

        public Item getParent()

      • setParent

        public void setParent​(Item parent)

      • getProduct

        public Item getProduct()

      • setProduct

        public void setProduct​(Item product)

      • getTopLevelProductGroupName

        public String getTopLevelProductGroupName()

      • setTopLevelProductGroupName

        public void setTopLevelProductGroupName​(String topLevelProductGroupName)

      • getTotalOneTimeAmount

        public BigDecimal getTotalOneTimeAmount()

      • setTotalOneTimeAmount

        public void setTotalOneTimeAmount​(BigDecimal totalOneTimeAmount)

      • getTotalOneTimeTaxAmount

        public BigDecimal getTotalOneTimeTaxAmount()

      • setTotalOneTimeTaxAmount

        public void setTotalOneTimeTaxAmount​(BigDecimal totalOneTimeTaxAmount)

      • getTotalRecurringAmount

        public BigDecimal getTotalRecurringAmount()

      • setTotalRecurringAmount

        public void setTotalRecurringAmount​(BigDecimal totalRecurringAmount)

      • getTotalRecurringTaxAmount

        public BigDecimal getTotalRecurringTaxAmount()

      • setTotalRecurringTaxAmount

        public void setTotalRecurringTaxAmount​(BigDecimal totalRecurringTaxAmount)

      • getUsageChargeFlag

        public Boolean getUsageChargeFlag()

      • setUsageChargeFlag

        public void setUsageChargeFlag​(Boolean usageChargeFlag)

      • getAssociatedInvoiceItemId

        public Long getAssociatedInvoiceItemId()

      • setAssociatedInvoiceItemId

        public void setAssociatedInvoiceItemId​(Long associatedInvoiceItemId)

      • isAssociatedInvoiceItemIdSpecified

        public boolean isAssociatedInvoiceItemIdSpecified()

      • unsetAssociatedInvoiceItemId

        public void unsetAssociatedInvoiceItemId()

      • getBillingItemId

        public Long getBillingItemId()

      • setBillingItemId

        public void setBillingItemId​(Long billingItemId)

      • isBillingItemIdSpecified

        public boolean isBillingItemIdSpecified()

      • unsetBillingItemId

        public void unsetBillingItemId()

      • getCategoryCode

        public String getCategoryCode()

      • setCategoryCode

        public void setCategoryCode​(String categoryCode)

      • isCategoryCodeSpecified

        public boolean isCategoryCodeSpecified()

      • unsetCategoryCode

        public void unsetCategoryCode()

      • isCreateDateSpecified

        public boolean isCreateDateSpecified()

      • unsetCreateDate

        public void unsetCreateDate()

      • 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()

      • getInvoiceId

        public Long getInvoiceId()

      • setInvoiceId

        public void setInvoiceId​(Long invoiceId)

      • isInvoiceIdSpecified

        public boolean isInvoiceIdSpecified()

      • unsetInvoiceId

        public void unsetInvoiceId()

      • 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()

      • getNotes

        public String getNotes()

      • setNotes

        public void setNotes​(String notes)

      • isNotesSpecified

        public boolean isNotesSpecified()

      • unsetNotes

        public void unsetNotes()

      • 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()

      • getProductItemId

        public Long getProductItemId()

      • setProductItemId

        public void setProductItemId​(Long productItemId)

      • isProductItemIdSpecified

        public boolean isProductItemIdSpecified()

      • unsetProductItemId

        public void unsetProductItemId()

      • 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()

      • getRecurringFeeTaxRate

        public BigDecimal getRecurringFeeTaxRate()

      • setRecurringFeeTaxRate

        public void setRecurringFeeTaxRate​(BigDecimal recurringFeeTaxRate)

      • isRecurringFeeTaxRateSpecified

        public boolean isRecurringFeeTaxRateSpecified()

      • unsetRecurringFeeTaxRate

        public void unsetRecurringFeeTaxRate()

      • getRecurringTaxAmount

        public BigDecimal getRecurringTaxAmount()

      • setRecurringTaxAmount

        public void setRecurringTaxAmount​(BigDecimal recurringTaxAmount)

      • isRecurringTaxAmountSpecified

        public boolean isRecurringTaxAmountSpecified()

      • unsetRecurringTaxAmount

        public void unsetRecurringTaxAmount()

      • getResourceTableId

        public Long getResourceTableId()

      • setResourceTableId

        public void setResourceTableId​(Long resourceTableId)

      • isResourceTableIdSpecified

        public boolean isResourceTableIdSpecified()

      • unsetResourceTableId

        public void unsetResourceTableId()

      • getServiceProviderId

        public Long getServiceProviderId()

      • setServiceProviderId

        public void setServiceProviderId​(Long serviceProviderId)

      • isServiceProviderIdSpecified

        public boolean isServiceProviderIdSpecified()

      • unsetServiceProviderId

        public void unsetServiceProviderId()

      • 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()

      • getAssociatedChildrenCount

        public Long getAssociatedChildrenCount()

      • setAssociatedChildrenCount

        public void setAssociatedChildrenCount​(Long associatedChildrenCount)

      • getChildrenCount

        public Long getChildrenCount()

      • setChildrenCount

        public void setChildrenCount​(Long childrenCount)

      • getFilteredAssociatedChildrenCount

        public Long getFilteredAssociatedChildrenCount()

      • setFilteredAssociatedChildrenCount

        public void setFilteredAssociatedChildrenCount​(Long filteredAssociatedChildrenCount)

      • getNonZeroAssociatedChildrenCount

        public Long getNonZeroAssociatedChildrenCount()

      • setNonZeroAssociatedChildrenCount

        public void setNonZeroAssociatedChildrenCount​(Long nonZeroAssociatedChildrenCount)