API Documentation

Beans_Customer_Sale_Cancel

Cancel a customer sale. This should be called if you cannot delete a sale because it has payments tied to it.


Parameters

auth_uid INTEGER The ID for your API key.
auth_key STRING The API key.
auth_expiration INTEGER Unique ID tied to your key; changes if you reset your key.
id INTEGER The ID of the Beans_Customer_Sale to cancel.
date_cancelled STRING The cancel date in YYYY-MM-DD for the sale. If not provided, will default to today.

Returns

sale OBJECT The updated Beans_Customer_Sale.