SoftLayer Billing Invoice Item (type)

From SoftLayer Development Network Wiki

This page refers to the SoftLayer_Billing_Invoice_Item data type. For information on the SoftLayer_Billing_Invoice_Item service please see SoftLayer_Billing_Invoice_Item.

Contents 1 Overview 2 User Access 3 Local Properties 3.1 billingItemId 3.2 categoryCode 3.3 description 3.4 domainName 3.5 hostName 3.6 id 3.7 invoiceId 3.8 laborFee 3.9 laborFeeTaxRate 3.10 notes 3.11 oneTimeFee 3.12 oneTimeFeeTaxRate 3.13 parentId 3.14 recurringFee 3.15 recurringFeeTaxRate 3.16 setupFee 3.17 setupFeeTaxRate 4 Relational Properties 4.1 billingItem 4.2 category 4.3 children 4.4 invoice 4.5 location 4.6 parent 4.7 totalOneTimeAmount 4.8 totalOneTimeTaxAmount 4.9 totalRecurringAmount 4.10 totalRecurringTaxAmount 5 Count Properties 5.1 childrenCount 6 Associated Methods 7 See Also

Overview

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.

User Access

Users wishing to access the SoftLayer_Billing_Invoice_Item type must have the view account summary permission assigned to their account.

Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties.

Local Properties

billingItemId

The billing item from which this invoice item was generated.

• Type: integer
• Length: 10 digits

---

categoryCode

The item category of the invoice item being invoiced.

• Type: string
• Length: 30 characters

---

description

The item description for this invoice item.

• Type: string
• Length: 200 characters

---

domainName

The domain name of the invoiced item. This is only used on invoice items whose category is "server".

• Type: string
• Length: 100 characters

---

hostName

The Host name of the invoiced item. This is only used on invoice items whose category is "server".

• Type: string
• Length: 100 characters

---

id

The ID of the invoice item.

• Type: integer

---

invoiceId

The invoice to which this invoice item belongs.

• Type: integer
• Length: 10 digits

---

laborFee

This also a one-time fee of a special type.

• Type: decimal
• Length: 6 digits before the decimal point

---

laborFeeTaxRate

The tax rate at which the labor fee is taxed.

• Type: decimal
• Length: 1 digits before the decimal point

---

notes

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

• Type: string
• Length: 200 characters

---

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
• Length: 6 digits before the decimal point

---

oneTimeFeeTaxRate

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

• Type: decimal
• Length: 1 digits before the decimal point

---

parentId

The parent invoice item, usually the server invoice item.

• Type: integer
• Length: 10 digits

---

recurringFee

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

• Type: decimal
• Length: 6 digits before the decimal point

---

recurringFeeTaxRate

the rate at which the recurring fee is taxed.

• Type: decimal
• Length: 1 digits before the decimal point

---

setupFee

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

• Type: decimal
• Length: 6 digits before the decimal point

---

setupFeeTaxRate

The tax rate at which the setup fee is taxed.

• Type: decimal
• Length: 1 digits before the decimal point

Relational Properties

billingItem

An Invoice Item's billing item, from which this item was generated.
billingItem can be queried by object mask.
billingItem must be a unique value.

• Type: SoftLayer_Billing_Item

---

category

This invoice item's "item category".
category can be queried by object mask.
category must be a unique value.

• 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.
children can be queried by object mask.

• Type: SoftLayer_Billing_Invoice_ItemArray

---

invoice

The invoice to which this item belongs.
invoice can be queried by object mask.
invoice must be a unique value.

• Type: SoftLayer_Billing_Invoice

---

location

An invoice item's location, if one exists.'
location can be queried by object mask.
location must be a unique value.

• Type: SoftLayer_Location

---

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.
parent can be queried by object mask.
parent must be a unique value.

• Type: SoftLayer_Billing_Invoice_Item

---

totalOneTimeAmount

An invoice Item's total, including any child invoice items if they exist.
totalOneTimeAmount can be queried by object mask.
totalOneTimeAmount must be a unique value.

• Type: float

---

totalOneTimeTaxAmount

An invoice Item's total, including any child invoice items if they exist.
totalOneTimeTaxAmount can be queried by object mask.
totalOneTimeTaxAmount must be a unique value.

• Type: float

---

totalRecurringAmount

An invoice Item's total, including any child invoice items if they exist.
totalRecurringAmount can be queried by object mask.
totalRecurringAmount must be a unique value.

• Type: float

---

totalRecurringTaxAmount

A Billing Item's total, including any child billing items if they exist.'
totalRecurringTaxAmount can be queried by object mask.
totalRecurringTaxAmount must be a unique value.

• Type: float

Count Properties

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.
childrenCount must be a unique value.

• Type: unsigned long

Associated Methods

• SoftLayer_Billing_Invoice_Item::getObject

See Also

• SoftLayer_Billing_Invoice