SoftLayer Billing Invoice::getObject

From SoftLayer Development Network Wiki

getObject is a member of the SoftLayer_Billing_Invoice service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 4.2 Optional Headers 5 Error Handling 6 Associated Methods

Overview

getObject retrieves the SoftLayer_Billing_Invoice object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Invoice service. You can only retrieve invoices that are assigned to your portal user's account.

User Access

Users wishing to execute getObject service must have the view account summary and view account summary permissions assigned to their account.

Return Type

getObject returns the SoftLayer_Billing_Invoice data type.

Headers

Required Headers

getObject requires the following headers:

• authenticate
• SoftLayer_Billing_InvoiceInitParameters

Optional Headers

getObject may use the following headers:

• SoftLayer_Billing_InvoiceObjectMask

Error Handling

getObject throws the following exceptions:

• SoftLayer_Exception_ObjectNotFound

Throw the error "Unable to find object with id of {id}." if the given initialization parameter has an invalid id field.

Associated Methods

• SoftLayer_Account::getInvoices