PaymentMethod Property

This property is used to specify the method of payment used when marking an invoice as paid (via MarkAsPaid ).

Syntax

 invoice.getPaymentMethod([callback])
 invoice.setPaymentMethod( paymentMethod, [callback])

Possible Values

  0 (pmPayPal), 
  1 (pmBankTransfer), 
  2 (pmCash), 
  3 (pmCheck), 
  4 (pmCreditCard), 
  5 (pmDebitCard), 
  6 (pmWireTransfer), 
  7 (pmOther)

Default Value

0

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 the getPaymentMethod([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setPaymentMethod([callback]) 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 property is used to specify the method of payment used when marking an invoice as paid (via MarkAsPaid).

The following payment methods are available:

Data Type

Integer