| West Wind Web Store |
Class cinvoice
|
The invoice class is the most powerful class in the Web store application. It's the main interface to the developer working with the Web Store as it acts as a high level object through which you can reach the various other objects.
The underlying table is wws_Invoice.
Parent Class: wwbusiness
| Member | Description |
|---|---|
addlineitem | Adds a lineitem to the oLineItems object array. o.addlineitem(loLineItem) |
applydiscount | Applies a discount percentage to the entire invoice o.applydiscount(lnDiscount) |
checkccexpiration | Checks a mm/yy string expression for validity. o.checkccexpiration(lcExp) |
checkinvoiceforpkconflict | Method used to update invoice and customer Pks during imports to make sure that if the invoice exists already that a new InvoicePK is generated and the lineitems are updated. o.checkinvoiceforpkconflict() |
deletelineitem | Deletes a lineitem from the lineitems object array. o.deletelineitem(lvID) |
emailconfirmation | Sends an email confirmation to the invoice customer. o.emailconfirmation(lcMailServer, lcSenderEmail, lcSenderName) |
exportorderstoxml | Exports orders to XML format. o.exportorderstoxml(lcFilter, llMarkDownloaded) |
getinvoicelist | Returns an invoice list for display in invoice list box. o.getinvoicelist(lnDays) |
getlineitem | Retrieves a lineitem by Sku o.getlineitem(lvID) |
htmllineitems | Generates an HTML table display for the lineitems attched to this invoice. o.htmllineitems(lnLinkMode, llTotals, lcForeign, lcShipDisks) |
importxml | Imports an order from an XML string. o.importxml(lcXML) |
invoicetotal | Calculates the invoice total from the detail information held in the lineitems object. o.invoicetotal() |
isinvoice | Checks to see if an invoice exists by PK. This is so we don't have to load a full invoice just to check. o.isinvoice(lnPK) |
loadinvoicebyinvoiceno | Loads an invoice by invoice number instead of by PK. o.loadinvoicebyinvoiceno(lcInvNo) |
loadlineitems | Loads or reloads the lineitems for the invoice into the oLineItems object member. o.loadlineitems(lnPK) |
markdownloaded | Marks messages as downloaded. Typically this method is called after ExportOrdersToXML as a confirmation and then clear the same order items. o.markdownloaded(lcFilter, llUnmark) |
printinvoice | Prints the current invoice object. o.printinvoice(lnMode) |
validatecreditcard | Validates the credit card for the current invoice. o.validatecreditcard(lcStoreType, lcStoreName, lcPassword, lcVarParm, llCredit) |
cshipcountry | Worker property set to determine the country that an order is shipped to. Two letter country code (US, CA, MX etc.). |
cshippingbehaviorclass | Class used to perform shipping calculation. |
cshipstate | Worker property that is set with the state where order is shipped to. |
ctaxbehaviorclass | Behavior Class used for Tax Calculations. Not used in current Web store. |
lnoshippingtotal | Tells the class to not calculate shipping totals. |
lnotaxtotal | Tells the class not to calculate Tax Totals when doing InvoiceTotal() |
nsubtotal | Running Subtotal value. |
ocustomer | The Customer object related to this Invoice |
olineitems | The LineItems object related to this invoice. This object contains all the lineitems in an array of objects. |