QuickBooks Integrator 2020 Node.js Edition

Questions / Feedback?

Delete Method

Deletes the record from QuickBooks.

Syntax

qbobject.delete([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

Delete causes the object to be deleted in QuickBooks. After this method is called, the values of all fields will be reset to their defaults.

The object deleted in QuickBooks is the one specified by the Id. This property may be assigned using AddProperty, by calling Get, or by assigning the value of QBResponseAggregate.

A typical example:


Object.Get("Floor plans") 'this will assign the Id
Object.Delete()

Deleting list objects requires that QuickBooks be open in single-user mode. Transaction objects, however, may be deleted while QuickBooks is in any mode.

Use this method with caution, as there is no way to recover deleted objects.

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 Node.js Edition - Version 20.0 [Build 7941]