Billing
SoftLayer_Billing_Order

Overview

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

Local Properties

accountId

The account ID to which an order belongs.

Type:

integer

createDate

The point in time at which a billing item was created.

Type:

dateTime

id

*

Type:

integer

impersonatingUserRecordId

The SoftLayer_User_Customer id of the portal or API user who impersonated the user which submitted an order.

Type:

integer

modifyDate

The last time an order was updated.

Type:

dateTime

orderQuoteId

The SoftLayer_Billing_Order_Quote id of the quote's user who finalized an order.

Type:

integer

orderTypeId

The SoftLayer_Billing_Order_Type id of the order.

Type:

integer

presaleEventId
Type:

integer

privateCloudOrderFlag

Flag indicating a private cloud solution order (Deprecated)

Type:

boolean

status

Purchaser current status e.i. Approved, Pending_Approval

Type:

string

userRecordId

The SoftLayer_User_Customer id of the portal or API user who submitted an order.

Type:

integer

Relational & Count Properties

Relational Properties can be queried by object mask
account

The account to which an order belongs.

brand
cart

A cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices. Not all orders will have a cart associated with them. See SoftLayer_Billing_Order_Cart for more information.

coreRestrictedItemCount

A count of the order items that are core restricted

Type:

unsignedLong

coreRestrictedItems

The order items that are core restricted

creditCardTransactionCount

A count of all credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.

Type:

unsignedLong

creditCardTransactions

All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.

initialInvoice
itemCount

A count of the SoftLayer_Billing_Order_items included in an order.

Type:

unsignedLong

items

The SoftLayer_Billing_Order_items included in an order.

orderApprovalDate
Type:

dateTime

orderNonServerMonthlyAmount

An order's non-server items total monthly fee.

Type:

decimal

orderServerMonthlyAmount

An order's server items total monthly fee.

Type:

decimal

orderTopLevelItemCount

A count of an order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI.

Type:

unsignedLong

orderTopLevelItems

An order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI.

orderTotalAmount

This amount represents the order's initial charge including set up fee and taxes.

Type:

decimal

orderTotalOneTime

An order's total one time amount summing all the set up fees, the labor fees and the one time fees. Taxes will be applied for non-tax-exempt. This amount represents the initial fees that will be charged.

Type:

decimal

orderTotalOneTimeAmount

An order's total one time amount. This amount represents the initial fees before tax.

Type:

decimal

orderTotalOneTimeTaxAmount

An order's total one time tax amount. This amount represents the tax that will be applied to the total charge, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.

Type:

decimal

orderTotalRecurring

An order's total recurring amount. Taxes will be applied for non-tax-exempt. This amount represents the fees that will be charged on a recurring (usually monthly) basis.

Type:

decimal

orderTotalRecurringAmount

An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis.

Type:

decimal

orderTotalRecurringTaxAmount

The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.

Type:

decimal

orderTotalSetupAmount

An order's total setup fee.

Type:

decimal

orderType

The type of an order. This lets you know where this order was generated from.

paypalTransactionCount

A count of all PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.

Type:

unsignedLong

paypalTransactions

All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.

presaleEvent
quote

The quote of an order. This quote holds information about its expiration date, creation date, name and status. This information is tied to an order having the status 'QUOTE'

referralPartner

The Referral Partner who referred this order. (Only necessary for new customer orders)

upgradeRequestFlag

This flag indicates an order is an upgrade.

Type:

boolean

userRecord

The SoftLayer_User_Customer object tied to an order.