Deactivate customer
delete_customerDeactivate a customer in QuickBooks to hide them from pick lists while preserving invoices, payments, and history. Requires a fresh sync token to update the record.
Instructions
Deactivate a customer. QuickBooks Online has no hard delete for customers, so this sets Active to false, which hides the customer from pick lists while keeping their invoices, payments, and history intact. Use it to retire a customer, not to erase data. Write operation and not idempotent: it needs the SyncToken from a fresh get_customer, and that token changes on success. Deactivated customers remain readable through search_customers with active=false.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sync_token | Yes | SyncToken from a fresh get_customer call for this Id. QuickBooks rejects a stale token with error 5010, so re-read the customer instead of reusing an older token. | |
| customer_id | Yes | QuickBooks Customer Id, as returned by search_customers, list_customers, or create_customer. This is the numeric Id string, not the display name. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| error | No | ||
| customer | No |