Skip to content

Customer Sale Cancel

Sean Callan edited this page Jun 9, 2020 · 1 revision

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 (required) INTEGER - The ID for your API key.

  • auth_key (required) STRING - The API key.

  • auth_expiration (required) INTEGER - Unique ID tied to your key; changes if you reset your key.

  • id (required) INTEGER - The ID of the Beans_Customer_Sale to cancel.

  • date_cancelled (optional) 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.
Clone this wiki locally