ManuallyClosed Property

Whether the sales order is manually closed.

Syntax

 salesorder.getManuallyClosed([callback])
 salesorder.setManuallyClosed( manuallyClosed, [callback])

Possible Values

  0 (mcNotSet), 
  1 (mcManuallyClosed), 
  2 (mcNotManuallyClosed)

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 getManuallyClosed([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 setManuallyClosed([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

If true, the sales order is manually closed, even if not all of its line items have been invoiced.

This may also be set for individual line items via ItemManuallyClosed.

Data Type

Integer