SoftLayer Billing Invoice (type)

From SoftLayer Development Network Wiki

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

Contents 1 Overview 2 User Access 3 Local Properties 3.1 accountId 3.2 address1 3.3 address2 3.4 city 3.5 claimedTaxExemptTxFlag 3.6 closedDate 3.7 companyName 3.8 country 3.9 createDate 3.10 email 3.11 endingBalance 3.12 faxPhone 3.13 firstName 3.14 id 3.15 lastName 3.16 modifyDate 3.17 officePhone 3.18 postalCode 3.19 startingBalance 3.20 state 3.21 statusCode 3.22 typeCode 4 Relational Properties 4.1 account 4.2 amount 4.3 invoiceTopLevelItems 4.4 invoiceTotalAmount 4.5 invoiceTotalOneTimeAmount 4.6 invoiceTotalOneTimeTaxAmount 4.7 invoiceTotalRecurringAmount 4.8 invoiceTotalRecurringTaxAmount 4.9 items 4.10 payment 5 Count Properties 5.1 invoiceTopLevelItemCount 5.2 itemCount 6 Associated Methods 7 See Also

Overview

The SoftLayer_Billing_Invoice data type contains general information relating to an individual invoice applied to a SoftLayer customer account. Personal information in this type such as names, addresses, and phone numbers are taken from the account's contact information at the time the invoice is generated.

User Access

Users wishing to access the SoftLayer_Billing_Invoice type must have the view account summary and view account summary permissions 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

accountId

The SoftLayer customer account that an invoice belongs to.

• Type: integer
• Length: 10 digits

---

address1

The first line of an address belonging to an account at the time an invoice is created.

• Type: string
• Length: 100 characters

---

address2

The second line of an address belonging to an account at the time an invoice is created.

• Type: string
• Length: 100 characters

---

city

The city portion of an address belonging to an account at the time an invoice is created.

• Type: string
• Length: 100 characters

---

claimedTaxExemptTxFlag

Whether an account was exempt from taxes on their invoices at the time an invoice is created.

• Type: boolean

---

closedDate

The date an invoice was closed. Open invoices have a null closed date.

• Type: dateTime

---

companyName

The company name belonging to an account at the time an invoice is created.

• Type: string
• Length: 100 characters

---

country

A two-letter abbreviation of the country portion of an address belonging to an account at the time an invoice is created.

• Type: string
• Length: 2 characters

---

createDate

The date an invoice was created.

• Type: dateTime

---

email

The email address belonging to an account at the time an invoice is created.

• Type: string
• Length: 255 characters

---

endingBalance

An SoftLayer account's balance at the time an invoice is closed. This value is measured in US Dollar ($USD) currency.

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

---

faxPhone

The fax telephone number belonging to an account at the time an invoice is created.

• Type: string
• Length: 100 characters

---

firstName

The first name of the account holder at the time an invoice is created.

• Type: string
• Length: 100 characters

---

id

An invoice's internal identifier.

• Type: integer
• Length: 10 digits

---

lastName

The last name of the account holder at the time an invoice is created.

• Type: string
• Length: 100 characters

---

modifyDate

The date an invoice was last modified.

• Type: dateTime

---

officePhone

The telephone number belonging to an account at the time an invoice is created.

• Type: string
• Length: 100 characters

---

postalCode

The postal code portion of an address belonging to an account at the time an invoice is created.

• Type: string
• Length: 100 characters

---

startingBalance

An SoftLayer account's balance at the time an invoice is created. This value is measured in US Dollar ($USD) currency.

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

---

state

A two-letter abbreviation of the state portion of an address belonging to an account at the time an invoice is created. If the account that the invoice was generated for resides outside a province then this is set to "other".

• Type: string
• Length: 100 characters

---

statusCode

An invoice's status. The "OPEN" status means SoftLayer has not yet received payment for this invoice. "CLOSED" status means that SoftLayer has received payment and closed the invoice. The "CLOSED_FAILED" status code means SoftLayer closed the invoice without receiving a payment. Invoices are usually set to CLOSED_FAILED status in cases where customer accounts are terminated for non-payment.

• Type: string
• Length: 20 characters

---

typeCode

An invoice's type. SoftLayer invoices and service credits are differentiated by their type. The "NEW" type code signifies an invoice for new service. A SoftLayer customer's first invoice has the NEW type code. "RECURRING" invoices are generated on a SoftLayer customer's anniversary billing date for monthly services. "ONE-TIME-CHARGE" invoices are generated when one-time charges are applied to an account. "CREDIT" invoices are generated whenever SoftLayer applies a credit against an account's balance. There are two special types of service credits. "REFUND" type credits are applied against a customer's account balance along with the receivables on their account. "MANUAL_PAYMENT_CREDIT" invoice credits are generated whenever a customer makes an unscheduled payment.

• Type: string
• Length: 30 characters

Relational Properties

account

The account that an invoice belongs to.
account can be queried by object mask.
account must be a unique value.

• Type: SoftLayer_Account

---

amount

This is the amount of this invoice.
amount can be queried by object mask.
amount must be a unique value.

• Type: decimal

---

invoiceTopLevelItems

A list of top-level invoice items that are on the currently pending invoice.
invoiceTopLevelItems can be queried by object mask.

• Type: SoftLayer_Billing_Invoice_ItemArray

---

invoiceTotalAmount

The total amount of this invoice.
invoiceTotalAmount can be queried by object mask.
invoiceTotalAmount must be a unique value.

• Type: decimal

---

invoiceTotalOneTimeAmount

The total one-time charges for this invoice. This is the sum of one-time charges + setup fees + labor fees. This does not include taxes.
invoiceTotalOneTimeAmount can be queried by object mask.
invoiceTotalOneTimeAmount must be a unique value.

• Type: decimal

---

invoiceTotalOneTimeTaxAmount

A sum of all the taxes related to one time charges for this invoice.
invoiceTotalOneTimeTaxAmount can be queried by object mask.
invoiceTotalOneTimeTaxAmount must be a unique value.

• Type: decimal

---

invoiceTotalRecurringAmount

The total Recurring amount of this invoice. This amount does not include taxes or one time charges.
invoiceTotalRecurringAmount can be queried by object mask.
invoiceTotalRecurringAmount must be a unique value.

• Type: decimal

---

invoiceTotalRecurringTaxAmount

The total amount of the recurring taxes on this invoice.
invoiceTotalRecurringTaxAmount can be queried by object mask.
invoiceTotalRecurringTaxAmount must be a unique value.

• Type: decimal

---

items

The items that belong to this invoice.
items can be queried by object mask.

• Type: SoftLayer_Billing_Invoice_ItemArray

---

payment

This is the total payments made on this invoice.
payment can be queried by object mask.
payment must be a unique value.

• Type: decimal

Count Properties

invoiceTopLevelItemCount

A count of a list of top-level invoice items that are on the currently pending invoice.
invoiceTopLevelItemCount must be a unique value.

• Type: unsigned long

---

itemCount

A count of the items that belong to this invoice.
itemCount must be a unique value.

• Type: unsigned long

Associated Methods

• SoftLayer_Billing_Invoice::getObject
• SoftLayer_Account::getInvoices

See Also

• SoftLayer_Account (type)