API Documentation

Beans_Customer_Sale

A customer sale.


Attributes

id INTEGER
customer OBJECT The Beans_Customer the sale belongs to.
account OBJECT The Beans_Account that is the AR for the sale.
sent STRING The sent status of the current state of the sale: 'phone', 'email', 'both', or NULL
refund_sale_id INTEGER The ID of a corresponding sale in a refund pair.
date_created STRING
date_billed STRINg
date_due STRING
date_cancelled STRING
create_transaction_id INTEGER The ID for the Beans_Transaction tied to the sale creation.
invoice_transaction_id INTEGER The ID for the Beans_Transaction tied to invoicing the sale.
cancel_transaction_id INTEGER The ID for the Beans_Transaction tied to cancelling the sale.
subtotal DECIMAL
total DECIMAL
taxestotal DECIMAL
balance DECIMAL
sale_number STRING
order_number STRING
po_number STRING
quote_number STRING
tax_exempt BOOLEAN If this is true, all lines of the sale will also be tax_exempt.
billing_address OBJECT The Beans_Customer_Address used to bill this sale.
shipping_address OBJECT The Beans_Customer_Address used to ship this sale.
lines ARRAY An array of Beans_Customer_Sale_Line.
taxes ARRAY An array of Beans_Customer_Sale_Tax - these are the applied taxes and their totals.
payments ARRAY An array of the Beans_Customer_Payment that this sale is tied to.
status STRING A short description of the status of the sale.
title STRING A short description of the sale.