Class Item
- java.lang.Object
-
- com.softlayer.api.Type
-
- com.softlayer.api.service.Entity
-
- com.softlayer.api.service.billing.Item
-
- Direct Known Subclasses:
Account
,Addon
,Bandwidth
,Billing
,Binding
,Cloud
,Cluster
,Component
,Component
,Context
,Controller
,ControlPanel
,DedicatedHost
,Delivery
,Firewall
,Global
,Guest
,Hardware
,Image
,Interconnect
,License
,LoadBalancer
,NewCustomerSetup
,OperatingSystem
,Rack
,Request
,ReservedCapacity
,Storage
,Subnet
,Support
,Tunnel
,Urchin
,Usage
,VirtualIpAddress
,VirtualIpAddress
,Vlan
,Workspace
@ApiType("SoftLayer_Billing_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_Item
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Item.Mask
static interface
Item.Service
Every individual item that a SoftLayer customer is billed for is recorded in the SoftLayer_Billing_Item data type.static interface
Item.ServiceAsync
-
Field Summary
Fields Modifier and Type Field Description protected Account
account
The account that a billing item belongs to.protected Agreement
activeAgreement
protected Agreement
activeAgreementFlag
A flag indicating that the billing item is under an active agreement.protected List<Item>
activeAssociatedChildren
A billing item's active associated child billing items.protected Long
activeAssociatedChildrenCount
A count of a billing item's active associated child billing items.protected Long
activeAssociatedGuestDiskBillingItemCount
A count ofprotected List<Item>
activeAssociatedGuestDiskBillingItems
protected Long
activeBundledItemCount
A count of a Billing Item's active bundled billing items.protected List<Item>
activeBundledItems
A Billing Item's active bundled billing items.protected Item
activeCancellationItem
A service cancellation request item that corresponds to the billing item.protected List<Item>
activeChildren
A Billing Item's active child billing items.protected Long
activeChildrenCount
A count of a Billing Item's active child billing items.protected Boolean
activeFlag
protected Long
activeSparePoolAssociatedGuestDiskBillingItemCount
A count ofprotected List<Item>
activeSparePoolAssociatedGuestDiskBillingItems
protected Long
activeSparePoolBundledItemCount
A count of a Billing Item's spare pool bundled billing items.protected List<Item>
activeSparePoolBundledItems
A Billing Item's spare pool bundled billing items.protected Long
allowCancellationFlag
Flag to check if a billing item can be cancelled.protected boolean
allowCancellationFlagSpecified
protected Item
associatedBillingItem
A billing item's associated parent.protected List<History>
associatedBillingItemHistory
A history of billing items which a billing item has been associated with.protected Long
associatedBillingItemHistoryCount
A count of a history of billing items which a billing item has been associated with.protected String
associatedBillingItemId
This is sometimes populated for orphan billing items that are not attached to servers.protected boolean
associatedBillingItemIdSpecified
protected List<Item>
associatedChildren
A Billing Item's associated child billing items.protected Long
associatedChildrenCount
A count of a Billing Item's associated child billing items.protected List<Item>
associatedParent
A billing item's associated parent billing item.protected Long
associatedParentCount
A count of a billing item's associated parent billing item.protected Long
availableMatchingVlanCount
A count ofprotected List<Vlan>
availableMatchingVlans
protected Allocation
bandwidthAllocation
The bandwidth allocation for a billing item.protected List<Item>
billableChildren
A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.protected Long
billableChildrenCount
A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future.protected Long
bundledItemCount
A count of a Billing Item's bundled billing items'protected List<Item>
bundledItems
A Billing Item's bundled billing items'protected Long
bundleItemCount
A count of a Billing Item's bundled billing itemsprotected List<Bundles>
bundleItems
A Billing Item's bundled billing itemsprotected List<Item>
canceledChildren
A Billing Item's active child billing items.protected Long
canceledChildrenCount
A count of a Billing Item's active child billing items.protected GregorianCalendar
cancellationDate
A billing item's cancellation date.protected boolean
cancellationDateSpecified
protected Reason
cancellationReason
The billing item's cancellation reason.protected Long
cancellationRequestCount
A count of this will return any cancellation requests that are associated with this billing item.protected List<Request>
cancellationRequests
This will return any cancellation requests that are associated with this billing item.protected Category
category
The item category to which the billing item's item belongs.protected String
categoryCode
The category code of this billing item.protected boolean
categoryCodeSpecified
protected List<Item>
children
A Billing Item's child billing items'protected Long
childrenCount
A count of a Billing Item's child billing items'protected List<Item>
childrenWithActiveAgreement
A Billing Item's active child billing items.protected Long
childrenWithActiveAgreementCount
A count of a Billing Item's active child billing items.protected GregorianCalendar
createDate
The date the billing item was created.protected boolean
createDateSpecified
protected String
currentHourlyCharge
This is the total charge for the billing item for this billing item.protected boolean
currentHourlyChargeSpecified
protected GregorianCalendar
cycleStartDate
The last time this billing item was charged.protected boolean
cycleStartDateSpecified
protected String
description
A brief description of a billing item.protected boolean
descriptionSpecified
protected String
domainName
The domain name is provided for server billing items.protected boolean
domainNameSpecified
protected Long
downgradeItemCount
A count of for product items which have a downgrade path defined, this will return those product items.protected List<Item>
downgradeItems
For product items which have a downgrade path defined, this will return those product items.protected List<Item>
filteredNextInvoiceChildren
A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.protected Long
filteredNextInvoiceChildrenCount
A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.protected String
hostName
The hostname is provided for server billing itemsprotected boolean
hostNameSpecified
protected Boolean
hourlyFlag
A flag that will reflect whether this billing item is billed on an hourly basis or not.protected BigDecimal
hourlyRecurringFee
The amount of money charged per hour for a billing item, if applicable.protected boolean
hourlyRecurringFeeSpecified
protected String
hoursUsed
This is the number of hours the hourly billing item has been in use this billing period.protected boolean
hoursUsedSpecified
protected Long
id
The unique identifier for this billing item.protected boolean
idSpecified
protected Item
invoiceItem
Invoice items associated with this billing itemprotected Long
invoiceItemCount
A count of all invoice items associated with the billing itemprotected List<Item>
invoiceItems
All invoice items associated with the billing itemprotected Item
item
The entry in the SoftLayer product catalog that a billing item is based upon.protected Package
itemPackage
The package under which this billing item was sold.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 GregorianCalendar
lastBillDate
The last time this billing item was charged.protected boolean
lastBillDateSpecified
protected Location
location
The location of the billing item.protected GregorianCalendar
modifyDate
The date that a billing item was last modified.protected boolean
modifyDateSpecified
protected GregorianCalendar
nextBillDate
The date on which your account will be charged for this billing item.protected boolean
nextBillDateSpecified
protected List<Item>
nextInvoiceChildren
A Billing Item's child billing items and associated items'protected Long
nextInvoiceChildrenCount
A count of a Billing Item's child billing items and associated items'protected BigDecimal
nextInvoiceTotalOneTimeAmount
A Billing Item's total, including any child billing items if they exist.'protected BigDecimal
nextInvoiceTotalOneTimeTaxAmount
A Billing Item's total, including any child billing items if they exist.'protected BigDecimal
nextInvoiceTotalRecurringAmount
A Billing Item's total, including any child billing items and associated billing items if they exist.'protected BigDecimal
nextInvoiceTotalRecurringTaxAmount
This is deprecated and will always be zero.protected List<Item>
nonZeroNextInvoiceChildren
A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.protected Long
nonZeroNextInvoiceChildrenCount
A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.protected String
notes
Extra information provided to help you identify this billing item.protected boolean
notesSpecified
protected BigDecimal
oneTimeFee
The amount of money charged as a one-time charge for a billing 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 Item
orderItem
A billing item's original order item.protected Long
orderItemId
the SoftLayer_Billing_Order_Item ID.protected boolean
orderItemIdSpecified
protected Location
originalLocation
The original physical location for this billing item--may differ from current.protected Item
parent
A billing item's parent item.protected Long
parentId
The unique identifier of the parent of this billing item.protected boolean
parentIdSpecified
protected Guest
parentVirtualGuestBillingItem
A billing item's parent item.protected Boolean
pendingCancellationFlag
This flag indicates whether a billing item is scheduled to be canceled or not.protected Item
pendingOrderItem
The new order item that will replace this billing item.protected Transaction
provisionTransaction
Provisioning transaction for this billing itemprotected BigDecimal
recurringFee
The amount of money charged per month for a billing item, if applicable.protected boolean
recurringFeeSpecified
protected BigDecimal
recurringFeeTaxRate
The rate at which recurring fees are taxed if you are a taxable customer.protected boolean
recurringFeeTaxRateSpecified
protected Long
recurringMonths
The number of months in which the recurring fees will be incurred.protected boolean
recurringMonthsSpecified
protected Long
serviceProviderId
This is the service provider for this billing item.protected boolean
serviceProviderIdSpecified
protected BigDecimal
setupFee
The setup fee, if any.protected boolean
setupFeeSpecified
protected BigDecimal
setupFeeTaxRate
The rate at which setup fees are taxed if you are a taxable customer.protected boolean
setupFeeTaxRateSpecified
protected Description
softwareDescription
A friendly description of software componentprotected Item
upgradeItem
Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.protected Long
upgradeItemCount
A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.protected List<Item>
upgradeItems
Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.-
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 Detail
-
account
@ApiProperty protected Account account
The account that a billing item belongs to.
-
activeAgreement
@ApiProperty protected Agreement activeAgreement
-
activeAgreementFlag
@ApiProperty protected Agreement activeAgreementFlag
A flag indicating that the billing item is under an active agreement.
-
activeAssociatedChildren
@ApiProperty protected List<Item> activeAssociatedChildren
A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item.
-
activeAssociatedGuestDiskBillingItems
@ApiProperty protected List<Item> activeAssociatedGuestDiskBillingItems
-
activeBundledItems
@ApiProperty protected List<Item> activeBundledItems
A Billing Item's active bundled billing items.
-
activeCancellationItem
@ApiProperty protected Item activeCancellationItem
A service cancellation request item that corresponds to the billing item.
-
activeChildren
@ApiProperty protected List<Item> activeChildren
A Billing Item's active child billing items.
-
activeFlag
@ApiProperty protected Boolean activeFlag
-
activeSparePoolAssociatedGuestDiskBillingItems
@ApiProperty protected List<Item> activeSparePoolAssociatedGuestDiskBillingItems
-
activeSparePoolBundledItems
@ApiProperty protected List<Item> activeSparePoolBundledItems
A Billing Item's spare pool bundled billing items.
-
associatedBillingItem
@ApiProperty protected Item associatedBillingItem
A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item.
-
associatedBillingItemHistory
@ApiProperty protected List<History> associatedBillingItemHistory
A history of billing items which a billing item has been associated with.
-
associatedChildren
@ApiProperty protected List<Item> associatedChildren
A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item.
-
associatedParent
@ApiProperty protected List<Item> associatedParent
A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.
-
availableMatchingVlans
@ApiProperty protected List<Vlan> availableMatchingVlans
-
bandwidthAllocation
@ApiProperty protected Allocation bandwidthAllocation
The bandwidth allocation for a billing item.
-
billableChildren
@ApiProperty protected List<Item> billableChildren
A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.
-
bundleItems
@ApiProperty protected List<Bundles> bundleItems
A Billing Item's bundled billing items
-
bundledItems
@ApiProperty protected List<Item> bundledItems
A Billing Item's bundled billing items'
-
canceledChildren
@ApiProperty protected List<Item> canceledChildren
A Billing Item's active child billing items.
-
cancellationReason
@ApiProperty protected Reason cancellationReason
The billing item's cancellation reason.
-
cancellationRequests
@ApiProperty protected List<Request> cancellationRequests
This will return any cancellation requests that are associated with this billing item.
-
category
@ApiProperty protected Category category
The item category to which the billing item's item belongs.
-
children
@ApiProperty protected List<Item> children
A Billing Item's child billing items'
-
childrenWithActiveAgreement
@ApiProperty protected List<Item> childrenWithActiveAgreement
A Billing Item's active child billing items.
-
downgradeItems
@ApiProperty protected List<Item> downgradeItems
For product items which have a downgrade path defined, this will return those product items.
-
filteredNextInvoiceChildren
@ApiProperty protected List<Item> filteredNextInvoiceChildren
A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.
-
hourlyFlag
@ApiProperty protected Boolean hourlyFlag
A flag that will reflect whether this billing item is billed on an hourly basis or not.
-
invoiceItem
@ApiProperty protected Item invoiceItem
Invoice items associated with this billing item
-
invoiceItems
@ApiProperty protected List<Item> invoiceItems
All invoice items associated with the billing item
-
item
@ApiProperty protected Item item
The entry in the SoftLayer product catalog that a billing item is based upon.
-
location
@ApiProperty protected Location location
The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information.
-
nextInvoiceChildren
@ApiProperty protected List<Item> nextInvoiceChildren
A Billing Item's child billing items and associated items'
-
nextInvoiceTotalOneTimeAmount
@ApiProperty protected BigDecimal nextInvoiceTotalOneTimeAmount
A Billing Item's total, including any child billing items if they exist.'
-
nextInvoiceTotalOneTimeTaxAmount
@ApiProperty protected BigDecimal nextInvoiceTotalOneTimeTaxAmount
A Billing Item's total, including any child billing items if they exist.'
-
nextInvoiceTotalRecurringAmount
@ApiProperty protected BigDecimal nextInvoiceTotalRecurringAmount
A Billing Item's total, including any child billing items and associated billing items if they exist.'
-
nextInvoiceTotalRecurringTaxAmount
@ApiProperty protected BigDecimal nextInvoiceTotalRecurringTaxAmount
This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.
-
nonZeroNextInvoiceChildren
@ApiProperty protected List<Item> nonZeroNextInvoiceChildren
A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
orderItem
@ApiProperty protected Item orderItem
A billing item's original order item. Simply a reference to the original order from which this billing item was created.
-
originalLocation
@ApiProperty protected Location originalLocation
The original physical location for this billing item--may differ from current.
-
itemPackage
@ApiProperty("package") protected Package itemPackage
The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.
-
parent
@ApiProperty protected Item parent
A billing item's parent item. If a billing item has no parent item then this value is null.
-
parentVirtualGuestBillingItem
@ApiProperty protected Guest parentVirtualGuestBillingItem
A billing item's parent item. If a billing item has no parent item then this value is null.
-
pendingCancellationFlag
@ApiProperty protected Boolean pendingCancellationFlag
This flag indicates whether a billing item is scheduled to be canceled or not.
-
pendingOrderItem
@ApiProperty protected Item pendingOrderItem
The new order item that will replace this billing item.
-
provisionTransaction
@ApiProperty protected Transaction provisionTransaction
Provisioning transaction for this billing item
-
softwareDescription
@ApiProperty protected Description softwareDescription
A friendly description of software component
-
upgradeItem
@ApiProperty protected Item upgradeItem
Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.
-
upgradeItems
@ApiProperty protected List<Item> upgradeItems
Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.
-
allowCancellationFlag
@ApiProperty(canBeNullOrNotSet=true) protected Long allowCancellationFlag
Flag to check if a billing item can be cancelled. 1 = yes. 0 = no.
-
allowCancellationFlagSpecified
protected boolean allowCancellationFlagSpecified
-
associatedBillingItemId
@ApiProperty(canBeNullOrNotSet=true) protected String associatedBillingItemId
This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [[SoftLayer_Billing_Item::setAssociationId]]. This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set.
-
associatedBillingItemIdSpecified
protected boolean associatedBillingItemIdSpecified
-
cancellationDate
@ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar cancellationDate
A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle.
-
cancellationDateSpecified
protected boolean cancellationDateSpecified
-
categoryCode
@ApiProperty(canBeNullOrNotSet=true) protected String categoryCode
The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance.
-
categoryCodeSpecified
protected boolean categoryCodeSpecified
-
createDate
@ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar createDate
The date the billing item was created. You can see this date on the invoice.
-
createDateSpecified
protected boolean createDateSpecified
-
currentHourlyCharge
@ApiProperty(canBeNullOrNotSet=true) protected String currentHourlyCharge
This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed.
-
currentHourlyChargeSpecified
protected boolean currentHourlyChargeSpecified
-
cycleStartDate
@ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar cycleStartDate
The last time this billing item was charged.
-
cycleStartDateSpecified
protected boolean cycleStartDateSpecified
-
description
@ApiProperty(canBeNullOrNotSet=true) protected String description
A brief description of a billing item.
-
descriptionSpecified
protected boolean descriptionSpecified
-
domainName
@ApiProperty(canBeNullOrNotSet=true) protected String domainName
The domain name is provided for server billing items.
-
domainNameSpecified
protected boolean domainNameSpecified
-
hostName
@ApiProperty(canBeNullOrNotSet=true) protected String hostName
The hostname is provided for server billing items
-
hostNameSpecified
protected boolean hostNameSpecified
-
hourlyRecurringFee
@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal hourlyRecurringFee
The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD).
-
hourlyRecurringFeeSpecified
protected boolean hourlyRecurringFeeSpecified
-
hoursUsed
@ApiProperty(canBeNullOrNotSet=true) protected String hoursUsed
This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped.
-
hoursUsedSpecified
protected boolean hoursUsedSpecified
-
id
@ApiProperty(canBeNullOrNotSet=true) protected Long id
The unique identifier for this billing item.
-
idSpecified
protected boolean idSpecified
-
laborFee
@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal laborFee
The labor fee, if any. This is a one time charge.
-
laborFeeSpecified
protected boolean laborFeeSpecified
-
laborFeeTaxRate
@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal laborFeeTaxRate
The rate at which labor fees are taxed if you are a taxable customer.
-
laborFeeTaxRateSpecified
protected boolean laborFeeTaxRateSpecified
-
lastBillDate
@ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar lastBillDate
The last time this billing item was charged.
-
lastBillDateSpecified
protected boolean lastBillDateSpecified
-
modifyDate
@ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar modifyDate
The date that a billing item was last modified.
-
modifyDateSpecified
protected boolean modifyDateSpecified
-
nextBillDate
@ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar nextBillDate
The date on which your account will be charged for this billing item.
-
nextBillDateSpecified
protected boolean nextBillDateSpecified
-
notes
@ApiProperty(canBeNullOrNotSet=true) protected String notes
Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of.
-
notesSpecified
protected boolean notesSpecified
-
oneTimeFee
@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal oneTimeFee
The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD).
-
oneTimeFeeSpecified
protected boolean oneTimeFeeSpecified
-
oneTimeFeeTaxRate
@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal oneTimeFeeTaxRate
The rate at which one time fees are taxed if you are a taxable customer.
-
oneTimeFeeTaxRateSpecified
protected boolean oneTimeFeeTaxRateSpecified
-
orderItemId
@ApiProperty(canBeNullOrNotSet=true) protected Long orderItemId
the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created.
-
orderItemIdSpecified
protected boolean orderItemIdSpecified
-
parentId
@ApiProperty(canBeNullOrNotSet=true) protected Long parentId
The unique identifier of the parent of this billing item.
-
parentIdSpecified
protected boolean parentIdSpecified
-
recurringFee
@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal recurringFee
The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD).
-
recurringFeeSpecified
protected boolean recurringFeeSpecified
-
recurringFeeTaxRate
@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal recurringFeeTaxRate
The rate at which recurring fees are taxed if you are a taxable customer.
-
recurringFeeTaxRateSpecified
protected boolean recurringFeeTaxRateSpecified
-
recurringMonths
@ApiProperty(canBeNullOrNotSet=true) protected Long recurringMonths
The number of months in which the recurring fees will be incurred.
-
recurringMonthsSpecified
protected boolean recurringMonthsSpecified
-
serviceProviderId
@ApiProperty(canBeNullOrNotSet=true) protected Long serviceProviderId
This is the service provider for this billing item.
-
serviceProviderIdSpecified
protected boolean serviceProviderIdSpecified
-
setupFee
@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal setupFee
The setup fee, if any. This is a one time charge.
-
setupFeeSpecified
protected boolean setupFeeSpecified
-
setupFeeTaxRate
@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal setupFeeTaxRate
The rate at which setup fees are taxed if you are a taxable customer.
-
setupFeeTaxRateSpecified
protected boolean setupFeeTaxRateSpecified
-
activeAssociatedChildrenCount
@ApiProperty protected Long activeAssociatedChildrenCount
A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item.
-
activeAssociatedGuestDiskBillingItemCount
@ApiProperty protected Long activeAssociatedGuestDiskBillingItemCount
A count of
-
activeBundledItemCount
@ApiProperty protected Long activeBundledItemCount
A count of a Billing Item's active bundled billing items.
-
activeChildrenCount
@ApiProperty protected Long activeChildrenCount
A count of a Billing Item's active child billing items.
-
activeSparePoolAssociatedGuestDiskBillingItemCount
@ApiProperty protected Long activeSparePoolAssociatedGuestDiskBillingItemCount
A count of
-
activeSparePoolBundledItemCount
@ApiProperty protected Long activeSparePoolBundledItemCount
A count of a Billing Item's spare pool bundled billing items.
-
associatedBillingItemHistoryCount
@ApiProperty protected Long associatedBillingItemHistoryCount
A count of a history of billing items which a billing item has been associated with.
-
associatedChildrenCount
@ApiProperty protected Long associatedChildrenCount
A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item.
-
associatedParentCount
@ApiProperty protected Long associatedParentCount
A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.
-
availableMatchingVlanCount
@ApiProperty protected Long availableMatchingVlanCount
A count of
-
billableChildrenCount
@ApiProperty protected Long billableChildrenCount
A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future.
-
bundleItemCount
@ApiProperty protected Long bundleItemCount
A count of a Billing Item's bundled billing items
-
bundledItemCount
@ApiProperty protected Long bundledItemCount
A count of a Billing Item's bundled billing items'
-
canceledChildrenCount
@ApiProperty protected Long canceledChildrenCount
A count of a Billing Item's active child billing items.
-
cancellationRequestCount
@ApiProperty protected Long cancellationRequestCount
A count of this will return any cancellation requests that are associated with this billing item.
-
childrenCount
@ApiProperty protected Long childrenCount
A count of a Billing Item's child billing items'
-
childrenWithActiveAgreementCount
@ApiProperty protected Long childrenWithActiveAgreementCount
A count of a Billing Item's active child billing items.
-
downgradeItemCount
@ApiProperty protected Long downgradeItemCount
A count of for product items which have a downgrade path defined, this will return those product items.
-
filteredNextInvoiceChildrenCount
@ApiProperty protected Long filteredNextInvoiceChildrenCount
A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.
-
invoiceItemCount
@ApiProperty protected Long invoiceItemCount
A count of all invoice items associated with the billing item
-
nextInvoiceChildrenCount
@ApiProperty protected Long nextInvoiceChildrenCount
A count of a Billing Item's child billing items and associated items'
-
nonZeroNextInvoiceChildrenCount
@ApiProperty protected Long nonZeroNextInvoiceChildrenCount
A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
upgradeItemCount
@ApiProperty protected Long upgradeItemCount
A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.
-
-
Method Detail
-
getAccount
public Account getAccount()
-
setAccount
public void setAccount(Account account)
-
getActiveAgreement
public Agreement getActiveAgreement()
-
setActiveAgreement
public void setActiveAgreement(Agreement activeAgreement)
-
getActiveAgreementFlag
public Agreement getActiveAgreementFlag()
-
setActiveAgreementFlag
public void setActiveAgreementFlag(Agreement activeAgreementFlag)
-
getActiveAssociatedGuestDiskBillingItems
public List<Item> getActiveAssociatedGuestDiskBillingItems()
-
getActiveCancellationItem
public Item getActiveCancellationItem()
-
setActiveCancellationItem
public void setActiveCancellationItem(Item activeCancellationItem)
-
getActiveFlag
public Boolean getActiveFlag()
-
setActiveFlag
public void setActiveFlag(Boolean activeFlag)
-
getActiveSparePoolAssociatedGuestDiskBillingItems
public List<Item> getActiveSparePoolAssociatedGuestDiskBillingItems()
-
getAssociatedBillingItem
public Item getAssociatedBillingItem()
-
setAssociatedBillingItem
public void setAssociatedBillingItem(Item associatedBillingItem)
-
getBandwidthAllocation
public Allocation getBandwidthAllocation()
-
setBandwidthAllocation
public void setBandwidthAllocation(Allocation bandwidthAllocation)
-
getCancellationReason
public Reason getCancellationReason()
-
setCancellationReason
public void setCancellationReason(Reason cancellationReason)
-
getCategory
public Category getCategory()
-
setCategory
public void setCategory(Category category)
-
getHourlyFlag
public Boolean getHourlyFlag()
-
setHourlyFlag
public void setHourlyFlag(Boolean hourlyFlag)
-
getInvoiceItem
public Item getInvoiceItem()
-
setInvoiceItem
public void setInvoiceItem(Item invoiceItem)
-
getItem
public Item getItem()
-
setItem
public void setItem(Item item)
-
getLocation
public Location getLocation()
-
setLocation
public void setLocation(Location location)
-
getNextInvoiceTotalOneTimeAmount
public BigDecimal getNextInvoiceTotalOneTimeAmount()
-
setNextInvoiceTotalOneTimeAmount
public void setNextInvoiceTotalOneTimeAmount(BigDecimal nextInvoiceTotalOneTimeAmount)
-
getNextInvoiceTotalOneTimeTaxAmount
public BigDecimal getNextInvoiceTotalOneTimeTaxAmount()
-
setNextInvoiceTotalOneTimeTaxAmount
public void setNextInvoiceTotalOneTimeTaxAmount(BigDecimal nextInvoiceTotalOneTimeTaxAmount)
-
getNextInvoiceTotalRecurringAmount
public BigDecimal getNextInvoiceTotalRecurringAmount()
-
setNextInvoiceTotalRecurringAmount
public void setNextInvoiceTotalRecurringAmount(BigDecimal nextInvoiceTotalRecurringAmount)
-
getNextInvoiceTotalRecurringTaxAmount
public BigDecimal getNextInvoiceTotalRecurringTaxAmount()
-
setNextInvoiceTotalRecurringTaxAmount
public void setNextInvoiceTotalRecurringTaxAmount(BigDecimal nextInvoiceTotalRecurringTaxAmount)
-
getOrderItem
public Item getOrderItem()
-
setOrderItem
public void setOrderItem(Item orderItem)
-
getOriginalLocation
public Location getOriginalLocation()
-
setOriginalLocation
public void setOriginalLocation(Location originalLocation)
-
getItemPackage
public Package getItemPackage()
-
setItemPackage
public void setItemPackage(Package itemPackage)
-
getParent
public Item getParent()
-
setParent
public void setParent(Item parent)
-
getParentVirtualGuestBillingItem
public Guest getParentVirtualGuestBillingItem()
-
setParentVirtualGuestBillingItem
public void setParentVirtualGuestBillingItem(Guest parentVirtualGuestBillingItem)
-
getPendingCancellationFlag
public Boolean getPendingCancellationFlag()
-
setPendingCancellationFlag
public void setPendingCancellationFlag(Boolean pendingCancellationFlag)
-
getPendingOrderItem
public Item getPendingOrderItem()
-
setPendingOrderItem
public void setPendingOrderItem(Item pendingOrderItem)
-
getProvisionTransaction
public Transaction getProvisionTransaction()
-
setProvisionTransaction
public void setProvisionTransaction(Transaction provisionTransaction)
-
getSoftwareDescription
public Description getSoftwareDescription()
-
setSoftwareDescription
public void setSoftwareDescription(Description softwareDescription)
-
getUpgradeItem
public Item getUpgradeItem()
-
setUpgradeItem
public void setUpgradeItem(Item upgradeItem)
-
getAllowCancellationFlag
public Long getAllowCancellationFlag()
-
setAllowCancellationFlag
public void setAllowCancellationFlag(Long allowCancellationFlag)
-
isAllowCancellationFlagSpecified
public boolean isAllowCancellationFlagSpecified()
-
unsetAllowCancellationFlag
public void unsetAllowCancellationFlag()
-
getAssociatedBillingItemId
public String getAssociatedBillingItemId()
-
setAssociatedBillingItemId
public void setAssociatedBillingItemId(String associatedBillingItemId)
-
isAssociatedBillingItemIdSpecified
public boolean isAssociatedBillingItemIdSpecified()
-
unsetAssociatedBillingItemId
public void unsetAssociatedBillingItemId()
-
getCancellationDate
public GregorianCalendar getCancellationDate()
-
setCancellationDate
public void setCancellationDate(GregorianCalendar cancellationDate)
-
isCancellationDateSpecified
public boolean isCancellationDateSpecified()
-
unsetCancellationDate
public void unsetCancellationDate()
-
getCategoryCode
public String getCategoryCode()
-
setCategoryCode
public void setCategoryCode(String categoryCode)
-
isCategoryCodeSpecified
public boolean isCategoryCodeSpecified()
-
unsetCategoryCode
public void unsetCategoryCode()
-
getCreateDate
public GregorianCalendar getCreateDate()
-
setCreateDate
public void setCreateDate(GregorianCalendar createDate)
-
isCreateDateSpecified
public boolean isCreateDateSpecified()
-
unsetCreateDate
public void unsetCreateDate()
-
getCurrentHourlyCharge
public String getCurrentHourlyCharge()
-
setCurrentHourlyCharge
public void setCurrentHourlyCharge(String currentHourlyCharge)
-
isCurrentHourlyChargeSpecified
public boolean isCurrentHourlyChargeSpecified()
-
unsetCurrentHourlyCharge
public void unsetCurrentHourlyCharge()
-
getCycleStartDate
public GregorianCalendar getCycleStartDate()
-
setCycleStartDate
public void setCycleStartDate(GregorianCalendar cycleStartDate)
-
isCycleStartDateSpecified
public boolean isCycleStartDateSpecified()
-
unsetCycleStartDate
public void unsetCycleStartDate()
-
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()
-
getHoursUsed
public String getHoursUsed()
-
setHoursUsed
public void setHoursUsed(String hoursUsed)
-
isHoursUsedSpecified
public boolean isHoursUsedSpecified()
-
unsetHoursUsed
public void unsetHoursUsed()
-
getId
public Long getId()
-
setId
public void setId(Long id)
-
isIdSpecified
public boolean isIdSpecified()
-
unsetId
public void unsetId()
-
getLaborFee
public BigDecimal getLaborFee()
-
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()
-
getLastBillDate
public GregorianCalendar getLastBillDate()
-
setLastBillDate
public void setLastBillDate(GregorianCalendar lastBillDate)
-
isLastBillDateSpecified
public boolean isLastBillDateSpecified()
-
unsetLastBillDate
public void unsetLastBillDate()
-
getModifyDate
public GregorianCalendar getModifyDate()
-
setModifyDate
public void setModifyDate(GregorianCalendar modifyDate)
-
isModifyDateSpecified
public boolean isModifyDateSpecified()
-
unsetModifyDate
public void unsetModifyDate()
-
getNextBillDate
public GregorianCalendar getNextBillDate()
-
setNextBillDate
public void setNextBillDate(GregorianCalendar nextBillDate)
-
isNextBillDateSpecified
public boolean isNextBillDateSpecified()
-
unsetNextBillDate
public void unsetNextBillDate()
-
getNotes
public String getNotes()
-
setNotes
public void setNotes(String notes)
-
isNotesSpecified
public boolean isNotesSpecified()
-
unsetNotes
public void unsetNotes()
-
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()
-
getOrderItemId
public Long getOrderItemId()
-
setOrderItemId
public void setOrderItemId(Long orderItemId)
-
isOrderItemIdSpecified
public boolean isOrderItemIdSpecified()
-
unsetOrderItemId
public void unsetOrderItemId()
-
getParentId
public Long getParentId()
-
setParentId
public void setParentId(Long parentId)
-
isParentIdSpecified
public boolean isParentIdSpecified()
-
unsetParentId
public void unsetParentId()
-
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()
-
getRecurringMonths
public Long getRecurringMonths()
-
setRecurringMonths
public void setRecurringMonths(Long recurringMonths)
-
isRecurringMonthsSpecified
public boolean isRecurringMonthsSpecified()
-
unsetRecurringMonths
public void unsetRecurringMonths()
-
getServiceProviderId
public Long getServiceProviderId()
-
setServiceProviderId
public void setServiceProviderId(Long serviceProviderId)
-
isServiceProviderIdSpecified
public boolean isServiceProviderIdSpecified()
-
unsetServiceProviderId
public void unsetServiceProviderId()
-
getSetupFee
public BigDecimal getSetupFee()
-
setSetupFee
public void setSetupFee(BigDecimal setupFee)
-
isSetupFeeSpecified
public boolean isSetupFeeSpecified()
-
unsetSetupFee
public void unsetSetupFee()
-
getSetupFeeTaxRate
public BigDecimal getSetupFeeTaxRate()
-
setSetupFeeTaxRate
public void setSetupFeeTaxRate(BigDecimal setupFeeTaxRate)
-
isSetupFeeTaxRateSpecified
public boolean isSetupFeeTaxRateSpecified()
-
unsetSetupFeeTaxRate
public void unsetSetupFeeTaxRate()
-
getActiveAssociatedChildrenCount
public Long getActiveAssociatedChildrenCount()
-
setActiveAssociatedChildrenCount
public void setActiveAssociatedChildrenCount(Long activeAssociatedChildrenCount)
-
getActiveAssociatedGuestDiskBillingItemCount
public Long getActiveAssociatedGuestDiskBillingItemCount()
-
setActiveAssociatedGuestDiskBillingItemCount
public void setActiveAssociatedGuestDiskBillingItemCount(Long activeAssociatedGuestDiskBillingItemCount)
-
getActiveBundledItemCount
public Long getActiveBundledItemCount()
-
setActiveBundledItemCount
public void setActiveBundledItemCount(Long activeBundledItemCount)
-
getActiveChildrenCount
public Long getActiveChildrenCount()
-
setActiveChildrenCount
public void setActiveChildrenCount(Long activeChildrenCount)
-
getActiveSparePoolAssociatedGuestDiskBillingItemCount
public Long getActiveSparePoolAssociatedGuestDiskBillingItemCount()
-
setActiveSparePoolAssociatedGuestDiskBillingItemCount
public void setActiveSparePoolAssociatedGuestDiskBillingItemCount(Long activeSparePoolAssociatedGuestDiskBillingItemCount)
-
getActiveSparePoolBundledItemCount
public Long getActiveSparePoolBundledItemCount()
-
setActiveSparePoolBundledItemCount
public void setActiveSparePoolBundledItemCount(Long activeSparePoolBundledItemCount)
-
getAssociatedBillingItemHistoryCount
public Long getAssociatedBillingItemHistoryCount()
-
setAssociatedBillingItemHistoryCount
public void setAssociatedBillingItemHistoryCount(Long associatedBillingItemHistoryCount)
-
getAssociatedChildrenCount
public Long getAssociatedChildrenCount()
-
setAssociatedChildrenCount
public void setAssociatedChildrenCount(Long associatedChildrenCount)
-
getAssociatedParentCount
public Long getAssociatedParentCount()
-
setAssociatedParentCount
public void setAssociatedParentCount(Long associatedParentCount)
-
getAvailableMatchingVlanCount
public Long getAvailableMatchingVlanCount()
-
setAvailableMatchingVlanCount
public void setAvailableMatchingVlanCount(Long availableMatchingVlanCount)
-
getBillableChildrenCount
public Long getBillableChildrenCount()
-
setBillableChildrenCount
public void setBillableChildrenCount(Long billableChildrenCount)
-
getBundleItemCount
public Long getBundleItemCount()
-
setBundleItemCount
public void setBundleItemCount(Long bundleItemCount)
-
getBundledItemCount
public Long getBundledItemCount()
-
setBundledItemCount
public void setBundledItemCount(Long bundledItemCount)
-
getCanceledChildrenCount
public Long getCanceledChildrenCount()
-
setCanceledChildrenCount
public void setCanceledChildrenCount(Long canceledChildrenCount)
-
getCancellationRequestCount
public Long getCancellationRequestCount()
-
setCancellationRequestCount
public void setCancellationRequestCount(Long cancellationRequestCount)
-
getChildrenCount
public Long getChildrenCount()
-
setChildrenCount
public void setChildrenCount(Long childrenCount)
-
getChildrenWithActiveAgreementCount
public Long getChildrenWithActiveAgreementCount()
-
setChildrenWithActiveAgreementCount
public void setChildrenWithActiveAgreementCount(Long childrenWithActiveAgreementCount)
-
getDowngradeItemCount
public Long getDowngradeItemCount()
-
setDowngradeItemCount
public void setDowngradeItemCount(Long downgradeItemCount)
-
getFilteredNextInvoiceChildrenCount
public Long getFilteredNextInvoiceChildrenCount()
-
setFilteredNextInvoiceChildrenCount
public void setFilteredNextInvoiceChildrenCount(Long filteredNextInvoiceChildrenCount)
-
getInvoiceItemCount
public Long getInvoiceItemCount()
-
setInvoiceItemCount
public void setInvoiceItemCount(Long invoiceItemCount)
-
getNextInvoiceChildrenCount
public Long getNextInvoiceChildrenCount()
-
setNextInvoiceChildrenCount
public void setNextInvoiceChildrenCount(Long nextInvoiceChildrenCount)
-
getNonZeroNextInvoiceChildrenCount
public Long getNonZeroNextInvoiceChildrenCount()
-
setNonZeroNextInvoiceChildrenCount
public void setNonZeroNextInvoiceChildrenCount(Long nonZeroNextInvoiceChildrenCount)
-
getUpgradeItemCount
public Long getUpgradeItemCount()
-
setUpgradeItemCount
public void setUpgradeItemCount(Long upgradeItemCount)
-
asService
public Item.Service asService(ApiClient client)
-
service
public static Item.Service service(ApiClient client)
-
service
public static Item.Service service(ApiClient client, Long id)
-
-