SoftLayer Billing Invoice::getPdf

From SoftLayer Development Network Wiki

getPdf is a member of the SoftLayer_Billing_Invoice service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 5 Error Handling 6 External Links

Overview

Retrieve a PDF record of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these invoice files.

User Access

Users wishing to execute getPdf must have the following permissions assigned to their account:

• ACCOUNT_SUMMARY_VIEW

Return Type

getPdf returns the base64Binary data type.

Headers

Required Headers

getPdf requires the following headers set:

• authenticate
• SoftLayer_Billing_InvoiceInitParameter

Error Handling

getPdf throws the following exceptions:

• SoftLayer_Exception.

Throw the exception "PDF does not exist: invoice has not yet been closed." when trying to retrieve an open invoice. Open invoices do not have PDF records.

• SoftLayer_Exception.

Throw the exception "PDF does not exist: file not found" if the API is unable to locate the PDF File for the invoice.

• SoftLayer_Exception.

Throw the exception "Unable to load a valid invoice PDF." if the PDF for this invoice is a corrupted.

External Links

• Portable Document Format at Wikipedia