GetDetails Method

Retrieves detailed information about an invoice.

Syntax

invoice.getDetails(invoiceId, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method is used to retrieve detailed information about an invoice specified by invoiceId.

MerchantInfo, BillingInfo, and ShippingInfo, will be populated with the contact details listed on the invoice. InvoiceInfo, InvoiceDetails, and PaymentInfo will be populated with the details of the specified invoice. InvoiceItems will be populated with the items on the invoice.

After calling this method, the Ack property will indicate success or failure.