Billing
SoftLayer_Billing_Invoice

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.

Local Properties

accountId

The SoftLayer customer account that an invoice belongs to.

Type:

integer

address1

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

Type:

string

address2

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

Type:

string

city

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

Type:

string

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

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

createDate

The date an invoice was created.

Type:

dateTime

documentsGeneratedFlag
Type:

boolean

email

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

Type:

string

endingBalance

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

Type:

decimal

faxPhone

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

Type:

string

firstName

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

Type:

string

id

An invoice's internal identifier.

Type:

integer

lastName

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

Type:

string

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

postalCode

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

Type:

string

purchaseOrderNumber
Type:

string

startingBalance

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

Type:

decimal

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

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

taxStatusId
Type:

integer

taxTypeId
Type:

integer

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

Relational & Count Properties

Relational Properties can be queried by object mask
account

The account that an invoice belongs to.

amount

This is the amount of this invoice.

Type:

decimal

brandAtInvoiceCreation
detailedPdfGeneratedFlag

A flag that will reflect whether the detailed version of the pdf has been generated.

Type:

boolean

invoiceTopLevelItemCount

A count of a list of top-level invoice items that are on the currently pending invoice.

Type:

unsignedLong

invoiceTopLevelItems

A list of top-level invoice items that are on the currently pending invoice.

invoiceTotalAmount

The total amount of this invoice.

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.

Type:

decimal

invoiceTotalOneTimeTaxAmount

A sum of all the taxes related to one time charges for this invoice.

Type:

decimal

invoiceTotalPreTaxAmount

The total amount of this invoice. This does not include taxes.

Type:

decimal

invoiceTotalRecurringAmount

The total Recurring amount of this invoice. This amount does not include taxes or one time charges.

Type:

decimal

invoiceTotalRecurringTaxAmount

The total amount of the recurring taxes on this invoice.

Type:

decimal

itemCount

A count of the items that belong to this invoice.

Type:

unsignedLong

items

The items that belong to this invoice.

localCurrencyExchangeRate

Exchange rate used for billing this invoice.

payment

This is the total payment made on this invoice.

Type:

decimal

paymentCount

A count of the payments for the invoice.

Type:

unsignedLong

payments

The payments for the invoice.

sellerRegistration

This is the seller's tax registration.

Type:

string

taxInfo

This is the tax information that applies to tax auditing. This is the official tax record for this invoice.

taxInfoHistory

This is the set of tax information for any tax calculation for this invoice. Note that not all of these are necessarily official, so use the taxInfo key to get the final information.

taxInfoHistoryCount

A count of this is the set of tax information for any tax calculation for this invoice. Note that not all of these are necessarily official, so use the taxInfo key to get the final information.

Type:

unsignedLong

taxMessage

This is a message explaining the tax treatment for this invoice.

Type:

string

taxType

This is the strategy used to calculate tax on this invoice.