The COrder type exposes the following members.

Constructors

  NameDescription
Protected methodCOrder(IiMISUser)
This constructor creates a new COrder object.
Public methodCOrder(IiMISUser, Double)
This constructor instantiates an existing COrder from the database.

Methods

  NameDescription
Protected methodCalcFreightTotal()()()()
Convenience method to calculate the total freight charge for this order.
Protected methodCalcFreightTotal(Boolean)
Worker method to calculate the total freight charge for this order.
Protected methodCalcHandlingTotal
Calculates the TotalHandling amount based on the handling type.
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.
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.
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.
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.
Public methodGetShippingCosts
Returns all possible Shipping Methods and their costs.
Public methodGetShippingCostsForAllShippingMethods
Generate a collection of all possible charges for existing ship methods.
Public methodGetShippingCostsForEligibleShipMethods
Generate a collection of all eligible shipping methods and charges based on a country when Freight-By-Weight is selected.
Protected methodGetTaxAuthorities
Protected methodGetTaxAuthorityVAT
Determines whether the buyer should be taxed and for which country.
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.)
Protected methodRecalc
Recalculates tax, order line amounts, and freight and handling (and their corresponding taxes) based upon the parameters.
Protected methodRecalcFreightHandlingTax
Recalculates the freight, handling, and tax for the COrder.
Public methodRemoveOrderLine
Removes the given COrderLine from the COrder.
Protected methodStatic memberRetrieve
Populate an empty COrder object from the data supplied by the SqlDataReader object.
Public methodSave()()()()
Saves the COrder along with all of its child records to the database using a new DataServer.
Public methodSave(DataServer)
Saves the COrder along with all of its child records to the database.
Public methodSaveContactChanges
Save any changes to the Contact associated with this COrder.
Protected methodSetBalance
Sets the Balance on the COrder. Only available to derived classes.
Public methodSetBatchNumberFromBatch
Set the batchnumber and batch for this COrder.
Protected methodSetCashGLAccount
Sets the CashGLAccount on the COrder. Only available to derived classes.
Protected methodSetFundRaisingOrder
Sets IsFundRaisingOrder on the COrder. Only available to derived classes.
Public methodSetOrderNumber
Sets the OrderNumber on the COrder. MUST BE USED WITH CAUTION.
Protected methodSetOrderStage(String)
Sets the Stage on the COrder. Only available to derived classes.
Protected methodSetOrderStage(OrderStage)
Sets the Stage on the COrder. Only available to derived classes.
Protected methodSetRecognizedCashAmount
Sets the RecognizedCashAmount on the COrder. Only available to derived classes.
Protected methodSetTransPAYGlAccount
Sets the GL Account number to be used on the PAY Transaction when saving the COrder.
Protected methodSetTransPAYGlAcctFinancialEntityCode
Sets the Financial Entity Code to be used on the PAY Transaction when saving the COrder.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodValidate
Makes sure that all of the property data passes the iMIS business rules.
(Overrides iboBase..::..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.

Properties

  NameDescription
Public propertyAddress1
Gets or sets the first line of the physical ship-to address.
Public propertyAddress2
Gets or sets the second line of the physical ship-to address.
Public propertyAddress3
Gets or sets the third line of the physical ship-to address.
Public propertyAddressFormatCode
Gets or sets a reference to the address format to use when creating the FormattedAddress out of the various physical address components.
Public propertyAffectInventoryFlag
Gets or sets an indicator of whether or not inventory was/will be affected by this COrder.
Protected propertyAutoCalculateFreightFlag
Gets or sets an indicator of whether the freight on this order was/will be calculated automatically or set manually.
Protected propertyAutoCalculateHandlingFlag
Gets or sets an indicator of whether the current order should automatically calculate handling charges.
Protected propertyAutoCalculateRestockingFlag
Gets or sets an indicator of whether the current order should automatically calculate restocking charges.
Protected propertyAutoFreightAmount
Gets the automatically calculated freight charge for this order.
Protected propertyAutoFreightType
Gets or sets the freight type used in the automatic freight calculation
Protected propertyAutoHandlingAmount
Gets the automatically calculated handling charge for this order.
Protected propertyBackorderPreference
Gets or sets the a value that determines what to do when items on the order are backordered.
Protected propertyBackorderPriority
Gets or sets the priority that will be applied to any backordered portion of the order.
Protected propertyBackorderReleasedOn
Gets or sets the date and time that a backordered order was released for shipping.
Protected propertyBackorderStatus
Gets or sets the current backorder status of the order.
Public propertyBalance
Gets the current unpaid balance on this COrder.
Public propertyBarcode
Gets the US Postal Service Barcode representation of the ship-to address's ZIP or ZIP+4
Public propertyBatch
Gets the CBatch object associated with the COrder.
Public propertyBatchNumber
Gets or sets the number of the accounting system CBatch with which this COrder is associated.
Public propertyBillToContact
Gets or sets the CContact object representing the contact to whom this COrder will be billed.
Public propertyBillToContactId
Gets or sets the ContactId of the CContact to whom this COrder is to be billed.
Public propertyCanadianTaxes
Returns details of the Canadian taxes for this Order
Public propertyCancellationFee
Gets the monetary amount of any cancellation fee that has been added to this COrder.
Public propertyCarrierRoute
Gets or sets the carrier route data for the ship-to address. Used by the USPS to sort mail.
Public propertyCashAccountCode
Gets or sets a reference to the cash account that should receive/process this payment.
Protected 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.
Public propertyCity
Gets or sets the city (town, village, etc.) of the physical ship-to address.
Protected propertyCommissionRate
Gets or sets the salesperson's commission rate for this order.
Protected 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.
Public propertyCreditCardExpiration
Gets or sets the Expiration date of the credit card for credit card payments.
Public propertyCreditCardExpirationEncrypted
Gets the credit card expiration date associated with the payment after it has been encrypted.
Public propertyCreditCardNumber
Gets or sets the credit card number for payments made by credit card.
Public propertyCreditCardSecurityCode
Gets or sets the credit card security code found on the credit card.
Public propertyCreditCardSecurityCodeEncrypted
Gets the credit card security code associated with the payment after it has been encrypted.
Public propertyCreditDebitCardAuthorizationCode
Gets or sets the credit card authorization code typically returned from a 3rd party credit card processing service.
Public propertyCreditDebitCardHoldersName
Gets or sets the name of the credit card holder, as it appears on the card.
Public propertyCreditDebitCardNumberEncrypted
Gets the credit or debit card number associated with the payment after it has been encrypted.
Public propertyCustomerReferenceValue
Gets or sets a reference value that is essentially a note that relates this COrder to something else.
Public propertyCustomerTypeCode
Gets or sets a reference to the CCustomerType of the bill-to customer/contact.
Public propertyDebitCardIssueDate
Gets or sets the Issue Date from a European debit card, for debit card payment.
Public propertyDebitCardIssueNumber
Gets or sets the Issue Number from a European debit card, for debit card payment.
Public propertyDebitCardNumber
Gets or sets the debit card number for payments made by debit card.
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.
Public propertyDesignation
Gets or sets the designation that follows the ship-to customer's name.
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.
Protected 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.
Public propertyEnteredBy
Gets the "user name" of the person who entered the COrder.
Public propertyEnteredOn
Gets or sets the date on which the COrder was entered.
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.
Public propertyFinancialEntityCode
Gets or sets a reference to the Financial Entity (Organization) with which this COrder is associated.
Public propertyFirstName
Gets or sets the first (or given) name of the ship-to customer, if a person. Not set for Institute/Company records.
Public propertyFormattedAddress
Gets or sets the full, formatted ship to address.
Public propertyFullName
Gets the full name of the customer to which the COrder was/should be shipped.
Public propertyHoldCode
Gets or sets a value indicating that the COrder is on hold and why.
Public propertyHoldComment
Gets or sets a comment about why the COrder was put on hold.
Public propertyHoldFlag
Gets an indicator of whether or not the COrder is on hold.
Public propertyIgnoreFieldValidationErrors
Gets or sets an indication of whether field validation errors should be ignored when setting selected contact-related fields.
Public propertyInformal
Gets or sets the informal or nickname of the ship-to contact. For example, FirstName = "Robert", the informal name might be "Bob".
Public propertyInstituteContactId
Gets or sets the ContactId of the Institute/Company with which the ship-to contact is associated.
Public propertyInstituteCustomerTypeCode
Gets a reference to the CCustomerType of the Institute/Company with which the ship-to contact is associated.
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.
Public propertyInstituteSort
Gets the Institute name, optimized for sorting
Public propertyInvoiceDate
Gets or sets the invoice date associated with this COrder.
Public propertyInvoiceNumber
Gets or sets the invoice number associated with this COrder.
Public propertyInvoiceReferenceNumber
Get the reference number associated with the invoice created when the COrder is saved and the financial transactions are created.
Public propertyIsFundRaisingOrder
Gets an indicator of whether this COrder contains fundraising items.
Protected 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.
Public propertyIsOrderTaxable
Gets an indicator of whether or not this COrder should be taxed.
Public propertyLastFirst
Gets the ship-to customer's last and first name. Calculated as LastName, FirstName.
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.
Public propertyMailCode
Gets or sets the Mail Code associated with the ship-to address, for sorting in large mailings.
Protected propertyManualFreightAmount
Gets or set the manually calculated freight charge for this order.
Protected 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.
Public propertyNote
Gets or sets any comments that need to be made about the COrder.
Public propertyNumberOfLines
Gets the number of order lines on the COrder.
Public propertyOrderedOn
Gets or sets the date on which the COrder was placed.
Public propertyOrderLines
Gets an array of the COrderLine objects associated with the COrder.
Public propertyOrderLinesCount
Gets a count of the number of COrderLines on the COrder.
Public propertyOrderNumber
Gets the automatically generated sequential order number assigned to this COrder.
Public propertyOrderTypeCode
Gets or sets a reference to the type of this COrder.
Public propertyPayment
Gets the CPayment object associated with the COrder.
Public propertyPaymentInfoComment1
Gets the first transaction comment information associated with the payment.
Public propertyPaymentInfoComment2
Gets the second transaction comment information associated with the payment.
Public propertyPaymentType
Gets or sets a value that indicates what type of payment is being made with this COrder.
Public propertyPhone
Gets or sets the telephone number of this contact.
Public propertyPostalCode
Gets or sets the postal code (zip code, post code) associated with the physical ship-to address.
Public propertyPrefix
Gets or sets the prefix (personal title) to the ship to customer's name. Like Mr., Mrs., etc.
Public propertyPrepaidInvoiceReferenceNumber
Gets or sets the invoice reference number of the pre-paid invoice associated with this 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.
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.
Protected 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.
Protected propertyScheduledDate
Gets or sets the date that the order is scheduled to ship.
Protected propertyShipMethodCode
Gets or sets a reference to the shipping method used to ship this order.
Protected propertyShipPapersOn
Gets or sets the date and time at which the shipping papers were generated/printed for this order.
Protected 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.
Public propertyShipToAddressNumber
Gets or sets the address number of the CAddress to which the COrder should be shipped.
Public propertyShipToContact
Gets or sets the CContact object representing the contact to whom this COrder will ship.
Public propertyShipToContactBasic
Gets the CContactBasic object representing the contact to whom this COrder will ship.
Public propertyShipToContactId
Gets or sets the ContactId of the CContact to whom this COrder is to be shipped.
Public propertySourceCode
Gets or sets the marketing Source Code that prompted the COrder.
Public propertySourceSystem
Gets a code indicating which iMIS sub-system originated the COrder.
Public propertyStage
Gets the current processing stage of this COrder.
Public propertyStateProvince
Gets or sets the State, Province, or equivalent in which the physical ship-to address is located.
Public propertySuffix
Gets or sets the suffix to the ship-to customer's name. Like Sr., Jr., etc.
Public propertyTax1
Gets the total tax for the primary tax authority on this COrder.
Public propertyTax2
Gets the total tax for the secondary tax authority on this COrder.
Public propertyTax3
Gets the total tax for the third level tax authority on this COrder.
Public propertyTaxAuthorityCode1
Gets or sets a reference to the primary tax authority for the COrder.
Public propertyTaxAuthorityCode2
Gets or sets a reference to the secondary tax authority for the COrder.
Public propertyTaxAuthorityCode3
Gets or sets a reference to the third level tax authority for the COrder.
Protected 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
Public propertyTaxRate1
Gets the tax rate for the primary tax authority for the COrder.
Public propertyTaxRate2
Gets the tax rate for the secondary tax authority for the COrder.
Public propertyTaxRate3
Gets the tax rate for the third level tax authority for the COrder.
Public propertyTaxType
Gets an enumerated value representing the type of tax applied to this COrder.
Public propertyTermsCode
Gets or sets a reference to the financial terms for this COrder.
Public propertyTitle
The job title of the CContact to which the COrder is shipped. Like CEO, Staff Accountant, etc.
Public propertyTollFreePhone
Gets or sets the toll free telephone number of this customer.
Public propertyTotalCharges
Gets the total charge (monetary) amount of the COrder.
Public propertyTotalExtendedAmount
Gets the total (monetary) amount of the charges for all items on the COrder.
Protected propertyTotalFreightAmount
Gets the total freight charges for this order.
Protected propertyTotalHandlingAmount
Gets or sets the total handling charges for this order.
Public propertyTotalPayments
Gets the cumulative amount paid against this order's charges.
Public propertyTotalPSTTaxableAmount
Gets the total monetary amount of the order lines that are PST taxable.
Protected propertyTotalQuantityBackordered
Gets the total number of items on the order that are currently backordered.
Protected propertyTotalQuantityOrdered
Gets the total number of items on the order.
Public propertyTotalTax
The total tax for this COrder. (Same as Tax1 + Tax2 + Tax3).
Public propertyTotalTaxableAmount
Gets the total (monetary) amount of the taxable charges for all items on the COrder.
Public propertyTotalUndiscountedAmount
Gets the total (monetary) amount of the charges for all items on the COrder prior to taking any discounts.
Protected 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.
Public propertyUpdatedOn
Gets or the date on which the COrder was last updated.
Public propertyUseMemberPrice
Gets or sets an indicator of whether or not member pricing should be used on this COrder.
Protected 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