The CStandardOrder type exposes the following members.

Constructors

  NameDescription
Public methodCStandardOrder(IiMISUser)
This constructor creates a new CStandardOrder.
Public methodCStandardOrder(IiMISUser, Double)
This constructor instantiates an existing CStandardOrder from the database.

Methods

  NameDescription
Protected methodCalcFreightTotal()()()()
Convenience method to calculate the total freight charge for this order.
(Inherited from COrder.)
Protected methodCalcFreightTotal(Boolean)
Worker method to calculate the total freight charge for this order.
(Inherited from COrder.)
Protected methodCalcHandlingTotal
Calculates the TotalHandling amount based on the handling type.
(Inherited from COrder.)
Protected methodCheckAndModifyEditStatus
Sets the EditStatus to Modified if it is Unchanged
(Inherited from iboBase.)
Public methodClearOrderLines
Clears the COrder of all lines. This is useful if the COrder needs to be started over.
(Inherited from COrder.)
Public methodDelete
Marks this object to be deleted when the save is done
(Inherited from iboBase.)
Protected methodDetermineOrderFinancialEntity
Figure out the financial entity code for the COrder, either from a system default or from the financial entity code found on the first product on the order that has one.
(Inherited from COrder.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetFreightCharge
Calculate the freight charge with the current set of properties, but with a particular shipping method.
(Inherited from COrder.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetOrderLineByNum
Given the line number on an COrder returns the COrderLine with that line number.
(Inherited from COrder.)
Public methodGetShippingCosts
Returns all possible Shipping Methods and their costs.
(Inherited from COrder.)
Public methodGetShippingCostsForAllShippingMethods
Generate a collection of all possible charges for existing ship methods.
(Inherited from COrder.)
Public methodGetShippingCostsForEligibleShipMethods
Generate a collection of all eligible shipping methods and charges based on a country when Freight-By-Weight is selected.
(Inherited from COrder.)
Public methodGetStandardOrderLineByProductCode
Gets the CStandardOrderLine object on the order for the given product
Protected methodGetTaxAuthorities (Inherited from COrder.)
Protected methodGetTaxAuthorityVAT
Determines whether the buyer should be taxed and for which country.
(Inherited from COrder.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNewLineItem(String, Double)
Creates a new CStandardOrderLine for the order and appends it to the end of the OrderLines array.
Public methodNewLineItem(CStandardProduct, Double)
Creates a new CStandardOrderLine for the order and appends it to the end of the OrderLines array.
Protected methodRecalc
Recalculates tax, order line amounts, and freight and handling (and their corresponding taxes) based upon the parameters.
(Inherited from COrder.)
Protected methodRecalcFreightHandlingTax
Recalculates the freight, handling, and tax for the COrder.
(Inherited from COrder.)
Public methodRemoveOrderLine
Removes the given COrderLine from the COrder.
(Inherited from COrder.)
Public methodSave()()()()
Saves the Order along with all of its child records to the database using a new DataServer object.
(Overrides COrder..::..Save()()()().)
Public methodSave(DataServer)
Saves the Order along with all of its child records to the database using the supplied DataServer object.
(Overrides COrder..::..Save(DataServer).)
Public methodSave(DataServer, Boolean)
Saves the Order along with all of its child records to the database using the supplied DataServer object. A new transaction is used if useNewTransaction is true.
Public methodSaveContactChanges
Save any changes to the Contact associated with this COrder.
(Inherited from COrder.)
Protected methodSetBalance
Sets the Balance on the COrder. Only available to derived classes.
(Inherited from COrder.)
Public methodSetBatchNumberFromBatch
Set the batchnumber and batch for this COrder.
(Inherited from COrder.)
Protected methodSetCashGLAccount
Sets the CashGLAccount on the COrder. Only available to derived classes.
(Inherited from COrder.)
Protected methodSetFundRaisingOrder
Sets IsFundRaisingOrder on the COrder. Only available to derived classes.
(Inherited from COrder.)
Public methodSetOrderNumber
Sets the OrderNumber on the COrder. MUST BE USED WITH CAUTION.
(Inherited from COrder.)
Protected methodSetOrderStage(String)
Sets the Stage on the COrder. Only available to derived classes.
(Inherited from COrder.)
Protected methodSetOrderStage(OrderStage)
Sets the Stage on the COrder. Only available to derived classes.
(Inherited from COrder.)
Protected methodSetRecognizedCashAmount
Sets the RecognizedCashAmount on the COrder. Only available to derived classes.
(Inherited from COrder.)
Protected methodSetTransPAYGlAccount
Sets the GL Account number to be used on the PAY Transaction when saving the COrder.
(Inherited from COrder.)
Protected methodSetTransPAYGlAcctFinancialEntityCode
Sets the Financial Entity Code to be used on the PAY Transaction when saving the COrder.
(Inherited from COrder.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodValidate
Validates the data set in the order's properties against cross-property business rules. If any errors are found, Validate will return false and the Asi.iBO.Errors property should be checked for details. Validate can be called at any time to check for errors but it will automatically be called at save time.
(Overrides COrder..::..Validate()()()().)

Fields

  NameDescription
Protected fieldmEditStatus
The edit status (unchanged, modified, etc) of this record.
(Inherited from iboBase.)
Protected fieldmErrors
The current list of errors encountered by this class instance during processing.
(Inherited from iboBase.)
Protected fieldmOrderLines
A collection of associated COrderLine objects.
(Inherited from COrder.)

Properties

  NameDescription
Public propertyAddress1
Gets or sets the first line of the physical ship-to address.
(Inherited from COrder.)
Public propertyAddress2
Gets or sets the second line of the physical ship-to address.
(Inherited from COrder.)
Public propertyAddress3
Gets or sets the third line of the physical ship-to address.
(Inherited from COrder.)
Public propertyAddressFormatCode
Gets or sets a reference to the address format to use when creating the FormattedAddress out of the various physical address components.
(Inherited from COrder.)
Public propertyAffectInventoryFlag
Gets or sets an indicator of whether or not inventory was/will be affected by this COrder.
(Inherited from COrder.)
Public propertyAutoCalculateFreightFlag
Gets or sets an indicator of whether the freight on this order was/will be calculated automatically or set manually.
Public propertyAutoCalculateHandlingFlag
Gets or sets an indicator of whether the current order should automatically calculate handling charges.
Public propertyAutoCalculateRestockingFlag
Gets or sets an indicator of whether the current order should automatically calculate restocking charges.
Public propertyAutoFreightAmount
Gets the automatically calculated freight charge for this order.
Public propertyAutoFreightType
Gets or sets the freight type used in the automatic freight calculation
Public propertyAutoHandlingAmount
Gets the automatically calculated handling charge for this order.
Public propertyBackorderPreference
Gets or sets the a value that determines what to do when items on the order are backordered.
Public propertyBackorderPriority
Gets or sets the priority that will be applied to any backordered portion of the order.
Public propertyBackorderReleasedOn
Gets or sets the date and time that a backordered order was released for shipping.
Public propertyBackorderStatus
Gets or sets the current backorder status of the order.
Public propertyBalance
Gets the current unpaid balance on this COrder.
(Inherited from COrder.)
Public propertyBarcode
Gets the US Postal Service Barcode representation of the ship-to address's ZIP or ZIP+4
(Inherited from COrder.)
Public propertyBatch
Gets the CBatch object associated with the COrder.
(Inherited from COrder.)
Public propertyBatchNumber
Gets or sets the number of the accounting system CBatch with which this COrder is associated.
(Inherited from COrder.)
Public propertyBillToContact
Gets or sets the CContact object representing the contact to whom this COrder will be billed.
(Inherited from COrder.)
Public propertyBillToContactId
Gets or sets the ContactId of the CContact to whom this COrder is to be billed.
(Inherited from COrder.)
Public propertyCanadianTaxes
Returns details of the Canadian taxes for this Order
(Inherited from COrder.)
Public propertyCancellationFee
Gets the monetary amount of any cancellation fee that has been added to this COrder.
(Inherited from COrder.)
Public propertyCarrierRoute
Gets or sets the carrier route data for the ship-to address. Used by the USPS to sort mail.
(Inherited from COrder.)
Public propertyCashAccountCode
Gets or sets a reference to the cash account that should receive/process this payment.
(Inherited from COrder.)
Public propertyCashGLAccount
Gets the General Ledger Cash Account used on this order.
Public propertyCheckPOPaymentNumber
Gets or sets the payment number, e.g., the check number for checks or PO number for purchase orders.
(Inherited from COrder.)
Public propertyCity
Gets or sets the city (town, village, etc.) of the physical ship-to address.
(Inherited from COrder.)
Public propertyCommissionRate
Gets or sets the salesperson's commission rate for this order.
Public propertyConfirmationOn
Gets or sets the date and time on which an order confirmation was sent to the customer.
Public propertyCountry
Gets or sets the name of the Country where the physical ship-to address is located.
(Inherited from COrder.)
Public propertyCreditCardExpiration
Gets or sets the Expiration date of the credit card for credit card payments.
(Inherited from COrder.)
Public propertyCreditCardExpirationEncrypted
Gets the credit card expiration date associated with the payment after it has been encrypted.
(Inherited from COrder.)
Public propertyCreditCardNumber
Gets or sets the credit card number for payments made by credit card.
(Inherited from COrder.)
Public propertyCreditCardSecurityCode
Gets or sets the credit card security code found on the credit card.
(Inherited from COrder.)
Public propertyCreditCardSecurityCodeEncrypted
Gets the credit card security code associated with the payment after it has been encrypted.
(Inherited from COrder.)
Public propertyCreditDebitCardAuthorizationCode
Gets or sets the credit card authorization code typically returned from a 3rd party credit card processing service.
(Inherited from COrder.)
Public propertyCreditDebitCardHoldersName
Gets or sets the name of the credit card holder, as it appears on the card.
(Inherited from COrder.)
Public propertyCreditDebitCardNumberEncrypted
Gets the credit or debit card number associated with the payment after it has been encrypted.
(Inherited from COrder.)
Public propertyCustomerReferenceValue
Gets or sets a reference value that is essentially a note that relates this COrder to something else.
(Inherited from COrder.)
Public propertyCustomerTypeCode
Gets or sets a reference to the CCustomerType of the bill-to customer/contact.
(Inherited from COrder.)
Public propertyDebitCardIssueDate
Gets or sets the Issue Date from a European debit card, for debit card payment.
(Inherited from COrder.)
Public propertyDebitCardIssueNumber
Gets or sets the Issue Number from a European debit card, for debit card payment.
(Inherited from COrder.)
Public propertyDebitCardNumber
Gets or sets the debit card number for payments made by debit card.
(Inherited from COrder.)
Public propertyDeliveryPointBarcode
Gets or sets the machine readable representation of an 11 digit ZIP code for the ship-to address. Used by the USPS to sort mail.
(Inherited from COrder.)
Public propertyDesignation
Gets or sets the designation that follows the ship-to customer's name.
(Inherited from COrder.)
Public propertyDisableAutoFreightCalcOnError
Gets or sets an indication of whether to disable automatic freight calculation if an error occurs that would normally switch the order to manual freight charges.
(Inherited from COrder.)
Public propertyDiscountPercent
Gets or sets the percentage discount to be applied to the entire order.
Public propertyEditStatus
Indicates the current edit status of this object, i.e., New, Modified, Deleted, or Unchanged. See EEditStatus
(Inherited from iboBase.)
Public propertyEmailAddress
The email address of the customer.
(Inherited from COrder.)
Public propertyEnteredBy
Gets the "user name" of the person who entered the COrder.
(Inherited from COrder.)
Public propertyEnteredOn
Gets or sets the date on which the COrder was entered.
(Inherited from COrder.)
Public propertyErrors
The collection of CError objects (error and warning messages) associated with this object instance
(Inherited from iboBase.)
Public propertyErrorsCount
Gets the number of error and warning messages that have been set on this object.
(Inherited from iboBase.)
Public propertyFax
Gets or sets the FAX number (facsimile telephone number) of the customer.
(Inherited from COrder.)
Public propertyFinancialEntityCode
Gets or sets a reference to the Financial Entity (Organization) with which this COrder is associated.
(Inherited from COrder.)
Public propertyFirstName
Gets or sets the first (or given) name of the ship-to customer, if a person. Not set for Institute/Company records.
(Inherited from COrder.)
Public propertyFormattedAddress
Gets or sets the full, formatted ship to address.
(Inherited from COrder.)
Public propertyFreightHandlingTax
Gets the freight and handling tax for this order.
Public propertyFullName
Gets the full name of the customer to which the COrder was/should be shipped.
(Inherited from COrder.)
Public propertyHoldCode
Gets or sets a value indicating that the COrder is on hold and why.
(Inherited from COrder.)
Public propertyHoldComment
Gets or sets a comment about why the COrder was put on hold.
(Inherited from COrder.)
Public propertyHoldFlag
Gets an indicator of whether or not the COrder is on hold.
(Inherited from COrder.)
Public propertyIgnoreFieldValidationErrors
Gets or sets an indication of whether field validation errors should be ignored when setting selected contact-related fields.
(Inherited from COrder.)
Public propertyInformal
Gets or sets the informal or nickname of the ship-to contact. For example, FirstName = "Robert", the informal name might be "Bob".
(Inherited from COrder.)
Public propertyInstituteContactId
Gets or sets the ContactId of the Institute/Company with which the ship-to contact is associated.
(Inherited from COrder.)
Public propertyInstituteCustomerTypeCode
Gets a reference to the CCustomerType of the Institute/Company with which the ship-to contact is associated.
(Inherited from COrder.)
Public propertyInstituteName
Gets or sets the name of the institute/company for which the ship to customer works, or if the customer is an institute/company, its name.
(Inherited from COrder.)
Public propertyInstituteSort
Gets the Institute name, optimized for sorting
(Inherited from COrder.)
Public propertyInvoiceDate
Gets or sets the invoice date associated with this COrder.
(Inherited from COrder.)
Public propertyInvoiceNumber
Gets or sets the invoice number associated with this COrder.
(Inherited from COrder.)
Public propertyInvoiceReferenceNumber
Get the reference number associated with the invoice created when the COrder is saved and the financial transactions are created.
(Inherited from COrder.)
Public propertyIsFundRaisingOrder
Gets an indicator of whether this COrder contains fundraising items.
(Inherited from COrder.)
Public propertyIsIncludedInInventoryValuation
Gets or sets an indicator of whether this order is ready to be included in the inventory valuation process.
Protected propertyIsOrderLinesEmpty
Gets an indicator of whether or not order-lines exists for this item.
(Inherited from COrder.)
Public propertyIsOrderTaxable
Gets an indicator of whether or not this COrder should be taxed.
(Inherited from COrder.)
Public propertyLastFirst
Gets the ship-to customer's last and first name. Calculated as LastName, FirstName.
(Inherited from COrder.)
Public propertyLastName
Gets or sets the last name, family name or surname of the ship-to customer, if a person. Not set for Institute/Company records.
(Inherited from COrder.)
Public propertyMailCode
Gets or sets the Mail Code associated with the ship-to address, for sorting in large mailings.
(Inherited from COrder.)
Public propertyManualFreightAmount
Gets or set the manually calculated freight charge for this order.
Public propertyManualHandlingAmount
Gets or set the manually calculated handling charge for this order.
Public propertyMiddleName
Gets or sets the middle name of the ship-to customer.
(Inherited from COrder.)
Public propertyNote
Gets or sets any comments that need to be made about the COrder.
(Inherited from COrder.)
Public propertyNumberOfLines
Gets the number of order lines on the COrder.
(Inherited from COrder.)
Public propertyOrderedOn
Gets or sets the date on which the COrder was placed.
(Inherited from COrder.)
Public propertyOrderLines
Gets an array of the COrderLine objects associated with the order.
Public propertyOrderLinesCount
Gets a count of the number of COrderLines on the COrder.
(Inherited from COrder.)
Public propertyOrderNumber
Gets the automatically generated sequential order number assigned to this COrder.
(Inherited from COrder.)
Public propertyOrderTypeCode
Gets or sets a reference to the type of this COrder.
(Inherited from COrder.)
Public propertyPayment
Gets the CPayment object associated with the COrder.
(Inherited from COrder.)
Public propertyPaymentInfoComment1
Gets the first transaction comment information associated with the payment.
(Inherited from COrder.)
Public propertyPaymentInfoComment2
Gets the second transaction comment information associated with the payment.
(Inherited from COrder.)
Public propertyPaymentType
Gets or sets a value that indicates what type of payment is being made with this COrder.
(Inherited from COrder.)
Public propertyPhone
Gets or sets the telephone number of this contact.
(Inherited from COrder.)
Public propertyPostalCode
Gets or sets the postal code (zip code, post code) associated with the physical ship-to address.
(Inherited from COrder.)
Public propertyPrefix
Gets or sets the prefix (personal title) to the ship to customer's name. Like Mr., Mrs., etc.
(Inherited from COrder.)
Public propertyPrepaidInvoiceReferenceNumber
Gets or sets the invoice reference number of the pre-paid invoice associated with this COrder.
(Inherited from COrder.)
Public propertyPrintBusinessTitleOnShipTo
Gets or sets an indicator of whether or not to print the ship-to customer's business title on the ship-to address.
(Inherited from COrder.)
Public propertyPrintInstituteNameOnShipTo
Gets or sets an indicator of whether or not to print the ship-to customer's InstituteName (company name) on the ship-to address.
(Inherited from COrder.)
Public propertyRecognizedCashAmount
Gets the monetary amount of the order that has been recognized as cash by the accounting system.
Public propertySalesperson
Gets or sets the "name" of the sales person who made the sale.
(Inherited from COrder.)
Public propertyScheduledDate
Gets or sets the date that the order is scheduled to ship.
Public propertyShipMethodCode
Gets or sets a reference to the shipping method used to ship this order.
Public propertyShipPapersOn
Gets or sets the date and time at which the shipping papers were generated/printed for this order.
Public propertyShippedOn
Gets or sets the date and time at which the order shipped.
Public propertyShipToAddress
Gets or sets the CAddressBasic object representing the physical address to which this COrder will ship.
(Inherited from COrder.)
Public propertyShipToAddressNumber
Gets or sets the address number of the CAddress to which the COrder should be shipped.
(Inherited from COrder.)
Public propertyShipToContact
Gets or sets the CContact object representing the contact to whom this COrder will ship.
(Inherited from COrder.)
Public propertyShipToContactBasic
Gets the CContactBasic object representing the contact to whom this COrder will ship.
(Inherited from COrder.)
Public propertyShipToContactId
Gets or sets the ContactId of the CContact to whom this COrder is to be shipped.
(Inherited from COrder.)
Public propertySourceCode
Gets or sets the marketing Source Code that prompted the COrder.
(Inherited from COrder.)
Public propertySourceSystem
Gets a code indicating which iMIS sub-system originated the COrder.
(Inherited from COrder.)
Public propertyStage
Gets the current processing stage of this COrder.
(Inherited from COrder.)
Public propertyStateProvince
Gets or sets the State, Province, or equivalent in which the physical ship-to address is located.
(Inherited from COrder.)
Public propertySuffix
Gets or sets the suffix to the ship-to customer's name. Like Sr., Jr., etc.
(Inherited from COrder.)
Public propertyTax1
Gets the total tax for the primary tax authority on this COrder.
(Inherited from COrder.)
Public propertyTax2
Gets the total tax for the secondary tax authority on this COrder.
(Inherited from COrder.)
Public propertyTax3
Gets the total tax for the third level tax authority on this COrder.
(Inherited from COrder.)
Public propertyTaxAuthorityCode1
Gets or sets a reference to the primary tax authority for the COrder.
(Inherited from COrder.)
Public propertyTaxAuthorityCode2
Gets or sets a reference to the secondary tax authority for the COrder.
(Inherited from COrder.)
Public propertyTaxAuthorityCode3
Gets or sets a reference to the third level tax authority for the COrder.
(Inherited from COrder.)
Public propertyTaxExemptNumber
Gets or sets the bill-to contact's government issued Tax Exemption number.
Public propertyTaxFinancialEntity
Gets the Financial Entity to be used for tax calculation purposes
(Inherited from COrder.)
Public propertyTaxRate1
Gets the tax rate for the primary tax authority for the COrder.
(Inherited from COrder.)
Public propertyTaxRate2
Gets the tax rate for the secondary tax authority for the COrder.
(Inherited from COrder.)
Public propertyTaxRate3
Gets the tax rate for the third level tax authority for the COrder.
(Inherited from COrder.)
Public propertyTaxType
Gets an enumerated value representing the type of tax applied to this COrder.
(Inherited from COrder.)
Public propertyTermsCode
Gets or sets a reference to the financial terms for this COrder.
(Inherited from COrder.)
Public propertyTitle
The job title of the CContact to which the COrder is shipped. Like CEO, Staff Accountant, etc.
(Inherited from COrder.)
Public propertyTollFreePhone
Gets or sets the toll free telephone number of this customer.
(Inherited from COrder.)
Public propertyTotalCharges
Gets the total charge (monetary) amount of the order.
(Overrides COrder..::..TotalCharges.)
Public propertyTotalExtendedAmount
Gets the total (monetary) amount of the charges for all items on the COrder.
(Inherited from COrder.)
Public propertyTotalFreightAmount
Gets the total freight charges for this order.
Public propertyTotalHandlingAmount
Gets or sets the total handling charges for this order.
Public propertyTotalPayments
Gets the cumulative amount paid against this order's charges.
(Inherited from COrder.)
Public propertyTotalPSTTaxableAmount
Gets the total monetary amount of the order lines that are PST taxable.
(Inherited from COrder.)
Public propertyTotalQuantityBackordered
Gets the total number of items on the order that are currently backordered.
Public propertyTotalQuantityOrdered
Gets the total number of items on the order.
Public propertyTotalTax
The total tax for this COrder. (Same as Tax1 + Tax2 + Tax3).
(Inherited from COrder.)
Public propertyTotalTaxableAmount
Gets the total charges on the order prior to taxation.
Public propertyTotalUndiscountedAmount
Gets the total (monetary) amount of the charges for all items on the COrder prior to taking any discounts.
(Inherited from COrder.)
Public propertyTotalWeight
Gets the total weight of all of the items on the order.
Public propertyUpdatedBy
Gets the "user name" of the person who last updated the COrder.
(Inherited from COrder.)
Public propertyUpdatedOn
Gets or the date on which the COrder was last updated.
(Inherited from COrder.)
Public propertyUseMemberPrice
Gets or sets an indicator of whether or not member pricing should be used on this COrder.
(Inherited from COrder.)
Public propertyVatTaxCodeFreightAndHandling
Gets or sets the Country Code to use for calculating the VAT (Value Added Tax) on the order's Freight and Handling charges.

See Also