• Home
• com.softlayer.api
• softlayer-api-client
• 0.2.4
• source code
• Item.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.softlayer.api.service.billing.Item Maven / Gradle / Ivy

package com.softlayer.api.service.billing;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.Location;
import com.softlayer.api.service.account.Agreement;
import com.softlayer.api.service.billing.item.association.History;
import com.softlayer.api.service.billing.item.cancellation.Reason;
import com.softlayer.api.service.billing.item.cancellation.Request;
import com.softlayer.api.service.billing.item.virtual.Guest;
import com.softlayer.api.service.network.Vlan;
import com.softlayer.api.service.network.bandwidth.version1.Allocation;
import com.softlayer.api.service.product.Package;
import com.softlayer.api.service.product.item.Bundles;
import com.softlayer.api.service.product.item.Category;
import com.softlayer.api.service.provisioning.version1.Transaction;
import com.softlayer.api.service.software.Description;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * 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 SoftLayer_Billing_Item
 */
@ApiType("SoftLayer_Billing_Item")
public class Item extends Entity {

    /**
     * The account that a billing item belongs to.
     */
    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

    public void setAccount(Account account) {
        this.account = account;
    }

    @ApiProperty
    protected Agreement activeAgreement;

    public Agreement getActiveAgreement() {
        return activeAgreement;
    }

    public void setActiveAgreement(Agreement activeAgreement) {
        this.activeAgreement = activeAgreement;
    }

    /**
     * A flag indicating that the billing item is under an active agreement.
     */
    @ApiProperty
    protected Agreement activeAgreementFlag;

    public Agreement getActiveAgreementFlag() {
        return activeAgreementFlag;
    }

    public void setActiveAgreementFlag(Agreement activeAgreementFlag) {
        this.activeAgreementFlag = activeAgreementFlag;
    }

    /**
     * A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item.
     */
    @ApiProperty
    protected List activeAssociatedChildren;

    public List getActiveAssociatedChildren() {
        if (activeAssociatedChildren == null) {
            activeAssociatedChildren = new ArrayList();
        }
        return activeAssociatedChildren;
    }

    @ApiProperty
    protected List activeAssociatedGuestDiskBillingItems;

    public List getActiveAssociatedGuestDiskBillingItems() {
        if (activeAssociatedGuestDiskBillingItems == null) {
            activeAssociatedGuestDiskBillingItems = new ArrayList();
        }
        return activeAssociatedGuestDiskBillingItems;
    }

    /**
     * A Billing Item's active bundled billing items.
     */
    @ApiProperty
    protected List activeBundledItems;

    public List getActiveBundledItems() {
        if (activeBundledItems == null) {
            activeBundledItems = new ArrayList();
        }
        return activeBundledItems;
    }

    /**
     * A service cancellation request item that corresponds to the billing item.
     */
    @ApiProperty
    protected com.softlayer.api.service.billing.item.cancellation.request.Item activeCancellationItem;

    public com.softlayer.api.service.billing.item.cancellation.request.Item getActiveCancellationItem() {
        return activeCancellationItem;
    }

    public void setActiveCancellationItem(com.softlayer.api.service.billing.item.cancellation.request.Item activeCancellationItem) {
        this.activeCancellationItem = activeCancellationItem;
    }

    /**
     * A Billing Item's active child billing items.
     */
    @ApiProperty
    protected List activeChildren;

    public List getActiveChildren() {
        if (activeChildren == null) {
            activeChildren = new ArrayList();
        }
        return activeChildren;
    }

    @ApiProperty
    protected Boolean activeFlag;

    public Boolean getActiveFlag() {
        return activeFlag;
    }

    public void setActiveFlag(Boolean activeFlag) {
        this.activeFlag = activeFlag;
    }

    @ApiProperty
    protected List activeSparePoolAssociatedGuestDiskBillingItems;

    public List getActiveSparePoolAssociatedGuestDiskBillingItems() {
        if (activeSparePoolAssociatedGuestDiskBillingItems == null) {
            activeSparePoolAssociatedGuestDiskBillingItems = new ArrayList();
        }
        return activeSparePoolAssociatedGuestDiskBillingItems;
    }

    /**
     * A Billing Item's spare pool bundled billing items.
     */
    @ApiProperty
    protected List activeSparePoolBundledItems;

    public List getActiveSparePoolBundledItems() {
        if (activeSparePoolBundledItems == null) {
            activeSparePoolBundledItems = new ArrayList();
        }
        return activeSparePoolBundledItems;
    }

    /**
     * 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.
     */
    @ApiProperty
    protected Item associatedBillingItem;

    public Item getAssociatedBillingItem() {
        return associatedBillingItem;
    }

    public void setAssociatedBillingItem(Item associatedBillingItem) {
        this.associatedBillingItem = associatedBillingItem;
    }

    /**
     * A history of billing items which a billing item has been associated with.
     */
    @ApiProperty
    protected List associatedBillingItemHistory;

    public List getAssociatedBillingItemHistory() {
        if (associatedBillingItemHistory == null) {
            associatedBillingItemHistory = new ArrayList();
        }
        return associatedBillingItemHistory;
    }

    /**
     * A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item.
     */
    @ApiProperty
    protected List associatedChildren;

    public List getAssociatedChildren() {
        if (associatedChildren == null) {
            associatedChildren = new ArrayList();
        }
        return associatedChildren;
    }

    /**
     * A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.
     */
    @ApiProperty
    protected List associatedParent;

    public List getAssociatedParent() {
        if (associatedParent == null) {
            associatedParent = new ArrayList();
        }
        return associatedParent;
    }

    @ApiProperty
    protected List availableMatchingVlans;

    public List getAvailableMatchingVlans() {
        if (availableMatchingVlans == null) {
            availableMatchingVlans = new ArrayList();
        }
        return availableMatchingVlans;
    }

    /**
     * The bandwidth allocation for a billing item.
     */
    @ApiProperty
    protected Allocation bandwidthAllocation;

    public Allocation getBandwidthAllocation() {
        return bandwidthAllocation;
    }

    public void setBandwidthAllocation(Allocation bandwidthAllocation) {
        this.bandwidthAllocation = bandwidthAllocation;
    }

    /**
     * A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.
     */
    @ApiProperty
    protected List billableChildren;

    public List getBillableChildren() {
        if (billableChildren == null) {
            billableChildren = new ArrayList();
        }
        return billableChildren;
    }

    /**
     * A Billing Item's bundled billing items
     */
    @ApiProperty
    protected List bundleItems;

    public List getBundleItems() {
        if (bundleItems == null) {
            bundleItems = new ArrayList();
        }
        return bundleItems;
    }

    /**
     * A Billing Item's bundled billing items'
     */
    @ApiProperty
    protected List bundledItems;

    public List getBundledItems() {
        if (bundledItems == null) {
            bundledItems = new ArrayList();
        }
        return bundledItems;
    }

    /**
     * A Billing Item's active child billing items.
     */
    @ApiProperty
    protected List canceledChildren;

    public List getCanceledChildren() {
        if (canceledChildren == null) {
            canceledChildren = new ArrayList();
        }
        return canceledChildren;
    }

    /**
     * The billing item's cancellation reason.
     */
    @ApiProperty
    protected Reason cancellationReason;

    public Reason getCancellationReason() {
        return cancellationReason;
    }

    public void setCancellationReason(Reason cancellationReason) {
        this.cancellationReason = cancellationReason;
    }

    /**
     * This will return any cancellation requests that are associated with this billing item.
     */
    @ApiProperty
    protected List cancellationRequests;

    public List getCancellationRequests() {
        if (cancellationRequests == null) {
            cancellationRequests = new ArrayList();
        }
        return cancellationRequests;
    }

    /**
     * The item category to which the billing item's item belongs. 
     */
    @ApiProperty
    protected Category category;

    public Category getCategory() {
        return category;
    }

    public void setCategory(Category category) {
        this.category = category;
    }

    /**
     * A Billing Item's child billing items'
     */
    @ApiProperty
    protected List children;

    public List getChildren() {
        if (children == null) {
            children = new ArrayList();
        }
        return children;
    }

    /**
     * A Billing Item's active child billing items.
     */
    @ApiProperty
    protected List childrenWithActiveAgreement;

    public List getChildrenWithActiveAgreement() {
        if (childrenWithActiveAgreement == null) {
            childrenWithActiveAgreement = new ArrayList();
        }
        return childrenWithActiveAgreement;
    }

    /**
     * For product items which have a downgrade path defined, this will return those product items.
     */
    @ApiProperty
    protected List downgradeItems;

    public List getDowngradeItems() {
        if (downgradeItems == null) {
            downgradeItems = new ArrayList();
        }
        return downgradeItems;
    }

    /**
     * A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.
     */
    @ApiProperty
    protected List filteredNextInvoiceChildren;

    public List getFilteredNextInvoiceChildren() {
        if (filteredNextInvoiceChildren == null) {
            filteredNextInvoiceChildren = new ArrayList();
        }
        return filteredNextInvoiceChildren;
    }

    /**
     * A flag that will reflect whether this billing item is billed on an hourly basis or not.
     */
    @ApiProperty
    protected Boolean hourlyFlag;

    public Boolean getHourlyFlag() {
        return hourlyFlag;
    }

    public void setHourlyFlag(Boolean hourlyFlag) {
        this.hourlyFlag = hourlyFlag;
    }

    /**
     * Invoice items associated with this billing item
     */
    @ApiProperty
    protected com.softlayer.api.service.billing.invoice.Item invoiceItem;

    public com.softlayer.api.service.billing.invoice.Item getInvoiceItem() {
        return invoiceItem;
    }

    public void setInvoiceItem(com.softlayer.api.service.billing.invoice.Item invoiceItem) {
        this.invoiceItem = invoiceItem;
    }

    /**
     * All invoice items associated with the billing item
     */
    @ApiProperty
    protected List invoiceItems;

    public List getInvoiceItems() {
        if (invoiceItems == null) {
            invoiceItems = new ArrayList();
        }
        return invoiceItems;
    }

    /**
     * The entry in the SoftLayer product catalog that a billing item is based upon.
     */
    @ApiProperty
    protected com.softlayer.api.service.product.Item item;

    public com.softlayer.api.service.product.Item getItem() {
        return item;
    }

    public void setItem(com.softlayer.api.service.product.Item item) {
        this.item = item;
    }

    /**
     * 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.
     */
    @ApiProperty
    protected Location location;

    public Location getLocation() {
        return location;
    }

    public void setLocation(Location location) {
        this.location = location;
    }

    /**
     * A Billing Item's child billing items and associated items'
     */
    @ApiProperty
    protected List nextInvoiceChildren;

    public List getNextInvoiceChildren() {
        if (nextInvoiceChildren == null) {
            nextInvoiceChildren = new ArrayList();
        }
        return nextInvoiceChildren;
    }

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

    public BigDecimal getNextInvoiceTotalOneTimeAmount() {
        return nextInvoiceTotalOneTimeAmount;
    }

    public void setNextInvoiceTotalOneTimeAmount(BigDecimal nextInvoiceTotalOneTimeAmount) {
        this.nextInvoiceTotalOneTimeAmount = nextInvoiceTotalOneTimeAmount;
    }

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

    public BigDecimal getNextInvoiceTotalOneTimeTaxAmount() {
        return nextInvoiceTotalOneTimeTaxAmount;
    }

    public void setNextInvoiceTotalOneTimeTaxAmount(BigDecimal nextInvoiceTotalOneTimeTaxAmount) {
        this.nextInvoiceTotalOneTimeTaxAmount = nextInvoiceTotalOneTimeTaxAmount;
    }

    /**
     * A Billing Item's total, including any child billing items and associated billing items if they exist.'
     */
    @ApiProperty
    protected BigDecimal nextInvoiceTotalRecurringAmount;

    public BigDecimal getNextInvoiceTotalRecurringAmount() {
        return nextInvoiceTotalRecurringAmount;
    }

    public void setNextInvoiceTotalRecurringAmount(BigDecimal nextInvoiceTotalRecurringAmount) {
        this.nextInvoiceTotalRecurringAmount = nextInvoiceTotalRecurringAmount;
    }

    /**
     * This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.
     */
    @ApiProperty
    protected BigDecimal nextInvoiceTotalRecurringTaxAmount;

    public BigDecimal getNextInvoiceTotalRecurringTaxAmount() {
        return nextInvoiceTotalRecurringTaxAmount;
    }

    public void setNextInvoiceTotalRecurringTaxAmount(BigDecimal nextInvoiceTotalRecurringTaxAmount) {
        this.nextInvoiceTotalRecurringTaxAmount = nextInvoiceTotalRecurringTaxAmount;
    }

    /**
     * A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.
     */
    @ApiProperty
    protected List nonZeroNextInvoiceChildren;

    public List getNonZeroNextInvoiceChildren() {
        if (nonZeroNextInvoiceChildren == null) {
            nonZeroNextInvoiceChildren = new ArrayList();
        }
        return nonZeroNextInvoiceChildren;
    }

    /**
     * A billing item's original order item. Simply a reference to the original order from which this billing item was created.
     */
    @ApiProperty
    protected com.softlayer.api.service.billing.order.Item orderItem;

    public com.softlayer.api.service.billing.order.Item getOrderItem() {
        return orderItem;
    }

    public void setOrderItem(com.softlayer.api.service.billing.order.Item orderItem) {
        this.orderItem = orderItem;
    }

    /**
     * The original physical location for this billing item--may differ from current.
     */
    @ApiProperty
    protected Location originalLocation;

    public Location getOriginalLocation() {
        return originalLocation;
    }

    public void setOriginalLocation(Location originalLocation) {
        this.originalLocation = originalLocation;
    }

    /**
     * The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.
     */
    @ApiProperty("package")
    protected Package itemPackage;

    public Package getItemPackage() {
        return itemPackage;
    }

    public void setItemPackage(Package itemPackage) {
        this.itemPackage = itemPackage;
    }

    /**
     * A billing item's parent item. If a billing item has no parent item then this value is null.
     */
    @ApiProperty
    protected Item parent;

    public Item getParent() {
        return parent;
    }

    public void setParent(Item parent) {
        this.parent = parent;
    }

    /**
     * A billing item's parent item. If a billing item has no parent item then this value is null.
     */
    @ApiProperty
    protected Guest parentVirtualGuestBillingItem;

    public Guest getParentVirtualGuestBillingItem() {
        return parentVirtualGuestBillingItem;
    }

    public void setParentVirtualGuestBillingItem(Guest parentVirtualGuestBillingItem) {
        this.parentVirtualGuestBillingItem = parentVirtualGuestBillingItem;
    }

    /**
     * This flag indicates whether a billing item is scheduled to be canceled or not.
     */
    @ApiProperty
    protected Boolean pendingCancellationFlag;

    public Boolean getPendingCancellationFlag() {
        return pendingCancellationFlag;
    }

    public void setPendingCancellationFlag(Boolean pendingCancellationFlag) {
        this.pendingCancellationFlag = pendingCancellationFlag;
    }

    /**
     * The new order item that will replace this billing item.
     */
    @ApiProperty
    protected com.softlayer.api.service.billing.order.Item pendingOrderItem;

    public com.softlayer.api.service.billing.order.Item getPendingOrderItem() {
        return pendingOrderItem;
    }

    public void setPendingOrderItem(com.softlayer.api.service.billing.order.Item pendingOrderItem) {
        this.pendingOrderItem = pendingOrderItem;
    }

    /**
     * Provisioning transaction for this billing item
     */
    @ApiProperty
    protected Transaction provisionTransaction;

    public Transaction getProvisionTransaction() {
        return provisionTransaction;
    }

    public void setProvisionTransaction(Transaction provisionTransaction) {
        this.provisionTransaction = provisionTransaction;
    }

    /**
     * A friendly description of software component
     */
    @ApiProperty
    protected Description softwareDescription;

    public Description getSoftwareDescription() {
        return softwareDescription;
    }

    public void setSoftwareDescription(Description softwareDescription) {
        this.softwareDescription = softwareDescription;
    }

    /**
     * Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.
     */
    @ApiProperty
    protected com.softlayer.api.service.product.Item upgradeItem;

    public com.softlayer.api.service.product.Item getUpgradeItem() {
        return upgradeItem;
    }

    public void setUpgradeItem(com.softlayer.api.service.product.Item upgradeItem) {
        this.upgradeItem = upgradeItem;
    }

    /**
     * Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.
     */
    @ApiProperty
    protected List upgradeItems;

    public List getUpgradeItems() {
        if (upgradeItems == null) {
            upgradeItems = new ArrayList();
        }
        return upgradeItems;
    }

    /**
     * Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long allowCancellationFlag;

    public Long getAllowCancellationFlag() {
        return allowCancellationFlag;
    }

    public void setAllowCancellationFlag(Long allowCancellationFlag) {
        allowCancellationFlagSpecified = true;
        this.allowCancellationFlag = allowCancellationFlag;
    }

    protected boolean allowCancellationFlagSpecified;

    public boolean isAllowCancellationFlagSpecified() {
        return allowCancellationFlagSpecified;
    }

    public void unsetAllowCancellationFlag() {
        allowCancellationFlag = null;
        allowCancellationFlagSpecified = false;
    }

    /**
     * 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. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String associatedBillingItemId;

    public String getAssociatedBillingItemId() {
        return associatedBillingItemId;
    }

    public void setAssociatedBillingItemId(String associatedBillingItemId) {
        associatedBillingItemIdSpecified = true;
        this.associatedBillingItemId = associatedBillingItemId;
    }

    protected boolean associatedBillingItemIdSpecified;

    public boolean isAssociatedBillingItemIdSpecified() {
        return associatedBillingItemIdSpecified;
    }

    public void unsetAssociatedBillingItemId() {
        associatedBillingItemId = null;
        associatedBillingItemIdSpecified = false;
    }

    /**
     * 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. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar cancellationDate;

    public GregorianCalendar getCancellationDate() {
        return cancellationDate;
    }

    public void setCancellationDate(GregorianCalendar cancellationDate) {
        cancellationDateSpecified = true;
        this.cancellationDate = cancellationDate;
    }

    protected boolean cancellationDateSpecified;

    public boolean isCancellationDateSpecified() {
        return cancellationDateSpecified;
    }

    public void unsetCancellationDate() {
        cancellationDate = null;
        cancellationDateSpecified = false;
    }

    /**
     * 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.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String categoryCode;

    public String getCategoryCode() {
        return categoryCode;
    }

    public void setCategoryCode(String categoryCode) {
        categoryCodeSpecified = true;
        this.categoryCode = categoryCode;
    }

    protected boolean categoryCodeSpecified;

    public boolean isCategoryCodeSpecified() {
        return categoryCodeSpecified;
    }

    public void unsetCategoryCode() {
        categoryCode = null;
        categoryCodeSpecified = false;
    }

    /**
     * The date the billing item was created. You can see this date on the invoice.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar createDate;

    public GregorianCalendar getCreateDate() {
        return createDate;
    }

    public void setCreateDate(GregorianCalendar createDate) {
        createDateSpecified = true;
        this.createDate = createDate;
    }

    protected boolean createDateSpecified;

    public boolean isCreateDateSpecified() {
        return createDateSpecified;
    }

    public void unsetCreateDate() {
        createDate = null;
        createDateSpecified = false;
    }

    /**
     * This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String currentHourlyCharge;

    public String getCurrentHourlyCharge() {
        return currentHourlyCharge;
    }

    public void setCurrentHourlyCharge(String currentHourlyCharge) {
        currentHourlyChargeSpecified = true;
        this.currentHourlyCharge = currentHourlyCharge;
    }

    protected boolean currentHourlyChargeSpecified;

    public boolean isCurrentHourlyChargeSpecified() {
        return currentHourlyChargeSpecified;
    }

    public void unsetCurrentHourlyCharge() {
        currentHourlyCharge = null;
        currentHourlyChargeSpecified = false;
    }

    /**
     * The last time this billing item was charged.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar cycleStartDate;

    public GregorianCalendar getCycleStartDate() {
        return cycleStartDate;
    }

    public void setCycleStartDate(GregorianCalendar cycleStartDate) {
        cycleStartDateSpecified = true;
        this.cycleStartDate = cycleStartDate;
    }

    protected boolean cycleStartDateSpecified;

    public boolean isCycleStartDateSpecified() {
        return cycleStartDateSpecified;
    }

    public void unsetCycleStartDate() {
        cycleStartDate = null;
        cycleStartDateSpecified = false;
    }

    /**
     * A brief description of a billing item.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String description;

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        descriptionSpecified = true;
        this.description = description;
    }

    protected boolean descriptionSpecified;

    public boolean isDescriptionSpecified() {
        return descriptionSpecified;
    }

    public void unsetDescription() {
        description = null;
        descriptionSpecified = false;
    }

    /**
     * The domain name is provided for server billing items.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String domainName;

    public String getDomainName() {
        return domainName;
    }

    public void setDomainName(String domainName) {
        domainNameSpecified = true;
        this.domainName = domainName;
    }

    protected boolean domainNameSpecified;

    public boolean isDomainNameSpecified() {
        return domainNameSpecified;
    }

    public void unsetDomainName() {
        domainName = null;
        domainNameSpecified = false;
    }

    /**
     * The hostname is provided for server billing items
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String hostName;

    public String getHostName() {
        return hostName;
    }

    public void setHostName(String hostName) {
        hostNameSpecified = true;
        this.hostName = hostName;
    }

    protected boolean hostNameSpecified;

    public boolean isHostNameSpecified() {
        return hostNameSpecified;
    }

    public void unsetHostName() {
        hostName = null;
        hostNameSpecified = false;
    }

    /**
     * The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal hourlyRecurringFee;

    public BigDecimal getHourlyRecurringFee() {
        return hourlyRecurringFee;
    }

    public void setHourlyRecurringFee(BigDecimal hourlyRecurringFee) {
        hourlyRecurringFeeSpecified = true;
        this.hourlyRecurringFee = hourlyRecurringFee;
    }

    protected boolean hourlyRecurringFeeSpecified;

    public boolean isHourlyRecurringFeeSpecified() {
        return hourlyRecurringFeeSpecified;
    }

    public void unsetHourlyRecurringFee() {
        hourlyRecurringFee = null;
        hourlyRecurringFeeSpecified = false;
    }

    /**
     * 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. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String hoursUsed;

    public String getHoursUsed() {
        return hoursUsed;
    }

    public void setHoursUsed(String hoursUsed) {
        hoursUsedSpecified = true;
        this.hoursUsed = hoursUsed;
    }

    protected boolean hoursUsedSpecified;

    public boolean isHoursUsedSpecified() {
        return hoursUsedSpecified;
    }

    public void unsetHoursUsed() {
        hoursUsed = null;
        hoursUsedSpecified = false;
    }

    /**
     * The unique identifier for this billing item.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * The labor fee, if any. This is a one time charge.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal laborFee;

    public BigDecimal getLaborFee() {
        return laborFee;
    }

    public void setLaborFee(BigDecimal laborFee) {
        laborFeeSpecified = true;
        this.laborFee = laborFee;
    }

    protected boolean laborFeeSpecified;

    public boolean isLaborFeeSpecified() {
        return laborFeeSpecified;
    }

    public void unsetLaborFee() {
        laborFee = null;
        laborFeeSpecified = false;
    }

    /**
     * The rate at which labor fees are taxed if you are a taxable customer.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal laborFeeTaxRate;

    public BigDecimal getLaborFeeTaxRate() {
        return laborFeeTaxRate;
    }

    public void setLaborFeeTaxRate(BigDecimal laborFeeTaxRate) {
        laborFeeTaxRateSpecified = true;
        this.laborFeeTaxRate = laborFeeTaxRate;
    }

    protected boolean laborFeeTaxRateSpecified;

    public boolean isLaborFeeTaxRateSpecified() {
        return laborFeeTaxRateSpecified;
    }

    public void unsetLaborFeeTaxRate() {
        laborFeeTaxRate = null;
        laborFeeTaxRateSpecified = false;
    }

    /**
     * The last time this billing item was charged.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar lastBillDate;

    public GregorianCalendar getLastBillDate() {
        return lastBillDate;
    }

    public void setLastBillDate(GregorianCalendar lastBillDate) {
        lastBillDateSpecified = true;
        this.lastBillDate = lastBillDate;
    }

    protected boolean lastBillDateSpecified;

    public boolean isLastBillDateSpecified() {
        return lastBillDateSpecified;
    }

    public void unsetLastBillDate() {
        lastBillDate = null;
        lastBillDateSpecified = false;
    }

    /**
     * The date that a billing item was last modified.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar modifyDate;

    public GregorianCalendar getModifyDate() {
        return modifyDate;
    }

    public void setModifyDate(GregorianCalendar modifyDate) {
        modifyDateSpecified = true;
        this.modifyDate = modifyDate;
    }

    protected boolean modifyDateSpecified;

    public boolean isModifyDateSpecified() {
        return modifyDateSpecified;
    }

    public void unsetModifyDate() {
        modifyDate = null;
        modifyDateSpecified = false;
    }

    /**
     * The date on which your account will be charged for this billing item. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar nextBillDate;

    public GregorianCalendar getNextBillDate() {
        return nextBillDate;
    }

    public void setNextBillDate(GregorianCalendar nextBillDate) {
        nextBillDateSpecified = true;
        this.nextBillDate = nextBillDate;
    }

    protected boolean nextBillDateSpecified;

    public boolean isNextBillDateSpecified() {
        return nextBillDateSpecified;
    }

    public void unsetNextBillDate() {
        nextBillDate = null;
        nextBillDateSpecified = false;
    }

    /**
     * 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.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String notes;

    public String getNotes() {
        return notes;
    }

    public void setNotes(String notes) {
        notesSpecified = true;
        this.notes = notes;
    }

    protected boolean notesSpecified;

    public boolean isNotesSpecified() {
        return notesSpecified;
    }

    public void unsetNotes() {
        notes = null;
        notesSpecified = false;
    }

    /**
     * The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal oneTimeFee;

    public BigDecimal getOneTimeFee() {
        return oneTimeFee;
    }

    public void setOneTimeFee(BigDecimal oneTimeFee) {
        oneTimeFeeSpecified = true;
        this.oneTimeFee = oneTimeFee;
    }

    protected boolean oneTimeFeeSpecified;

    public boolean isOneTimeFeeSpecified() {
        return oneTimeFeeSpecified;
    }

    public void unsetOneTimeFee() {
        oneTimeFee = null;
        oneTimeFeeSpecified = false;
    }

    /**
     * The rate at which one time fees are taxed if you are a taxable customer.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal oneTimeFeeTaxRate;

    public BigDecimal getOneTimeFeeTaxRate() {
        return oneTimeFeeTaxRate;
    }

    public void setOneTimeFeeTaxRate(BigDecimal oneTimeFeeTaxRate) {
        oneTimeFeeTaxRateSpecified = true;
        this.oneTimeFeeTaxRate = oneTimeFeeTaxRate;
    }

    protected boolean oneTimeFeeTaxRateSpecified;

    public boolean isOneTimeFeeTaxRateSpecified() {
        return oneTimeFeeTaxRateSpecified;
    }

    public void unsetOneTimeFeeTaxRate() {
        oneTimeFeeTaxRate = null;
        oneTimeFeeTaxRateSpecified = false;
    }

    /**
     * the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long orderItemId;

    public Long getOrderItemId() {
        return orderItemId;
    }

    public void setOrderItemId(Long orderItemId) {
        orderItemIdSpecified = true;
        this.orderItemId = orderItemId;
    }

    protected boolean orderItemIdSpecified;

    public boolean isOrderItemIdSpecified() {
        return orderItemIdSpecified;
    }

    public void unsetOrderItemId() {
        orderItemId = null;
        orderItemIdSpecified = false;
    }

    /**
     * The unique identifier of the parent of this billing item.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long parentId;

    public Long getParentId() {
        return parentId;
    }

    public void setParentId(Long parentId) {
        parentIdSpecified = true;
        this.parentId = parentId;
    }

    protected boolean parentIdSpecified;

    public boolean isParentIdSpecified() {
        return parentIdSpecified;
    }

    public void unsetParentId() {
        parentId = null;
        parentIdSpecified = false;
    }

    /**
     * The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal recurringFee;

    public BigDecimal getRecurringFee() {
        return recurringFee;
    }

    public void setRecurringFee(BigDecimal recurringFee) {
        recurringFeeSpecified = true;
        this.recurringFee = recurringFee;
    }

    protected boolean recurringFeeSpecified;

    public boolean isRecurringFeeSpecified() {
        return recurringFeeSpecified;
    }

    public void unsetRecurringFee() {
        recurringFee = null;
        recurringFeeSpecified = false;
    }

    /**
     * The rate at which recurring fees are taxed if you are a taxable customer.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal recurringFeeTaxRate;

    public BigDecimal getRecurringFeeTaxRate() {
        return recurringFeeTaxRate;
    }

    public void setRecurringFeeTaxRate(BigDecimal recurringFeeTaxRate) {
        recurringFeeTaxRateSpecified = true;
        this.recurringFeeTaxRate = recurringFeeTaxRate;
    }

    protected boolean recurringFeeTaxRateSpecified;

    public boolean isRecurringFeeTaxRateSpecified() {
        return recurringFeeTaxRateSpecified;
    }

    public void unsetRecurringFeeTaxRate() {
        recurringFeeTaxRate = null;
        recurringFeeTaxRateSpecified = false;
    }

    /**
     * The number of months in which the recurring fees will be incurred.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long recurringMonths;

    public Long getRecurringMonths() {
        return recurringMonths;
    }

    public void setRecurringMonths(Long recurringMonths) {
        recurringMonthsSpecified = true;
        this.recurringMonths = recurringMonths;
    }

    protected boolean recurringMonthsSpecified;

    public boolean isRecurringMonthsSpecified() {
        return recurringMonthsSpecified;
    }

    public void unsetRecurringMonths() {
        recurringMonths = null;
        recurringMonthsSpecified = false;
    }

    /**
     * This is the service provider for this billing item. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long serviceProviderId;

    public Long getServiceProviderId() {
        return serviceProviderId;
    }

    public void setServiceProviderId(Long serviceProviderId) {
        serviceProviderIdSpecified = true;
        this.serviceProviderId = serviceProviderId;
    }

    protected boolean serviceProviderIdSpecified;

    public boolean isServiceProviderIdSpecified() {
        return serviceProviderIdSpecified;
    }

    public void unsetServiceProviderId() {
        serviceProviderId = null;
        serviceProviderIdSpecified = false;
    }

    /**
     * The setup fee, if any. This is a one time charge.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal setupFee;

    public BigDecimal getSetupFee() {
        return setupFee;
    }

    public void setSetupFee(BigDecimal setupFee) {
        setupFeeSpecified = true;
        this.setupFee = setupFee;
    }

    protected boolean setupFeeSpecified;

    public boolean isSetupFeeSpecified() {
        return setupFeeSpecified;
    }

    public void unsetSetupFee() {
        setupFee = null;
        setupFeeSpecified = false;
    }

    /**
     * The rate at which setup fees are taxed if you are a taxable customer.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal setupFeeTaxRate;

    public BigDecimal getSetupFeeTaxRate() {
        return setupFeeTaxRate;
    }

    public void setSetupFeeTaxRate(BigDecimal setupFeeTaxRate) {
        setupFeeTaxRateSpecified = true;
        this.setupFeeTaxRate = setupFeeTaxRate;
    }

    protected boolean setupFeeTaxRateSpecified;

    public boolean isSetupFeeTaxRateSpecified() {
        return setupFeeTaxRateSpecified;
    }

    public void unsetSetupFeeTaxRate() {
        setupFeeTaxRate = null;
        setupFeeTaxRateSpecified = false;
    }

    /**
     * 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.
     */
    @ApiProperty
    protected Long activeAssociatedChildrenCount;

    public Long getActiveAssociatedChildrenCount() {
        return activeAssociatedChildrenCount;
    }

    public void setActiveAssociatedChildrenCount(Long activeAssociatedChildrenCount) {
        this.activeAssociatedChildrenCount = activeAssociatedChildrenCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long activeAssociatedGuestDiskBillingItemCount;

    public Long getActiveAssociatedGuestDiskBillingItemCount() {
        return activeAssociatedGuestDiskBillingItemCount;
    }

    public void setActiveAssociatedGuestDiskBillingItemCount(Long activeAssociatedGuestDiskBillingItemCount) {
        this.activeAssociatedGuestDiskBillingItemCount = activeAssociatedGuestDiskBillingItemCount;
    }

    /**
     * A count of a Billing Item's active bundled billing items.
     */
    @ApiProperty
    protected Long activeBundledItemCount;

    public Long getActiveBundledItemCount() {
        return activeBundledItemCount;
    }

    public void setActiveBundledItemCount(Long activeBundledItemCount) {
        this.activeBundledItemCount = activeBundledItemCount;
    }

    /**
     * A count of a Billing Item's active child billing items.
     */
    @ApiProperty
    protected Long activeChildrenCount;

    public Long getActiveChildrenCount() {
        return activeChildrenCount;
    }

    public void setActiveChildrenCount(Long activeChildrenCount) {
        this.activeChildrenCount = activeChildrenCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long activeSparePoolAssociatedGuestDiskBillingItemCount;

    public Long getActiveSparePoolAssociatedGuestDiskBillingItemCount() {
        return activeSparePoolAssociatedGuestDiskBillingItemCount;
    }

    public void setActiveSparePoolAssociatedGuestDiskBillingItemCount(Long activeSparePoolAssociatedGuestDiskBillingItemCount) {
        this.activeSparePoolAssociatedGuestDiskBillingItemCount = activeSparePoolAssociatedGuestDiskBillingItemCount;
    }

    /**
     * A count of a Billing Item's spare pool bundled billing items.
     */
    @ApiProperty
    protected Long activeSparePoolBundledItemCount;

    public Long getActiveSparePoolBundledItemCount() {
        return activeSparePoolBundledItemCount;
    }

    public void setActiveSparePoolBundledItemCount(Long activeSparePoolBundledItemCount) {
        this.activeSparePoolBundledItemCount = activeSparePoolBundledItemCount;
    }

    /**
     * A count of a history of billing items which a billing item has been associated with.
     */
    @ApiProperty
    protected Long associatedBillingItemHistoryCount;

    public Long getAssociatedBillingItemHistoryCount() {
        return associatedBillingItemHistoryCount;
    }

    public void setAssociatedBillingItemHistoryCount(Long associatedBillingItemHistoryCount) {
        this.associatedBillingItemHistoryCount = associatedBillingItemHistoryCount;
    }

    /**
     * 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.
     */
    @ApiProperty
    protected Long associatedChildrenCount;

    public Long getAssociatedChildrenCount() {
        return associatedChildrenCount;
    }

    public void setAssociatedChildrenCount(Long associatedChildrenCount) {
        this.associatedChildrenCount = associatedChildrenCount;
    }

    /**
     * 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.
     */
    @ApiProperty
    protected Long associatedParentCount;

    public Long getAssociatedParentCount() {
        return associatedParentCount;
    }

    public void setAssociatedParentCount(Long associatedParentCount) {
        this.associatedParentCount = associatedParentCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long availableMatchingVlanCount;

    public Long getAvailableMatchingVlanCount() {
        return availableMatchingVlanCount;
    }

    public void setAvailableMatchingVlanCount(Long availableMatchingVlanCount) {
        this.availableMatchingVlanCount = availableMatchingVlanCount;
    }

    /**
     * A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future.
     */
    @ApiProperty
    protected Long billableChildrenCount;

    public Long getBillableChildrenCount() {
        return billableChildrenCount;
    }

    public void setBillableChildrenCount(Long billableChildrenCount) {
        this.billableChildrenCount = billableChildrenCount;
    }

    /**
     * A count of a Billing Item's bundled billing items
     */
    @ApiProperty
    protected Long bundleItemCount;

    public Long getBundleItemCount() {
        return bundleItemCount;
    }

    public void setBundleItemCount(Long bundleItemCount) {
        this.bundleItemCount = bundleItemCount;
    }

    /**
     * A count of a Billing Item's bundled billing items'
     */
    @ApiProperty
    protected Long bundledItemCount;

    public Long getBundledItemCount() {
        return bundledItemCount;
    }

    public void setBundledItemCount(Long bundledItemCount) {
        this.bundledItemCount = bundledItemCount;
    }

    /**
     * A count of a Billing Item's active child billing items.
     */
    @ApiProperty
    protected Long canceledChildrenCount;

    public Long getCanceledChildrenCount() {
        return canceledChildrenCount;
    }

    public void setCanceledChildrenCount(Long canceledChildrenCount) {
        this.canceledChildrenCount = canceledChildrenCount;
    }

    /**
     * A count of this will return any cancellation requests that are associated with this billing item.
     */
    @ApiProperty
    protected Long cancellationRequestCount;

    public Long getCancellationRequestCount() {
        return cancellationRequestCount;
    }

    public void setCancellationRequestCount(Long cancellationRequestCount) {
        this.cancellationRequestCount = cancellationRequestCount;
    }

    /**
     * A count of a Billing Item's child billing items'
     */
    @ApiProperty
    protected Long childrenCount;

    public Long getChildrenCount() {
        return childrenCount;
    }

    public void setChildrenCount(Long childrenCount) {
        this.childrenCount = childrenCount;
    }

    /**
     * A count of a Billing Item's active child billing items.
     */
    @ApiProperty
    protected Long childrenWithActiveAgreementCount;

    public Long getChildrenWithActiveAgreementCount() {
        return childrenWithActiveAgreementCount;
    }

    public void setChildrenWithActiveAgreementCount(Long childrenWithActiveAgreementCount) {
        this.childrenWithActiveAgreementCount = childrenWithActiveAgreementCount;
    }

    /**
     * A count of for product items which have a downgrade path defined, this will return those product items.
     */
    @ApiProperty
    protected Long downgradeItemCount;

    public Long getDowngradeItemCount() {
        return downgradeItemCount;
    }

    public void setDowngradeItemCount(Long downgradeItemCount) {
        this.downgradeItemCount = downgradeItemCount;
    }

    /**
     * A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.
     */
    @ApiProperty
    protected Long filteredNextInvoiceChildrenCount;

    public Long getFilteredNextInvoiceChildrenCount() {
        return filteredNextInvoiceChildrenCount;
    }

    public void setFilteredNextInvoiceChildrenCount(Long filteredNextInvoiceChildrenCount) {
        this.filteredNextInvoiceChildrenCount = filteredNextInvoiceChildrenCount;
    }

    /**
     * A count of all invoice items associated with the billing item
     */
    @ApiProperty
    protected Long invoiceItemCount;

    public Long getInvoiceItemCount() {
        return invoiceItemCount;
    }

    public void setInvoiceItemCount(Long invoiceItemCount) {
        this.invoiceItemCount = invoiceItemCount;
    }

    /**
     * A count of a Billing Item's child billing items and associated items'
     */
    @ApiProperty
    protected Long nextInvoiceChildrenCount;

    public Long getNextInvoiceChildrenCount() {
        return nextInvoiceChildrenCount;
    }

    public void setNextInvoiceChildrenCount(Long nextInvoiceChildrenCount) {
        this.nextInvoiceChildrenCount = nextInvoiceChildrenCount;
    }

    /**
     * A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.
     */
    @ApiProperty
    protected Long nonZeroNextInvoiceChildrenCount;

    public Long getNonZeroNextInvoiceChildrenCount() {
        return nonZeroNextInvoiceChildrenCount;
    }

    public void setNonZeroNextInvoiceChildrenCount(Long nonZeroNextInvoiceChildrenCount) {
        this.nonZeroNextInvoiceChildrenCount = nonZeroNextInvoiceChildrenCount;
    }

    /**
     * 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.
     */
    @ApiProperty
    protected Long upgradeItemCount;

    public Long getUpgradeItemCount() {
        return upgradeItemCount;
    }

    public void setUpgradeItemCount(Long upgradeItemCount) {
        this.upgradeItemCount = upgradeItemCount;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * 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 SoftLayer_Billing_Item
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Billing_Item")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Cancel the resource or service for a billing Item. By default the billing item will be cancelled immediately and reclaim of the resource will begin shortly. Setting the "cancelImmediately" property to false will delay the cancellation until the next bill date. 

         * 

         * 

         * * The reason parameter could be from the list below:

         * * "No longer needed"

         * * "Business closing down"

         * * "Server / Upgrade Costs"

         * * "Migrating to larger server"

         * * "Migrating to smaller server"

         * * "Migrating to a different SoftLayer datacenter"

         * * "Network performance / latency"

         * * "Support response / timing"

         * * "Sales process / upgrades"

         * * "Moving to competitor"
         *
         * @see SoftLayer_Billing_Item::cancelItem
         */
        @ApiMethod(instanceRequired = true)
        public Boolean cancelItem(Boolean cancelImmediately, Boolean cancelAssociatedBillingItems, String reason, String customerNote);

        /**
         * Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. 
         *
         * @see SoftLayer_Billing_Item::cancelService
         */
        @ApiMethod(instanceRequired = true)
        public Boolean cancelService();

        /**
         * Cancel the resource or service for a billing Item 
         *
         * @see SoftLayer_Billing_Item::cancelServiceOnAnniversaryDate
         */
        @ApiMethod(instanceRequired = true)
        public Boolean cancelServiceOnAnniversaryDate();

        /**
         * getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are "parent" billing items and "child" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered "child" billing items. 
         *
         * @see SoftLayer_Billing_Item::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Item getObject();

        /**
         * This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [[SoftLayer_Security_Certificate_Request|service cancellation]] service. 

         * 

         * In order to find billing items for cancellation, use [[SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories|product categories]] service to retrieve category codes that are eligible for cancellation. 
         *
         * @see SoftLayer_Billing_Item::getServiceBillingItemsByCategory
         */
        @ApiMethod
        public List getServiceBillingItemsByCategory(String categoryCode, Boolean includeZeroRecurringFee);

        /**
         * Remove the association from a billing item. 
         *
         * @see SoftLayer_Billing_Item::removeAssociationId
         */
        @ApiMethod(instanceRequired = true)
        public Boolean removeAssociationId();

        /**
         * Set an associated billing item to an orphan billing item. Associations allow you to tie an "orphaned" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. 
         *
         * @see SoftLayer_Billing_Item::setAssociationId
         */
        @ApiMethod(instanceRequired = true)
        public Boolean setAssociationId(Long associatedId);

        /**
         * Void a previously made cancellation for a service 
         *
         * @see SoftLayer_Billing_Item::voidCancelService
         */
        @ApiMethod(instanceRequired = true)
        public Boolean voidCancelService();

        /**
         * The account that a billing item belongs to.
         *
         * @see SoftLayer_Billing_Item::getAccount
         */
        @ApiMethod(instanceRequired = true)
        public Account getAccount();

        /**
         * @see SoftLayer_Billing_Item::getActiveAgreement
         */
        @ApiMethod(instanceRequired = true)
        public Agreement getActiveAgreement();

        /**
         * A flag indicating that the billing item is under an active agreement.
         *
         * @see SoftLayer_Billing_Item::getActiveAgreementFlag
         */
        @ApiMethod(instanceRequired = true)
        public Agreement getActiveAgreementFlag();

        /**
         * A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item.
         *
         * @see SoftLayer_Billing_Item::getActiveAssociatedChildren
         */
        @ApiMethod(instanceRequired = true)
        public List getActiveAssociatedChildren();

        /**
         * @see SoftLayer_Billing_Item::getActiveAssociatedGuestDiskBillingItems
         */
        @ApiMethod(instanceRequired = true)
        public List getActiveAssociatedGuestDiskBillingItems();

        /**
         * A Billing Item's active bundled billing items.
         *
         * @see SoftLayer_Billing_Item::getActiveBundledItems
         */
        @ApiMethod(instanceRequired = true)
        public List getActiveBundledItems();

        /**
         * A service cancellation request item that corresponds to the billing item.
         *
         * @see SoftLayer_Billing_Item::getActiveCancellationItem
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.billing.item.cancellation.request.Item getActiveCancellationItem();

        /**
         * A Billing Item's active child billing items.
         *
         * @see SoftLayer_Billing_Item::getActiveChildren
         */
        @ApiMethod(instanceRequired = true)
        public List getActiveChildren();

        /**
         * @see SoftLayer_Billing_Item::getActiveFlag
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getActiveFlag();

        /**
         * @see SoftLayer_Billing_Item::getActiveSparePoolAssociatedGuestDiskBillingItems
         */
        @ApiMethod(instanceRequired = true)
        public List getActiveSparePoolAssociatedGuestDiskBillingItems();

        /**
         * A Billing Item's spare pool bundled billing items.
         *
         * @see SoftLayer_Billing_Item::getActiveSparePoolBundledItems
         */
        @ApiMethod(instanceRequired = true)
        public List getActiveSparePoolBundledItems();

        /**
         * 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.
         *
         * @see SoftLayer_Billing_Item::getAssociatedBillingItem
         */
        @ApiMethod(instanceRequired = true)
        public Item getAssociatedBillingItem();

        /**
         * A history of billing items which a billing item has been associated with.
         *
         * @see SoftLayer_Billing_Item::getAssociatedBillingItemHistory
         */
        @ApiMethod(instanceRequired = true)
        public List getAssociatedBillingItemHistory();

        /**
         * A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item.
         *
         * @see SoftLayer_Billing_Item::getAssociatedChildren
         */
        @ApiMethod(instanceRequired = true)
        public List getAssociatedChildren();

        /**
         * A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.
         *
         * @see SoftLayer_Billing_Item::getAssociatedParent
         */
        @ApiMethod(instanceRequired = true)
        public List getAssociatedParent();

        /**
         * @see SoftLayer_Billing_Item::getAvailableMatchingVlans
         */
        @ApiMethod(instanceRequired = true)
        public List getAvailableMatchingVlans();

        /**
         * The bandwidth allocation for a billing item.
         *
         * @see SoftLayer_Billing_Item::getBandwidthAllocation
         */
        @ApiMethod(instanceRequired = true)
        public Allocation getBandwidthAllocation();

        /**
         * A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.
         *
         * @see SoftLayer_Billing_Item::getBillableChildren
         */
        @ApiMethod(instanceRequired = true)
        public List getBillableChildren();

        /**
         * A Billing Item's bundled billing items
         *
         * @see SoftLayer_Billing_Item::getBundleItems
         */
        @ApiMethod(instanceRequired = true)
        public List getBundleItems();

        /**
         * A Billing Item's bundled billing items'
         *
         * @see SoftLayer_Billing_Item::getBundledItems
         */
        @ApiMethod(instanceRequired = true)
        public List getBundledItems();

        /**
         * A Billing Item's active child billing items.
         *
         * @see SoftLayer_Billing_Item::getCanceledChildren
         */
        @ApiMethod(instanceRequired = true)
        public List getCanceledChildren();

        /**
         * The billing item's cancellation reason.
         *
         * @see SoftLayer_Billing_Item::getCancellationReason
         */
        @ApiMethod(instanceRequired = true)
        public Reason getCancellationReason();

        /**
         * This will return any cancellation requests that are associated with this billing item.
         *
         * @see SoftLayer_Billing_Item::getCancellationRequests
         */
        @ApiMethod(instanceRequired = true)
        public List getCancellationRequests();

        /**
         * The item category to which the billing item's item belongs. 
         *
         * @see SoftLayer_Billing_Item::getCategory
         */
        @ApiMethod(instanceRequired = true)
        public Category getCategory();

        /**
         * A Billing Item's child billing items'
         *
         * @see SoftLayer_Billing_Item::getChildren
         */
        @ApiMethod(instanceRequired = true)
        public List getChildren();

        /**
         * A Billing Item's active child billing items.
         *
         * @see SoftLayer_Billing_Item::getChildrenWithActiveAgreement
         */
        @ApiMethod(instanceRequired = true)
        public List getChildrenWithActiveAgreement();

        /**
         * For product items which have a downgrade path defined, this will return those product items.
         *
         * @see SoftLayer_Billing_Item::getDowngradeItems
         */
        @ApiMethod(instanceRequired = true)
        public List getDowngradeItems();

        /**
         * A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.
         *
         * @see SoftLayer_Billing_Item::getFilteredNextInvoiceChildren
         */
        @ApiMethod(instanceRequired = true)
        public List getFilteredNextInvoiceChildren();

        /**
         * A flag that will reflect whether this billing item is billed on an hourly basis or not.
         *
         * @see SoftLayer_Billing_Item::getHourlyFlag
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getHourlyFlag();

        /**
         * Invoice items associated with this billing item
         *
         * @see SoftLayer_Billing_Item::getInvoiceItem
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.billing.invoice.Item getInvoiceItem();

        /**
         * All invoice items associated with the billing item
         *
         * @see SoftLayer_Billing_Item::getInvoiceItems
         */
        @ApiMethod(instanceRequired = true)
        public List getInvoiceItems();

        /**
         * The entry in the SoftLayer product catalog that a billing item is based upon.
         *
         * @see SoftLayer_Billing_Item::getItem
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.product.Item getItem();

        /**
         * 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.
         *
         * @see SoftLayer_Billing_Item::getLocation
         */
        @ApiMethod(instanceRequired = true)
        public Location getLocation();

        /**
         * A Billing Item's child billing items and associated items'
         *
         * @see SoftLayer_Billing_Item::getNextInvoiceChildren
         */
        @ApiMethod(instanceRequired = true)
        public List getNextInvoiceChildren();

        /**
         * A Billing Item's total, including any child billing items if they exist.'
         *
         * @see SoftLayer_Billing_Item::getNextInvoiceTotalOneTimeAmount
         */
        @ApiMethod(instanceRequired = true)
        public BigDecimal getNextInvoiceTotalOneTimeAmount();

        /**
         * A Billing Item's total, including any child billing items if they exist.'
         *
         * @see SoftLayer_Billing_Item::getNextInvoiceTotalOneTimeTaxAmount
         */
        @ApiMethod(instanceRequired = true)
        public BigDecimal getNextInvoiceTotalOneTimeTaxAmount();

        /**
         * A Billing Item's total, including any child billing items and associated billing items if they exist.'
         *
         * @see SoftLayer_Billing_Item::getNextInvoiceTotalRecurringAmount
         */
        @ApiMethod(instanceRequired = true)
        public BigDecimal getNextInvoiceTotalRecurringAmount();

        /**
         * This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.
         *
         * @see SoftLayer_Billing_Item::getNextInvoiceTotalRecurringTaxAmount
         */
        @ApiMethod(instanceRequired = true)
        public BigDecimal getNextInvoiceTotalRecurringTaxAmount();

        /**
         * A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.
         *
         * @see SoftLayer_Billing_Item::getNonZeroNextInvoiceChildren
         */
        @ApiMethod(instanceRequired = true)
        public List getNonZeroNextInvoiceChildren();

        /**
         * A billing item's original order item. Simply a reference to the original order from which this billing item was created.
         *
         * @see SoftLayer_Billing_Item::getOrderItem
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.billing.order.Item getOrderItem();

        /**
         * The original physical location for this billing item--may differ from current.
         *
         * @see SoftLayer_Billing_Item::getOriginalLocation
         */
        @ApiMethod(instanceRequired = true)
        public Location getOriginalLocation();

        /**
         * The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.
         *
         * @see SoftLayer_Billing_Item::getItemPackage
         */
        @ApiMethod(instanceRequired = true)
        public Package getItemPackage();

        /**
         * A billing item's parent item. If a billing item has no parent item then this value is null.
         *
         * @see SoftLayer_Billing_Item::getParent
         */
        @ApiMethod(instanceRequired = true)
        public Item getParent();

        /**
         * A billing item's parent item. If a billing item has no parent item then this value is null.
         *
         * @see SoftLayer_Billing_Item::getParentVirtualGuestBillingItem
         */
        @ApiMethod(instanceRequired = true)
        public Guest getParentVirtualGuestBillingItem();

        /**
         * This flag indicates whether a billing item is scheduled to be canceled or not.
         *
         * @see SoftLayer_Billing_Item::getPendingCancellationFlag
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getPendingCancellationFlag();

        /**
         * The new order item that will replace this billing item.
         *
         * @see SoftLayer_Billing_Item::getPendingOrderItem
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.billing.order.Item getPendingOrderItem();

        /**
         * Provisioning transaction for this billing item
         *
         * @see SoftLayer_Billing_Item::getProvisionTransaction
         */
        @ApiMethod(instanceRequired = true)
        public Transaction getProvisionTransaction();

        /**
         * A friendly description of software component
         *
         * @see SoftLayer_Billing_Item::getSoftwareDescription
         */
        @ApiMethod(instanceRequired = true)
        public Description getSoftwareDescription();

        /**
         * Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.
         *
         * @see SoftLayer_Billing_Item::getUpgradeItem
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.product.Item getUpgradeItem();

        /**
         * Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.
         *
         * @see SoftLayer_Billing_Item::getUpgradeItems
         */
        @ApiMethod(instanceRequired = true)
        public List getUpgradeItems();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#cancelItem}
         */
        public Future cancelItem(Boolean cancelImmediately, Boolean cancelAssociatedBillingItems, String reason, String customerNote);

        public Future cancelItem(Boolean cancelImmediately, Boolean cancelAssociatedBillingItems, String reason, String customerNote, ResponseHandler callback);

        /**
         * Async version of {@link Service#cancelService}
         */
        public Future cancelService();

        public Future cancelService(ResponseHandler callback);

        /**
         * Async version of {@link Service#cancelServiceOnAnniversaryDate}
         */
        public Future cancelServiceOnAnniversaryDate();

        public Future cancelServiceOnAnniversaryDate(ResponseHandler callback);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

        /**
         * Async version of {@link Service#getServiceBillingItemsByCategory}
         */
        public Future> getServiceBillingItemsByCategory(String categoryCode, Boolean includeZeroRecurringFee);

        public Future getServiceBillingItemsByCategory(String categoryCode, Boolean includeZeroRecurringFee, ResponseHandler> callback);

        /**
         * Async version of {@link Service#removeAssociationId}
         */
        public Future removeAssociationId();

        public Future removeAssociationId(ResponseHandler callback);

        /**
         * Async version of {@link Service#setAssociationId}
         */
        public Future setAssociationId(Long associatedId);

        public Future setAssociationId(Long associatedId, ResponseHandler callback);

        /**
         * Async version of {@link Service#voidCancelService}
         */
        public Future voidCancelService();

        public Future voidCancelService(ResponseHandler callback);

        /**
         * Async version of {@link Service#getAccount}
         */
        public Future getAccount();

        /**
         * Async callback version of {@link Service#getAccount}
         */
        public Future getAccount(ResponseHandler callback);

        /**
         * Async version of {@link Service#getActiveAgreement}
         */
        public Future getActiveAgreement();

        /**
         * Async callback version of {@link Service#getActiveAgreement}
         */
        public Future getActiveAgreement(ResponseHandler callback);

        /**
         * Async version of {@link Service#getActiveAgreementFlag}
         */
        public Future getActiveAgreementFlag();

        /**
         * Async callback version of {@link Service#getActiveAgreementFlag}
         */
        public Future getActiveAgreementFlag(ResponseHandler callback);

        /**
         * Async version of {@link Service#getActiveAssociatedChildren}
         */
        public Future> getActiveAssociatedChildren();

        /**
         * Async callback version of {@link Service#getActiveAssociatedChildren}
         */
        public Future getActiveAssociatedChildren(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getActiveAssociatedGuestDiskBillingItems}
         */
        public Future> getActiveAssociatedGuestDiskBillingItems();

        /**
         * Async callback version of {@link Service#getActiveAssociatedGuestDiskBillingItems}
         */
        public Future getActiveAssociatedGuestDiskBillingItems(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getActiveBundledItems}
         */
        public Future> getActiveBundledItems();

        /**
         * Async callback version of {@link Service#getActiveBundledItems}
         */
        public Future getActiveBundledItems(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getActiveCancellationItem}
         */
        public Future getActiveCancellationItem();

        /**
         * Async callback version of {@link Service#getActiveCancellationItem}
         */
        public Future getActiveCancellationItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getActiveChildren}
         */
        public Future> getActiveChildren();

        /**
         * Async callback version of {@link Service#getActiveChildren}
         */
        public Future getActiveChildren(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getActiveFlag}
         */
        public Future getActiveFlag();

        /**
         * Async callback version of {@link Service#getActiveFlag}
         */
        public Future getActiveFlag(ResponseHandler callback);

        /**
         * Async version of {@link Service#getActiveSparePoolAssociatedGuestDiskBillingItems}
         */
        public Future> getActiveSparePoolAssociatedGuestDiskBillingItems();

        /**
         * Async callback version of {@link Service#getActiveSparePoolAssociatedGuestDiskBillingItems}
         */
        public Future getActiveSparePoolAssociatedGuestDiskBillingItems(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getActiveSparePoolBundledItems}
         */
        public Future> getActiveSparePoolBundledItems();

        /**
         * Async callback version of {@link Service#getActiveSparePoolBundledItems}
         */
        public Future getActiveSparePoolBundledItems(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getAssociatedBillingItem}
         */
        public Future getAssociatedBillingItem();

        /**
         * Async callback version of {@link Service#getAssociatedBillingItem}
         */
        public Future getAssociatedBillingItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getAssociatedBillingItemHistory}
         */
        public Future> getAssociatedBillingItemHistory();

        /**
         * Async callback version of {@link Service#getAssociatedBillingItemHistory}
         */
        public Future getAssociatedBillingItemHistory(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getAssociatedChildren}
         */
        public Future> getAssociatedChildren();

        /**
         * Async callback version of {@link Service#getAssociatedChildren}
         */
        public Future getAssociatedChildren(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getAssociatedParent}
         */
        public Future> getAssociatedParent();

        /**
         * Async callback version of {@link Service#getAssociatedParent}
         */
        public Future getAssociatedParent(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getAvailableMatchingVlans}
         */
        public Future> getAvailableMatchingVlans();

        /**
         * Async callback version of {@link Service#getAvailableMatchingVlans}
         */
        public Future getAvailableMatchingVlans(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getBandwidthAllocation}
         */
        public Future getBandwidthAllocation();

        /**
         * Async callback version of {@link Service#getBandwidthAllocation}
         */
        public Future getBandwidthAllocation(ResponseHandler callback);

        /**
         * Async version of {@link Service#getBillableChildren}
         */
        public Future> getBillableChildren();

        /**
         * Async callback version of {@link Service#getBillableChildren}
         */
        public Future getBillableChildren(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getBundleItems}
         */
        public Future> getBundleItems();

        /**
         * Async callback version of {@link Service#getBundleItems}
         */
        public Future getBundleItems(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getBundledItems}
         */
        public Future> getBundledItems();

        /**
         * Async callback version of {@link Service#getBundledItems}
         */
        public Future getBundledItems(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getCanceledChildren}
         */
        public Future> getCanceledChildren();

        /**
         * Async callback version of {@link Service#getCanceledChildren}
         */
        public Future getCanceledChildren(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getCancellationReason}
         */
        public Future getCancellationReason();

        /**
         * Async callback version of {@link Service#getCancellationReason}
         */
        public Future getCancellationReason(ResponseHandler callback);

        /**
         * Async version of {@link Service#getCancellationRequests}
         */
        public Future> getCancellationRequests();

        /**
         * Async callback version of {@link Service#getCancellationRequests}
         */
        public Future getCancellationRequests(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getCategory}
         */
        public Future getCategory();

        /**
         * Async callback version of {@link Service#getCategory}
         */
        public Future getCategory(ResponseHandler callback);

        /**
         * Async version of {@link Service#getChildren}
         */
        public Future> getChildren();

        /**
         * Async callback version of {@link Service#getChildren}
         */
        public Future getChildren(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getChildrenWithActiveAgreement}
         */
        public Future> getChildrenWithActiveAgreement();

        /**
         * Async callback version of {@link Service#getChildrenWithActiveAgreement}
         */
        public Future getChildrenWithActiveAgreement(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getDowngradeItems}
         */
        public Future> getDowngradeItems();

        /**
         * Async callback version of {@link Service#getDowngradeItems}
         */
        public Future getDowngradeItems(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getFilteredNextInvoiceChildren}
         */
        public Future> getFilteredNextInvoiceChildren();

        /**
         * Async callback version of {@link Service#getFilteredNextInvoiceChildren}
         */
        public Future getFilteredNextInvoiceChildren(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getHourlyFlag}
         */
        public Future getHourlyFlag();

        /**
         * Async callback version of {@link Service#getHourlyFlag}
         */
        public Future getHourlyFlag(ResponseHandler callback);

        /**
         * Async version of {@link Service#getInvoiceItem}
         */
        public Future getInvoiceItem();

        /**
         * Async callback version of {@link Service#getInvoiceItem}
         */
        public Future getInvoiceItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getInvoiceItems}
         */
        public Future> getInvoiceItems();

        /**
         * Async callback version of {@link Service#getInvoiceItems}
         */
        public Future getInvoiceItems(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getItem}
         */
        public Future getItem();

        /**
         * Async callback version of {@link Service#getItem}
         */
        public Future getItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getLocation}
         */
        public Future getLocation();

        /**
         * Async callback version of {@link Service#getLocation}
         */
        public Future getLocation(ResponseHandler callback);

        /**
         * Async version of {@link Service#getNextInvoiceChildren}
         */
        public Future> getNextInvoiceChildren();

        /**
         * Async callback version of {@link Service#getNextInvoiceChildren}
         */
        public Future getNextInvoiceChildren(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getNextInvoiceTotalOneTimeAmount}
         */
        public Future getNextInvoiceTotalOneTimeAmount();

        /**
         * Async callback version of {@link Service#getNextInvoiceTotalOneTimeAmount}
         */
        public Future getNextInvoiceTotalOneTimeAmount(ResponseHandler callback);

        /**
         * Async version of {@link Service#getNextInvoiceTotalOneTimeTaxAmount}
         */
        public Future getNextInvoiceTotalOneTimeTaxAmount();

        /**
         * Async callback version of {@link Service#getNextInvoiceTotalOneTimeTaxAmount}
         */
        public Future getNextInvoiceTotalOneTimeTaxAmount(ResponseHandler callback);

        /**
         * Async version of {@link Service#getNextInvoiceTotalRecurringAmount}
         */
        public Future getNextInvoiceTotalRecurringAmount();

        /**
         * Async callback version of {@link Service#getNextInvoiceTotalRecurringAmount}
         */
        public Future getNextInvoiceTotalRecurringAmount(ResponseHandler callback);

        /**
         * Async version of {@link Service#getNextInvoiceTotalRecurringTaxAmount}
         */
        public Future getNextInvoiceTotalRecurringTaxAmount();

        /**
         * Async callback version of {@link Service#getNextInvoiceTotalRecurringTaxAmount}
         */
        public Future getNextInvoiceTotalRecurringTaxAmount(ResponseHandler callback);

        /**
         * Async version of {@link Service#getNonZeroNextInvoiceChildren}
         */
        public Future> getNonZeroNextInvoiceChildren();

        /**
         * Async callback version of {@link Service#getNonZeroNextInvoiceChildren}
         */
        public Future getNonZeroNextInvoiceChildren(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getOrderItem}
         */
        public Future getOrderItem();

        /**
         * Async callback version of {@link Service#getOrderItem}
         */
        public Future getOrderItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getOriginalLocation}
         */
        public Future getOriginalLocation();

        /**
         * Async callback version of {@link Service#getOriginalLocation}
         */
        public Future getOriginalLocation(ResponseHandler callback);

        /**
         * Async version of {@link Service#getItemPackage}
         */
        public Future getItemPackage();

        /**
         * Async callback version of {@link Service#getItemPackage}
         */
        public Future getItemPackage(ResponseHandler callback);

        /**
         * Async version of {@link Service#getParent}
         */
        public Future getParent();

        /**
         * Async callback version of {@link Service#getParent}
         */
        public Future getParent(ResponseHandler callback);

        /**
         * Async version of {@link Service#getParentVirtualGuestBillingItem}
         */
        public Future getParentVirtualGuestBillingItem();

        /**
         * Async callback version of {@link Service#getParentVirtualGuestBillingItem}
         */
        public Future getParentVirtualGuestBillingItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getPendingCancellationFlag}
         */
        public Future getPendingCancellationFlag();

        /**
         * Async callback version of {@link Service#getPendingCancellationFlag}
         */
        public Future getPendingCancellationFlag(ResponseHandler callback);

        /**
         * Async version of {@link Service#getPendingOrderItem}
         */
        public Future getPendingOrderItem();

        /**
         * Async callback version of {@link Service#getPendingOrderItem}
         */
        public Future getPendingOrderItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getProvisionTransaction}
         */
        public Future getProvisionTransaction();

        /**
         * Async callback version of {@link Service#getProvisionTransaction}
         */
        public Future getProvisionTransaction(ResponseHandler callback);

        /**
         * Async version of {@link Service#getSoftwareDescription}
         */
        public Future getSoftwareDescription();

        /**
         * Async callback version of {@link Service#getSoftwareDescription}
         */
        public Future getSoftwareDescription(ResponseHandler callback);

        /**
         * Async version of {@link Service#getUpgradeItem}
         */
        public Future getUpgradeItem();

        /**
         * Async callback version of {@link Service#getUpgradeItem}
         */
        public Future getUpgradeItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getUpgradeItems}
         */
        public Future> getUpgradeItems();

        /**
         * Async callback version of {@link Service#getUpgradeItems}
         */
        public Future getUpgradeItems(ResponseHandler> callback);

    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public com.softlayer.api.service.Account.Mask account() {
            return withSubMask("account", com.softlayer.api.service.Account.Mask.class);
        }

        public com.softlayer.api.service.account.Agreement.Mask activeAgreement() {
            return withSubMask("activeAgreement", com.softlayer.api.service.account.Agreement.Mask.class);
        }

        public com.softlayer.api.service.account.Agreement.Mask activeAgreementFlag() {
            return withSubMask("activeAgreementFlag", com.softlayer.api.service.account.Agreement.Mask.class);
        }

        public Item.Mask activeAssociatedChildren() {
            return withSubMask("activeAssociatedChildren", Item.Mask.class);
        }

        public Item.Mask activeAssociatedGuestDiskBillingItems() {
            return withSubMask("activeAssociatedGuestDiskBillingItems", Item.Mask.class);
        }

        public Item.Mask activeBundledItems() {
            return withSubMask("activeBundledItems", Item.Mask.class);
        }

        public com.softlayer.api.service.billing.item.cancellation.request.Item.Mask activeCancellationItem() {
            return withSubMask("activeCancellationItem", com.softlayer.api.service.billing.item.cancellation.request.Item.Mask.class);
        }

        public Item.Mask activeChildren() {
            return withSubMask("activeChildren", Item.Mask.class);
        }

        public Mask activeFlag() {
            withLocalProperty("activeFlag");
            return this;
        }

        public Item.Mask activeSparePoolAssociatedGuestDiskBillingItems() {
            return withSubMask("activeSparePoolAssociatedGuestDiskBillingItems", Item.Mask.class);
        }

        public Item.Mask activeSparePoolBundledItems() {
            return withSubMask("activeSparePoolBundledItems", Item.Mask.class);
        }

        public Item.Mask associatedBillingItem() {
            return withSubMask("associatedBillingItem", Item.Mask.class);
        }

        public com.softlayer.api.service.billing.item.association.History.Mask associatedBillingItemHistory() {
            return withSubMask("associatedBillingItemHistory", com.softlayer.api.service.billing.item.association.History.Mask.class);
        }

        public Item.Mask associatedChildren() {
            return withSubMask("associatedChildren", Item.Mask.class);
        }

        public Item.Mask associatedParent() {
            return withSubMask("associatedParent", Item.Mask.class);
        }

        public com.softlayer.api.service.network.Vlan.Mask availableMatchingVlans() {
            return withSubMask("availableMatchingVlans", com.softlayer.api.service.network.Vlan.Mask.class);
        }

        public com.softlayer.api.service.network.bandwidth.version1.Allocation.Mask bandwidthAllocation() {
            return withSubMask("bandwidthAllocation", com.softlayer.api.service.network.bandwidth.version1.Allocation.Mask.class);
        }

        public Item.Mask billableChildren() {
            return withSubMask("billableChildren", Item.Mask.class);
        }

        public com.softlayer.api.service.product.item.Bundles.Mask bundleItems() {
            return withSubMask("bundleItems", com.softlayer.api.service.product.item.Bundles.Mask.class);
        }

        public Item.Mask bundledItems() {
            return withSubMask("bundledItems", Item.Mask.class);
        }

        public Item.Mask canceledChildren() {
            return withSubMask("canceledChildren", Item.Mask.class);
        }

        public com.softlayer.api.service.billing.item.cancellation.Reason.Mask cancellationReason() {
            return withSubMask("cancellationReason", com.softlayer.api.service.billing.item.cancellation.Reason.Mask.class);
        }

        public com.softlayer.api.service.billing.item.cancellation.Request.Mask cancellationRequests() {
            return withSubMask("cancellationRequests", com.softlayer.api.service.billing.item.cancellation.Request.Mask.class);
        }

        public com.softlayer.api.service.product.item.Category.Mask category() {
            return withSubMask("category", com.softlayer.api.service.product.item.Category.Mask.class);
        }

        public Item.Mask children() {
            return withSubMask("children", Item.Mask.class);
        }

        public Item.Mask childrenWithActiveAgreement() {
            return withSubMask("childrenWithActiveAgreement", Item.Mask.class);
        }

        public com.softlayer.api.service.product.Item.Mask downgradeItems() {
            return withSubMask("downgradeItems", com.softlayer.api.service.product.Item.Mask.class);
        }

        public Item.Mask filteredNextInvoiceChildren() {
            return withSubMask("filteredNextInvoiceChildren", Item.Mask.class);
        }

        public Mask hourlyFlag() {
            withLocalProperty("hourlyFlag");
            return this;
        }

        public com.softlayer.api.service.billing.invoice.Item.Mask invoiceItem() {
            return withSubMask("invoiceItem", com.softlayer.api.service.billing.invoice.Item.Mask.class);
        }

        public com.softlayer.api.service.billing.invoice.Item.Mask invoiceItems() {
            return withSubMask("invoiceItems", com.softlayer.api.service.billing.invoice.Item.Mask.class);
        }

        public com.softlayer.api.service.product.Item.Mask item() {
            return withSubMask("item", com.softlayer.api.service.product.Item.Mask.class);
        }

        public com.softlayer.api.service.Location.Mask location() {
            return withSubMask("location", com.softlayer.api.service.Location.Mask.class);
        }

        public Item.Mask nextInvoiceChildren() {
            return withSubMask("nextInvoiceChildren", Item.Mask.class);
        }

        public Mask nextInvoiceTotalOneTimeAmount() {
            withLocalProperty("nextInvoiceTotalOneTimeAmount");
            return this;
        }

        public Mask nextInvoiceTotalOneTimeTaxAmount() {
            withLocalProperty("nextInvoiceTotalOneTimeTaxAmount");
            return this;
        }

        public Mask nextInvoiceTotalRecurringAmount() {
            withLocalProperty("nextInvoiceTotalRecurringAmount");
            return this;
        }

        public Mask nextInvoiceTotalRecurringTaxAmount() {
            withLocalProperty("nextInvoiceTotalRecurringTaxAmount");
            return this;
        }

        public Item.Mask nonZeroNextInvoiceChildren() {
            return withSubMask("nonZeroNextInvoiceChildren", Item.Mask.class);
        }

        public com.softlayer.api.service.billing.order.Item.Mask orderItem() {
            return withSubMask("orderItem", com.softlayer.api.service.billing.order.Item.Mask.class);
        }

        public com.softlayer.api.service.Location.Mask originalLocation() {
            return withSubMask("originalLocation", com.softlayer.api.service.Location.Mask.class);
        }

        public com.softlayer.api.service.product.Package.Mask itemPackage() {
            return withSubMask("package", com.softlayer.api.service.product.Package.Mask.class);
        }

        public Item.Mask parent() {
            return withSubMask("parent", Item.Mask.class);
        }

        public com.softlayer.api.service.billing.item.virtual.Guest.Mask parentVirtualGuestBillingItem() {
            return withSubMask("parentVirtualGuestBillingItem", com.softlayer.api.service.billing.item.virtual.Guest.Mask.class);
        }

        public Mask pendingCancellationFlag() {
            withLocalProperty("pendingCancellationFlag");
            return this;
        }

        public com.softlayer.api.service.billing.order.Item.Mask pendingOrderItem() {
            return withSubMask("pendingOrderItem", com.softlayer.api.service.billing.order.Item.Mask.class);
        }

        public com.softlayer.api.service.provisioning.version1.Transaction.Mask provisionTransaction() {
            return withSubMask("provisionTransaction", com.softlayer.api.service.provisioning.version1.Transaction.Mask.class);
        }

        public com.softlayer.api.service.software.Description.Mask softwareDescription() {
            return withSubMask("softwareDescription", com.softlayer.api.service.software.Description.Mask.class);
        }

        public com.softlayer.api.service.product.Item.Mask upgradeItem() {
            return withSubMask("upgradeItem", com.softlayer.api.service.product.Item.Mask.class);
        }

        public com.softlayer.api.service.product.Item.Mask upgradeItems() {
            return withSubMask("upgradeItems", com.softlayer.api.service.product.Item.Mask.class);
        }

        public Mask allowCancellationFlag() {
            withLocalProperty("allowCancellationFlag");
            return this;
        }

        public Mask associatedBillingItemId() {
            withLocalProperty("associatedBillingItemId");
            return this;
        }

        public Mask cancellationDate() {
            withLocalProperty("cancellationDate");
            return this;
        }

        public Mask categoryCode() {
            withLocalProperty("categoryCode");
            return this;
        }

        public Mask createDate() {
            withLocalProperty("createDate");
            return this;
        }

        public Mask currentHourlyCharge() {
            withLocalProperty("currentHourlyCharge");
            return this;
        }

        public Mask cycleStartDate() {
            withLocalProperty("cycleStartDate");
            return this;
        }

        public Mask description() {
            withLocalProperty("description");
            return this;
        }

        public Mask domainName() {
            withLocalProperty("domainName");
            return this;
        }

        public Mask hostName() {
            withLocalProperty("hostName");
            return this;
        }

        public Mask hourlyRecurringFee() {
            withLocalProperty("hourlyRecurringFee");
            return this;
        }

        public Mask hoursUsed() {
            withLocalProperty("hoursUsed");
            return this;
        }

        public Mask id() {
            withLocalProperty("id");
            return this;
        }

        public Mask laborFee() {
            withLocalProperty("laborFee");
            return this;
        }

        public Mask laborFeeTaxRate() {
            withLocalProperty("laborFeeTaxRate");
            return this;
        }

        public Mask lastBillDate() {
            withLocalProperty("lastBillDate");
            return this;
        }

        public Mask modifyDate() {
            withLocalProperty("modifyDate");
            return this;
        }

        public Mask nextBillDate() {
            withLocalProperty("nextBillDate");
            return this;
        }

        public Mask notes() {
            withLocalProperty("notes");
            return this;
        }

        public Mask oneTimeFee() {
            withLocalProperty("oneTimeFee");
            return this;
        }

        public Mask oneTimeFeeTaxRate() {
            withLocalProperty("oneTimeFeeTaxRate");
            return this;
        }

        public Mask orderItemId() {
            withLocalProperty("orderItemId");
            return this;
        }

        public Mask parentId() {
            withLocalProperty("parentId");
            return this;
        }

        public Mask recurringFee() {
            withLocalProperty("recurringFee");
            return this;
        }

        public Mask recurringFeeTaxRate() {
            withLocalProperty("recurringFeeTaxRate");
            return this;
        }

        public Mask recurringMonths() {
            withLocalProperty("recurringMonths");
            return this;
        }

        public Mask serviceProviderId() {
            withLocalProperty("serviceProviderId");
            return this;
        }

        public Mask setupFee() {
            withLocalProperty("setupFee");
            return this;
        }

        public Mask setupFeeTaxRate() {
            withLocalProperty("setupFeeTaxRate");
            return this;
        }

        public Mask activeAssociatedChildrenCount() {
            withLocalProperty("activeAssociatedChildrenCount");
            return this;
        }

        public Mask activeAssociatedGuestDiskBillingItemCount() {
            withLocalProperty("activeAssociatedGuestDiskBillingItemCount");
            return this;
        }

        public Mask activeBundledItemCount() {
            withLocalProperty("activeBundledItemCount");
            return this;
        }

        public Mask activeChildrenCount() {
            withLocalProperty("activeChildrenCount");
            return this;
        }

        public Mask activeSparePoolAssociatedGuestDiskBillingItemCount() {
            withLocalProperty("activeSparePoolAssociatedGuestDiskBillingItemCount");
            return this;
        }

        public Mask activeSparePoolBundledItemCount() {
            withLocalProperty("activeSparePoolBundledItemCount");
            return this;
        }

        public Mask associatedBillingItemHistoryCount() {
            withLocalProperty("associatedBillingItemHistoryCount");
            return this;
        }

        public Mask associatedChildrenCount() {
            withLocalProperty("associatedChildrenCount");
            return this;
        }

        public Mask associatedParentCount() {
            withLocalProperty("associatedParentCount");
            return this;
        }

        public Mask availableMatchingVlanCount() {
            withLocalProperty("availableMatchingVlanCount");
            return this;
        }

        public Mask billableChildrenCount() {
            withLocalProperty("billableChildrenCount");
            return this;
        }

        public Mask bundleItemCount() {
            withLocalProperty("bundleItemCount");
            return this;
        }

        public Mask bundledItemCount() {
            withLocalProperty("bundledItemCount");
            return this;
        }

        public Mask canceledChildrenCount() {
            withLocalProperty("canceledChildrenCount");
            return this;
        }

        public Mask cancellationRequestCount() {
            withLocalProperty("cancellationRequestCount");
            return this;
        }

        public Mask childrenCount() {
            withLocalProperty("childrenCount");
            return this;
        }

        public Mask childrenWithActiveAgreementCount() {
            withLocalProperty("childrenWithActiveAgreementCount");
            return this;
        }

        public Mask downgradeItemCount() {
            withLocalProperty("downgradeItemCount");
            return this;
        }

        public Mask filteredNextInvoiceChildrenCount() {
            withLocalProperty("filteredNextInvoiceChildrenCount");
            return this;
        }

        public Mask invoiceItemCount() {
            withLocalProperty("invoiceItemCount");
            return this;
        }

        public Mask nextInvoiceChildrenCount() {
            withLocalProperty("nextInvoiceChildrenCount");
            return this;
        }

        public Mask nonZeroNextInvoiceChildrenCount() {
            withLocalProperty("nonZeroNextInvoiceChildrenCount");
            return this;
        }

        public Mask upgradeItemCount() {
            withLocalProperty("upgradeItemCount");
            return this;
        }

    }

}