QuickBooks Integrator 2020 Python Edition

Questions / Feedback?

cancel Method

Cancels (voids) the transaction.

Syntax

def cancel() -> None: ...

Remarks

Cancel causes the transaction to be voided in QuickBooks. The amount of the transaction and all line item quantities are changed to zero, and the memo is changed to "VOID:". The transaction will not, however, be deleted.

The transaction canceled in QuickBooks is the one specified by ref_id. If the value of ref_id is known then get should first be called to retrieve the transaction. Otherwise the ObjSearch class should be used to search for the desired transaction in the QuickBooks database.

As the QuickBooks response to Cancel does not include the updated transaction, the values of all properties are instead set to their defaults. To get a copy of the updated transaction, the value of ref_id should first be stored, and then get should be called.

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