SoftLayer_Billing_Invoice


SoftLayer_Billing_Invoice

Description

The SoftLayer_Billing_Invoice service controls the invoices that are created whenever a SoftLayer customer’s account balance changes. Invoices exist in three states: *“‘OPEN”’: Invoices which have not been paid yet. Invoices are created in the OPEN state. *“‘CLOSED”’: Invoices that SoftLayer has received payment for. *“‘CLOSED_FAILED”’: Invoices which were closed but were not paid for. Customers who are terminated for non-payment typically have invoices in this state.

Once an invoice is paid it moves from OPEN to CLOSED state. Invoices are created under varying types, which are defined in the type property of the [[SoftLayer_Invoice (type)|SoftLayer_Invoice data type]]. Invoices are created under one of the following type categories: *“‘NEW”’: An invoice for new service. A SoftLayer customer’s first invoice is of the NEW type. *“‘RECURRING”’: Invoices that are generated on a SoftLayer customer’s anniversary billing date for monthly services. *“‘ONE-TIME-CHARGE”’: Invoices that are generated when one-time charges are applied to an account for fees incurred from products or services procured outside of the standard purchasing processes. *“‘CREDIT”’: Invoices that are generated whenever SoftLayer applies a credit against an account’s balance. *“‘REFUND”’: Account credits that are applied against a customer’s account balance along with the receivables on their account. REFUND type invoices are generated whenever a customer receives a service credit on their account balance and has their invoice items changed due to the credit. *“‘MANUAL_PAYMENT_CREDIT”’: Invoice credits that are generated whenever a customer makes an manual payment.

Invoices are created with contact information duplicated from the [[SoftLayer_Account (type)|SoftLayer_Account data type]]. We do this in order to maintain a history of an account’s contact information as invoices are generated. Likewise each invoice record keeps track of an account’s balance as the invoice is opened and closed.

Query the [[SoftLayer_Account]] service to get a list of invoices for your account.

associatedMethods

Methods

emailInvoices
Create a transaction to email invoice links.
getAccount
Retrieve the account that an invoice belongs to.
getAmount
Retrieve this is the amount of this invoice.
getDetailedPdfGeneratedFlag
Retrieve a flag that will reflect whether the detailed version of the pdf has been generated.
getExcel
Retrieve a Microsoft Excel copy of an invoice.
getInvoiceTopLevelItems
Retrieve a list of top-level invoice items that are on the currently pending invoice.
getInvoiceTotalAmount
Retrieve the total amount of this invoice.
getInvoiceTotalOneTimeAmount
Retrieve 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.
getInvoiceTotalOneTimeTaxAmount
Retrieve a sum of all the taxes related to one time charges for this invoice.
getInvoiceTotalPreTaxAmount
Retrieve the total amount of this invoice. This does not include taxes.
getInvoiceTotalRecurringAmount
Retrieve the total Recurring amount of this invoice. This amount does not include taxes or one time charges.
getInvoiceTotalRecurringTaxAmount
Retrieve the total amount of the recurring taxes on this invoice.
getItems
Retrieve the items that belong to this invoice.
getLocalCurrencyExchangeRate
Retrieve exchange rate used for billing this invoice.
getObject
Retrieve a SoftLayer_Billing_Invoice record.
getPayment
Retrieve this is the total payment made on this invoice.
getPayments
Retrieve the payments for the invoice.
getPdf
Retrieve a PDF copy of an invoice.
getPdfDetailed
Retrieve a PDF copy of the detailed invoice summary.
getPdfDetailedFilename
Get the name of the detailed version of the PDF.
getPdfFileSize
Retrieve the size of a PDF copy of an invoice.
getPreliminaryExcel
Retrieve a Microsoft Excel copy of an invoice.
getPreliminaryPdf
Retrieve a PDF copy of an invoice.
getPreliminaryPdfDetailed
Retrieve a PDF copy of the detailed version of an invoice.
getSellerRegistration
Retrieve this is the seller's tax registration.
getTaxInfo
Retrieve this is the tax information that applies to tax auditing. This is the official tax record for this invoice.
getTaxInfoHistory
Retrieve 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.
getTaxMessage
Retrieve this is a message explaining the tax treatment for this invoice.
getTaxType
Retrieve this is the strategy used to calculate tax on this invoice.

/reference/services/SoftLayer_Billing_Invoice/