SoftLayer_Billing_Invoice_Item


SoftLayer_Billing_Invoice_Item

Description

Each billing invoice item makes up a record within an invoice. This provides you with a detailed record of everything related to an invoice item. When you are billed, our system takes active billing items and creates an invoice. These invoice items are a copy of your active billing items, and make up the contents of your invoice.

Local


associatedInvoiceItemId

The associated invoice Item ID.
Type: int


billingItemId

The billing item from which this invoice item was generated.
Type: int


categoryCode

The item category of the invoice item being invoiced.
Type: string


createDate

The date the invoice item was created.
Type: dateTime


description

The item description for this invoice item.
Type: string


domainName

The domain name of the invoiced item. This is only used on invoice items whose category is “server”.
Type: string


endDate

The end date of the invoice item.
Type: dateTime


hostName

The Host name of the invoiced item. This is only used on invoice items whose category is “server”.
Type: string


hourlyRecurringFee

The hourly recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD)
Type: decimal


id

The ID of the invoice item.
Type: int


invoiceId

The invoice to which this invoice item belongs.
Type: int


laborAfterTaxAmount

An invoice item’s labor fee total after taxes. This does not include any child invoice items.
Type: decimal


laborFee

This also a one-time fee of a special type.
Type: decimal


laborFeeTaxRate

The tax rate at which the labor fee is taxed.
Type: decimal


laborTaxAmount

An invoice item’s labor tax amount. This does not include any child invoice items.
Type: decimal


notes

A note to help describe more about the item. This normally holds usernames, or some other bit of extra information.
Type: string


oneTimeAfterTaxAmount

An invoice item’s one-time fee total after taxes. This does not include any child invoice items.
Type: decimal


oneTimeFee

If there are any one-time charges assessed, it will show up here represented by a floating point decimal in US Dollars ($USD)
Type: decimal


oneTimeFeeTaxRate

The rate at which the one-time fee is taxed.
Type: decimal


oneTimeTaxAmount

An invoice item’s one-time tax amount. This does not include any child invoice items.
Type: decimal


packageId

This is the package id for this invoice item.
Type: int


parentId

The parent invoice item, usually the server invoice item.
Type: int


productItemId

The entry in the product catalog that a invoice item is based upon.
Type: int


recurringAfterTaxAmount

An invoice item’s recurring fee total after taxes. This does not include any child invoice items.
Type: decimal


recurringFee

The recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD)
Type: decimal


recurringFeeTaxRate

the rate at which the recurring fee is taxed.
Type: decimal


recurringTaxAmount

An invoice item’s recurring tax amount. This does not include any child invoice items.
Type: decimal


resourceTableId

A unique identifier for a SoftLayer Service that is associated to an invoice item.
Type: int


serviceProviderId

The service provider for the invoice item.
Type: int


setupAfterTaxAmount

An invoice item’s setup fee total after taxes. This does not include any child invoice items.
Type: decimal


setupFee

If there were any setup fees they will show up here. These are normally a one-time fee.
Type: decimal


setupFeeDeferralMonths

The number of months the setup fee is being deferred.
Type: int


setupFeeTaxRate

The tax rate at which the setup fee is taxed.
Type: decimal


setupTaxAmount

An invoice item’s setup tax amount. This does not include any child invoice items.
Type: decimal

Relational


associatedChildren

An Invoice Item’s associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.
Type: SoftLayer_Billing_Invoice_Item[]


associatedInvoiceItem

An Invoice Item’s associated invoice item. If this is populated, it means this is an orphaned invoice item, but logically belongs to the associated invoice item.
Type: SoftLayer_Billing_Invoice_Item


billingItem

An Invoice Item’s billing item, from which this item was generated.
Type: SoftLayer_Billing_Item


category

This invoice item’s “item category”.
Type: SoftLayer_Product_Item_Category


children

An Invoice Item’s child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children.
Type: SoftLayer_Billing_Invoice_Item[]


dPart

This is the DPart for invoice item.
Type: string


discountingInvoiceItemId

The invoice item ID from which the discount is derived.
Type: int


filteredAssociatedChildren

An Invoice Item’s associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.
Type: SoftLayer_Billing_Invoice_Item[]


hourlyFlag

Indicating whether this invoice item is billed on an hourly basis.
Type: boolean


invoice

The invoice to which this item belongs.
Type: SoftLayer_Billing_Invoice


location

An invoice item’s location, if one exists.'
Type: SoftLayer_Location


nonZeroAssociatedChildren

An Invoice Item’s associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.
Type: SoftLayer_Billing_Invoice_Item[]


parent

Every item tied to a server should have a parent invoice item which is the server line item. This is how we associate items to a server.
Type: SoftLayer_Billing_Invoice_Item


product

The entry in the product catalog that a invoice item is based upon.
Type: SoftLayer_Product_Item


topLevelProductGroupName

A string representing the name of parent level product group of an invoice item.
Type: string


totalOneTimeAmount

An invoice Item’s total, including any child invoice items if they exist.
Type: float


totalOneTimeTaxAmount

An invoice Item’s total, including any child invoice items if they exist.
Type: float


totalRecurringAmount

An invoice Item’s total, including any child invoice items if they exist.
Type: float


totalRecurringTaxAmount

A Billing Item’s total, including any child billing items if they exist.'
Type: float


usageChargeFlag

Indicating whether this invoice item is for the usage charge.
Type: boolean

Count


associatedChildrenCount

A count of an Invoice Item’s associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.
Type: unsignedLong


childrenCount

A count of an Invoice Item’s child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children.
Type: unsignedLong


filteredAssociatedChildrenCount

A count of an Invoice Item’s associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.
Type: unsignedLong


nonZeroAssociatedChildrenCount

A count of an Invoice Item’s associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.
Type: unsignedLong