Interface Item.Service
-
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- Enclosing class:
- Item
@ApiService("SoftLayer_Billing_Invoice_Item") public static interface Item.Service extends Service
Every invoice item is defined in the SoftLayer_Billing_Invoice_Item service. Softlayer billing invoice items have details about the items that reside within an invoice. These items detail, for instance, the recurring and one time charges for each item billed.- See Also:
- SoftLayer_Billing_Invoice_Item
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Item.ServiceAsync
asAsync()
Get an async version of this serviceList<Item>
getAssociatedChildren()
An Invoice Item's associated child invoice items.Item
getAssociatedInvoiceItem()
An Invoice Item's associated invoice item.Item
getBillingItem()
An Invoice Item's billing item, from which this item was generated.Category
getCategory()
This invoice item's "item category".List<Item>
getChildren()
An Invoice Item's child invoice items.List<Item>
getFilteredAssociatedChildren()
An Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee.Boolean
getHourlyFlag()
Indicating whether this invoice item is billed on an hourly basis.Invoice
getInvoice()
The invoice to which this item belongs.Location
getLocation()
An invoice item's location, if one exists.'List<Item>
getNonZeroAssociatedChildren()
An Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee.Item
getObject()
getObject retrieves the SoftLayer_Billing_Invoice_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Invoice_Item service.Item
getParent()
Every item tied to a server should have a parent invoice item which is the server line item.Item
getProduct()
The entry in the product catalog that a invoice item is based upon.String
getTopLevelProductGroupName()
A string representing the name of parent level product group of an invoice item.BigDecimal
getTotalOneTimeAmount()
An invoice Item's total, including any child invoice items if they exist.BigDecimal
getTotalOneTimeTaxAmount()
An invoice Item's total, including any child invoice items if they exist.BigDecimal
getTotalRecurringAmount()
An invoice Item's total, including any child invoice items if they exist.BigDecimal
getTotalRecurringTaxAmount()
A Billing Item's total, including any child billing items if they exist.'Boolean
getUsageChargeFlag()
Indicating whether this invoice item is for the usage charge.void
setMask(Item.Mask mask)
Item.Mask
withMask()
Use the existing mask on this service or create it if not presentItem.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return it-
Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
-
-
-
Method Detail
-
asAsync
Item.ServiceAsync asAsync()
Description copied from interface:Service
Get an async version of this service
-
withNewMask
Item.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 interfaceMaskable
-
withMask
Item.Mask withMask()
Description copied from interface:Maskable
Use the existing mask on this service or create it if not present
-
setMask
void setMask(Item.Mask mask)
-
getObject
@ApiMethod(instanceRequired=true) Item getObject()
getObject retrieves the SoftLayer_Billing_Invoice_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Invoice_Item service. You can only retrieve the items tied to the account that your portal user is assigned to.
-
getAssociatedChildren
@ApiMethod(instanceRequired=true) List<Item> getAssociatedChildren()
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.
-
getAssociatedInvoiceItem
@ApiMethod(instanceRequired=true) Item getAssociatedInvoiceItem()
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.
-
getBillingItem
@ApiMethod(instanceRequired=true) Item getBillingItem()
An Invoice Item's billing item, from which this item was generated.
-
getCategory
@ApiMethod(instanceRequired=true) Category getCategory()
This invoice item's "item category".
-
getChildren
@ApiMethod(instanceRequired=true) List<Item> getChildren()
An Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children.
-
getFilteredAssociatedChildren
@ApiMethod(instanceRequired=true) List<Item> getFilteredAssociatedChildren()
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.
-
getHourlyFlag
@ApiMethod(instanceRequired=true) Boolean getHourlyFlag()
Indicating whether this invoice item is billed on an hourly basis.
-
getInvoice
@ApiMethod(instanceRequired=true) Invoice getInvoice()
The invoice to which this item belongs.
-
getLocation
@ApiMethod(instanceRequired=true) Location getLocation()
An invoice item's location, if one exists.'
-
getNonZeroAssociatedChildren
@ApiMethod(instanceRequired=true) List<Item> getNonZeroAssociatedChildren()
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.
-
getParent
@ApiMethod(instanceRequired=true) Item getParent()
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.
-
getProduct
@ApiMethod(instanceRequired=true) Item getProduct()
The entry in the product catalog that a invoice item is based upon.
-
getTopLevelProductGroupName
@ApiMethod(instanceRequired=true) String getTopLevelProductGroupName()
A string representing the name of parent level product group of an invoice item.
-
getTotalOneTimeAmount
@ApiMethod(instanceRequired=true) BigDecimal getTotalOneTimeAmount()
An invoice Item's total, including any child invoice items if they exist.
-
getTotalOneTimeTaxAmount
@ApiMethod(instanceRequired=true) BigDecimal getTotalOneTimeTaxAmount()
An invoice Item's total, including any child invoice items if they exist.
-
getTotalRecurringAmount
@ApiMethod(instanceRequired=true) BigDecimal getTotalRecurringAmount()
An invoice Item's total, including any child invoice items if they exist.
-
getTotalRecurringTaxAmount
@ApiMethod(instanceRequired=true) BigDecimal getTotalRecurringTaxAmount()
A Billing Item's total, including any child billing items if they exist.'
-
getUsageChargeFlag
@ApiMethod(instanceRequired=true) Boolean getUsageChargeFlag()
Indicating whether this invoice item is for the usage charge.
-
-