Sale.md

DearInventoryRuby::Sale

Properties

Name	Type	Description	Notes
id	String	Unique DEAR Sale ID. Required for PUT	[optional]
customer	String	Customer name	[optional]
customer_id	String	Customer identifier	[optional]
contact	String	Customer Contact name	[optional]
phone	String	Customer Contact phone	[optional]
email	String	Customer Contact email	[optional]
default_account	String	Account code used by default for invoice lines when no revenue account is defined on Product. By default it is equal to Customer Sale account	[optional]
skip_quote	Boolean	True if there is no quote in the sale	[optional]
billing_address	Address		[optional]
shipping_address	ShippingAddress		[optional]
shipping_notes	String	Shipping Notes	[optional]
base_currency	String	3 character currency code of Base Currency defined in General Settings on the moment when Sale was created.	[optional]
customer_currency	String	3 character currency code of customer Currency defined in Customer card at the moment when customer is selected for the Sale.	[optional]
tax_rule	String	Default Tax Rule name selected for Sale	[optional]
tax_calculation	String	Inclusive or Exclusive	[optional]
terms	String	Payment terms name	[optional]
price_tier	String	Price Tier name selected for Sale	[optional]
ship_by	Date	Date when shipment is due	[optional]
location	String	Default location to pick stock from	[optional]
sale_order_date	Date	Date when task was created	[optional]
last_modified_on	Date	UTC Time	[optional]
note	String	Custom Sale note	[optional]
customer_reference	String	Reference number used by customer to identify this sale. Could be a purchase order number generated by customer.	[optional]
cogs_amount	Float	COGS amount in base currency	[optional]
status	String	Sale Status, see possible values	[optional]
combined_picking_status	String	Pick status. Possible Values are VOIDED, NOT AVAILABLE, PICKED, PICKING , NOT PICKED , PARTIALLY PICKED	[optional]
combined_packing_status	String	Pack status. Possible Values are VOIDED, NOT AVAILABLE, PACKED, PACKING, NOT PACKED, PARTIALLY PACKED	[optional]
combined_shipping_status	String	Ship status. Possible Values are VOIDED, NOT AVAILABLE, SHIPPED, SHIPPING , NOT SHIPPED , PARTIALLY SHIPPED	[optional]
ful_filment_status	String	Fulfilment status. Possible Values are FULFILLED, PARTIALLY FULFILLED, NOT AVAILABLE, NOT FULFILLED, VOIDED	[optional]
combined_invoice_status	String	Invoice status. Possible Values are INVOICED, INVOICED / CREDITED, NOT AVAILABLE, NOT INVOICED, PARTIALLY INVOICED, PARTIALLY INVOICED / CREDITED	[optional]
combined_payment_status	String	Payment status. Possible Values are NOT REFUNDED, PREPAID, PARTIALLY PAID, UNPAID, PAID, VOIDED	[optional]
combined_tracking_numbers	String	Tracking Numbers	[optional]
carrier	String	Name of Carrier/shipping method	[optional]
currency_rate	Float	Conversion Rate expressed as number of Base currency units for one Customer currency unit	[optional]
sales_representative	String	Sales representative name	[optional]
type	String	Type of sale Simple Sale or Advanced Sale, Service Sale	[optional]
source_channel	String	Source of the sale. read-only field	[optional]
external_id	String	Custom field that is only available in API and allows to set arbitrary value for the sale for later search and any custom logic	[optional]
service_only	String	true when it is service-only sale	[optional]
quote	SaleQuote		[optional]
order	SaleOrder		[optional]
invoices	Array<SaleInvoice>	Sale Invoices	[optional]
attachments	Array<AttachmentLine>	Sale Attachments	[optional]

Code Sample

require 'DearInventoryRuby'

instance = DearInventoryRuby::Sale.new(id: nil,
                                 customer: nil,
                                 customer_id: nil,
                                 contact: nil,
                                 phone: nil,
                                 email: nil,
                                 default_account: nil,
                                 skip_quote: nil,
                                 billing_address: nil,
                                 shipping_address: nil,
                                 shipping_notes: nil,
                                 base_currency: nil,
                                 customer_currency: nil,
                                 tax_rule: nil,
                                 tax_calculation: nil,
                                 terms: nil,
                                 price_tier: nil,
                                 ship_by: nil,
                                 location: nil,
                                 sale_order_date: nil,
                                 last_modified_on: nil,
                                 note: nil,
                                 customer_reference: nil,
                                 cogs_amount: nil,
                                 status: nil,
                                 combined_picking_status: nil,
                                 combined_packing_status: nil,
                                 combined_shipping_status: nil,
                                 ful_filment_status: nil,
                                 combined_invoice_status: nil,
                                 combined_payment_status: nil,
                                 combined_tracking_numbers: nil,
                                 carrier: nil,
                                 currency_rate: nil,
                                 sales_representative: nil,
                                 type: nil,
                                 source_channel: nil,
                                 external_id: nil,
                                 service_only: nil,
                                 quote: nil,
                                 order: nil,
                                 invoices: nil,
                                 attachments: nil)