Class Item
java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.billing.invoice.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
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Item.Mask
static interface
Item.Service
Every invoice item is defined in the SoftLayer_Billing_Invoice_Item service.static interface
Item.ServiceAsync
-
Field Summary
Fields Modifier and Type Field Description protected List<Item>
associatedChildren
An Invoice Item's associated child invoice items.protected Long
associatedChildrenCount
A count of an Invoice Item's associated child invoice items.protected Item
associatedInvoiceItem
An Invoice Item's associated invoice item.protected Long
associatedInvoiceItemId
The associated invoice Item ID.protected boolean
associatedInvoiceItemIdSpecified
protected Item
billingItem
An Invoice Item's billing item, from which this item was generated.protected Long
billingItemId
The billing item from which this invoice item was generated.protected boolean
billingItemIdSpecified
protected Category
category
This invoice item's "item category".protected String
categoryCode
The item category of the invoice item being invoiced.protected boolean
categoryCodeSpecified
protected List<Item>
children
An Invoice Item's child invoice items.protected Long
childrenCount
A count of an Invoice Item's child invoice items.protected GregorianCalendar
createDate
The date the invoice item was created.protected boolean
createDateSpecified
protected String
description
The item description for this invoice item.protected boolean
descriptionSpecified
protected String
domainName
The domain name of the invoiced item.protected boolean
domainNameSpecified
protected List<Item>
filteredAssociatedChildren
An Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee.protected Long
filteredAssociatedChildrenCount
A count of an Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee.protected String
hostName
The Host name of the invoiced item.protected boolean
hostNameSpecified
protected Boolean
hourlyFlag
Indicating whether this invoice item is billed on an hourly basis.protected BigDecimal
hourlyRecurringFee
The hourly recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD)protected boolean
hourlyRecurringFeeSpecified
protected Long
id
The ID of the invoice item.protected boolean
idSpecified
protected Invoice
invoice
The invoice to which this item belongs.protected Long
invoiceId
The invoice to which this invoice item belongs.protected boolean
invoiceIdSpecified
protected BigDecimal
laborAfterTaxAmount
An invoice item's labor fee total after taxes.protected boolean
laborAfterTaxAmountSpecified
protected BigDecimal
laborFee
This also a one-time fee of a special type.protected boolean
laborFeeSpecified
protected BigDecimal
laborFeeTaxRate
The tax rate at which the labor fee is taxed.protected boolean
laborFeeTaxRateSpecified
protected BigDecimal
laborTaxAmount
An invoice item's labor tax amount.protected boolean
laborTaxAmountSpecified
protected Location
location
An invoice item's location, if one exists.'protected List<Item>
nonZeroAssociatedChildren
An Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee.protected Long
nonZeroAssociatedChildrenCount
A count of an Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee.protected String
notes
A note to help describe more about the item.protected boolean
notesSpecified
protected BigDecimal
oneTimeAfterTaxAmount
An invoice item's one-time fee total after taxes.protected boolean
oneTimeAfterTaxAmountSpecified
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)protected boolean
oneTimeFeeSpecified
protected BigDecimal
oneTimeFeeTaxRate
The rate at which the one-time fee is taxed.protected boolean
oneTimeFeeTaxRateSpecified
protected BigDecimal
oneTimeTaxAmount
An invoice item's one-time tax amount.protected boolean
oneTimeTaxAmountSpecified
protected Item
parent
Every item tied to a server should have a parent invoice item which is the server line item.protected Long
parentId
The parent invoice item, usually the server invoice item.protected boolean
parentIdSpecified
protected Item
product
The entry in the product catalog that a invoice item is based upon.protected Long
productItemId
The entry in the product catalog that a invoice item is based upon.protected boolean
productItemIdSpecified
protected BigDecimal
recurringAfterTaxAmount
An invoice item's recurring fee total after taxes.protected boolean
recurringAfterTaxAmountSpecified
protected BigDecimal
recurringFee
The recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD)protected boolean
recurringFeeSpecified
protected BigDecimal
recurringFeeTaxRate
the rate at which the recurring fee is taxed.protected boolean
recurringFeeTaxRateSpecified
protected BigDecimal
recurringTaxAmount
An invoice item's recurring tax amount.protected boolean
recurringTaxAmountSpecified
protected Long
resourceTableId
A unique identifier for a SoftLayer Service that is associated to an invoice item.protected boolean
resourceTableIdSpecified
protected Long
serviceProviderId
The service provider for the invoice item.protected boolean
serviceProviderIdSpecified
protected BigDecimal
setupAfterTaxAmount
An invoice item's setup fee total after taxes.protected boolean
setupAfterTaxAmountSpecified
protected BigDecimal
setupFee
If there were any setup fees they will show up here.protected Long
setupFeeDeferralMonths
The number of months the setup fee is being deferred.protected boolean
setupFeeDeferralMonthsSpecified
protected boolean
setupFeeSpecified
protected BigDecimal
setupFeeTaxRate
The tax rate at which the setup fee is taxed.protected boolean
setupFeeTaxRateSpecified
protected BigDecimal
setupTaxAmount
An invoice item's setup tax amount.protected boolean
setupTaxAmountSpecified
protected String
topLevelProductGroupName
A string representing the name of parent level product group of an invoice item.protected BigDecimal
totalOneTimeAmount
An invoice Item's total, including any child invoice items if they exist.protected BigDecimal
totalOneTimeTaxAmount
An invoice Item's total, including any child invoice items if they exist.protected BigDecimal
totalRecurringAmount
An invoice Item's total, including any child invoice items if they exist.protected BigDecimal
totalRecurringTaxAmount
A Billing Item's total, including any child billing items if they exist.'protected Boolean
usageChargeFlag
Indicating whether this invoice item is for the usage charge.Fields inherited from class com.softlayer.api.Type
unknownProperties
-
Constructor Summary
Constructors Constructor Description Item()
-
Method Summary
Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties
-
Field Details
-
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
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
An Invoice Item's billing item, from which this item was generated. -
category
This invoice item's "item category". -
children
An Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children. -
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
Indicating whether this invoice item is billed on an hourly basis. -
invoice
The invoice to which this item belongs. -
location
An invoice item's location, if one exists.' -
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
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
The entry in the product catalog that a invoice item is based upon. -
topLevelProductGroupName
A string representing the name of parent level product group of an invoice item. -
totalOneTimeAmount
An invoice Item's total, including any child invoice items if they exist. -
totalOneTimeTaxAmount
An invoice Item's total, including any child invoice items if they exist. -
totalRecurringAmount
An invoice Item's total, including any child invoice items if they exist. -
totalRecurringTaxAmount
A Billing Item's total, including any child billing items if they exist.' -
usageChargeFlag
Indicating whether this invoice item is for the usage charge. -
associatedInvoiceItemId
The associated invoice Item ID. -
associatedInvoiceItemIdSpecified
protected boolean associatedInvoiceItemIdSpecified -
billingItemId
The billing item from which this invoice item was generated. -
billingItemIdSpecified
protected boolean billingItemIdSpecified -
categoryCode
The item category of the invoice item being invoiced. -
categoryCodeSpecified
protected boolean categoryCodeSpecified -
createDate
The date the invoice item was created. -
createDateSpecified
protected boolean createDateSpecified -
description
The item description for this invoice item. -
descriptionSpecified
protected boolean descriptionSpecified -
domainName
The domain name of the invoiced item. This is only used on invoice items whose category is "server". -
domainNameSpecified
protected boolean domainNameSpecified -
hostName
The Host name of the invoiced item. This is only used on invoice items whose category is "server". -
hostNameSpecified
protected boolean hostNameSpecified -
hourlyRecurringFee
The hourly recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD) -
hourlyRecurringFeeSpecified
protected boolean hourlyRecurringFeeSpecified -
id
The ID of the invoice item. -
idSpecified
protected boolean idSpecified -
invoiceId
The invoice to which this invoice item belongs. -
invoiceIdSpecified
protected boolean invoiceIdSpecified -
laborAfterTaxAmount
An invoice item's labor fee total after taxes. This does not include any child invoice items. -
laborAfterTaxAmountSpecified
protected boolean laborAfterTaxAmountSpecified -
laborFee
This also a one-time fee of a special type. -
laborFeeSpecified
protected boolean laborFeeSpecified -
laborFeeTaxRate
The tax rate at which the labor fee is taxed. -
laborFeeTaxRateSpecified
protected boolean laborFeeTaxRateSpecified -
laborTaxAmount
An invoice item's labor tax amount. This does not include any child invoice items. -
laborTaxAmountSpecified
protected boolean laborTaxAmountSpecified -
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
An invoice item's one-time fee total after taxes. This does not include any child invoice items. -
oneTimeAfterTaxAmountSpecified
protected boolean oneTimeAfterTaxAmountSpecified -
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 -
oneTimeFeeTaxRate
The rate at which the one-time fee is taxed. -
oneTimeFeeTaxRateSpecified
protected boolean oneTimeFeeTaxRateSpecified -
oneTimeTaxAmount
An invoice item's one-time tax amount. This does not include any child invoice items. -
oneTimeTaxAmountSpecified
protected boolean oneTimeTaxAmountSpecified -
parentId
The parent invoice item, usually the server invoice item. -
parentIdSpecified
protected boolean parentIdSpecified -
productItemId
The entry in the product catalog that a invoice item is based upon. -
productItemIdSpecified
protected boolean productItemIdSpecified -
recurringAfterTaxAmount
An invoice item's recurring fee total after taxes. This does not include any child invoice items. -
recurringAfterTaxAmountSpecified
protected boolean recurringAfterTaxAmountSpecified -
recurringFee
The recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD) -
recurringFeeSpecified
protected boolean recurringFeeSpecified -
recurringFeeTaxRate
the rate at which the recurring fee is taxed. -
recurringFeeTaxRateSpecified
protected boolean recurringFeeTaxRateSpecified -
recurringTaxAmount
An invoice item's recurring tax amount. This does not include any child invoice items. -
recurringTaxAmountSpecified
protected boolean recurringTaxAmountSpecified -
resourceTableId
A unique identifier for a SoftLayer Service that is associated to an invoice item. -
resourceTableIdSpecified
protected boolean resourceTableIdSpecified -
serviceProviderId
The service provider for the invoice item. -
serviceProviderIdSpecified
protected boolean serviceProviderIdSpecified -
setupAfterTaxAmount
An invoice item's setup fee total after taxes. This does not include any child invoice items. -
setupAfterTaxAmountSpecified
protected boolean setupAfterTaxAmountSpecified -
setupFee
If there were any setup fees they will show up here. These are normally a one-time fee. -
setupFeeSpecified
protected boolean setupFeeSpecified -
setupFeeDeferralMonths
The number of months the setup fee is being deferred. -
setupFeeDeferralMonthsSpecified
protected boolean setupFeeDeferralMonthsSpecified -
setupFeeTaxRate
The tax rate at which the setup fee is taxed. -
setupFeeTaxRateSpecified
protected boolean setupFeeTaxRateSpecified -
setupTaxAmount
An invoice item's setup tax amount. This does not include any child invoice items. -
setupTaxAmountSpecified
protected boolean setupTaxAmountSpecified -
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
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
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
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 Details
-
Item
public Item()
-
-
Method Details
-
getAssociatedChildren
-
getAssociatedInvoiceItem
-
setAssociatedInvoiceItem
-
getBillingItem
-
setBillingItem
-
getCategory
-
setCategory
-
getChildren
-
getFilteredAssociatedChildren
-
getHourlyFlag
-
setHourlyFlag
-
getInvoice
-
setInvoice
-
getLocation
-
setLocation
-
getNonZeroAssociatedChildren
-
getParent
-
setParent
-
getProduct
-
setProduct
-
getTopLevelProductGroupName
-
setTopLevelProductGroupName
-
getTotalOneTimeAmount
-
setTotalOneTimeAmount
-
getTotalOneTimeTaxAmount
-
setTotalOneTimeTaxAmount
-
getTotalRecurringAmount
-
setTotalRecurringAmount
-
getTotalRecurringTaxAmount
-
setTotalRecurringTaxAmount
-
getUsageChargeFlag
-
setUsageChargeFlag
-
getAssociatedInvoiceItemId
-
setAssociatedInvoiceItemId
-
isAssociatedInvoiceItemIdSpecified
public boolean isAssociatedInvoiceItemIdSpecified() -
unsetAssociatedInvoiceItemId
public void unsetAssociatedInvoiceItemId() -
getBillingItemId
-
setBillingItemId
-
isBillingItemIdSpecified
public boolean isBillingItemIdSpecified() -
unsetBillingItemId
public void unsetBillingItemId() -
getCategoryCode
-
setCategoryCode
-
isCategoryCodeSpecified
public boolean isCategoryCodeSpecified() -
unsetCategoryCode
public void unsetCategoryCode() -
getCreateDate
-
setCreateDate
-
isCreateDateSpecified
public boolean isCreateDateSpecified() -
unsetCreateDate
public void unsetCreateDate() -
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() -
getInvoiceId
-
setInvoiceId
-
isInvoiceIdSpecified
public boolean isInvoiceIdSpecified() -
unsetInvoiceId
public void unsetInvoiceId() -
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() -
getNotes
-
setNotes
-
isNotesSpecified
public boolean isNotesSpecified() -
unsetNotes
public void unsetNotes() -
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() -
getProductItemId
-
setProductItemId
-
isProductItemIdSpecified
public boolean isProductItemIdSpecified() -
unsetProductItemId
public void unsetProductItemId() -
getRecurringAfterTaxAmount
-
setRecurringAfterTaxAmount
-
isRecurringAfterTaxAmountSpecified
public boolean isRecurringAfterTaxAmountSpecified() -
unsetRecurringAfterTaxAmount
public void unsetRecurringAfterTaxAmount() -
getRecurringFee
-
setRecurringFee
-
isRecurringFeeSpecified
public boolean isRecurringFeeSpecified() -
unsetRecurringFee
public void unsetRecurringFee() -
getRecurringFeeTaxRate
-
setRecurringFeeTaxRate
-
isRecurringFeeTaxRateSpecified
public boolean isRecurringFeeTaxRateSpecified() -
unsetRecurringFeeTaxRate
public void unsetRecurringFeeTaxRate() -
getRecurringTaxAmount
-
setRecurringTaxAmount
-
isRecurringTaxAmountSpecified
public boolean isRecurringTaxAmountSpecified() -
unsetRecurringTaxAmount
public void unsetRecurringTaxAmount() -
getResourceTableId
-
setResourceTableId
-
isResourceTableIdSpecified
public boolean isResourceTableIdSpecified() -
unsetResourceTableId
public void unsetResourceTableId() -
getServiceProviderId
-
setServiceProviderId
-
isServiceProviderIdSpecified
public boolean isServiceProviderIdSpecified() -
unsetServiceProviderId
public void unsetServiceProviderId() -
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() -
getAssociatedChildrenCount
-
setAssociatedChildrenCount
-
getChildrenCount
-
setChildrenCount
-
getFilteredAssociatedChildrenCount
-
setFilteredAssociatedChildrenCount
-
getNonZeroAssociatedChildrenCount
-
setNonZeroAssociatedChildrenCount
-
asService
-
service
-
service
-