getPdf


SoftLayer_Billing_Invoice::getPdf

Retrieve a PDF copy of an invoice.

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.


Parameters

Name Type Description

Required Headers

  • authenticate
  • SoftLayer_Billing_InvoiceInitParameters

Return Values

  • binary data

Error Handling

  • 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.