Cancel Method

Cancels an invoice.

Syntax

invoice.cancel(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 cancel the invoice specified by invoiceId.

CancellationInfo can be used to specify details about the invoice cancellation.

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