The CStandardOrder type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| CStandardOrder | Overloaded. |
Methods
| Name | Description | |
|---|---|---|
| CalcFreightTotal | Overloaded. | |
| CalcHandlingTotal |
Calculates the TotalHandling amount based on the handling type.
(Inherited from COrder.) | |
| CheckAndModifyEditStatus |
Sets the EditStatus to Modified if it is Unchanged
(Inherited from iboBase.) | |
| ClearOrderLines | (Inherited from COrder.) | |
| Delete |
Marks this object to be deleted when the save is done
(Inherited from iboBase.) | |
| DetermineOrderFinancialEntity |
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.) | |
| Equals | (Inherited from Object.) | |
| Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| GetFreightCharge |
Calculate the freight charge with the current set of properties, but
with a particular shipping method.
(Inherited from COrder.) | |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetOrderLineByNum |
Given the line number on an COrder returns the COrderLine with that line number.
(Inherited from COrder.) | |
| GetShippingCosts |
Returns all possible Shipping Methods and their costs.
(Inherited from COrder.) | |
| GetShippingCostsForAllShippingMethods |
Generate a collection of all possible charges for existing ship methods.
(Inherited from COrder.) | |
| GetShippingCostsForEligibleShipMethods |
Generate a collection of all eligible shipping methods and charges based on a country when Freight-By-Weight is selected.
(Inherited from COrder.) | |
| GetStandardOrderLineByProductCode |
Gets the CStandardOrderLine object on the order for the given product
| |
| GetTaxAuthorities |
Set up TaxAuthorityCode1, TaxAuthorityCode2, TaxAuthorityCode3,
TaxRate1, TaxRate2, and TaxRate3, based on TaxType.
(Inherited from COrder.) | |
| GetTaxAuthorityVAT |
Determines whether the buyer should be taxed and for which country.
(Inherited from COrder.) | |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| NewLineItem | Overloaded. | |
| Recalc |
Recalculates tax, order line amounts, and freight and handling (and their corresponding taxes)
based upon the parameters.
(Inherited from COrder.) | |
| RecalcFreightHandlingTax |
Recalculates the freight, handling, and tax for the COrder.
(Inherited from COrder.) | |
| RemoveOrderLine |
Removes the given COrderLine from the COrder.
(Inherited from COrder.) | |
| Save | Overloaded. | |
| SaveContactChanges |
Save any changes to the Contact associated with this COrder.
(Inherited from COrder.) | |
| SetBalance | (Inherited from COrder.) | |
| SetBatchNumberFromBatch |
Set the batchnumber and batch for this COrder.
(Inherited from COrder.) | |
| SetCashGLAccount |
Sets the CashGLAccount on the COrder. Only available to derived classes.
(Inherited from COrder.) | |
| SetFundRaisingOrder |
Sets IsFundRaisingOrder on the COrder. Only available to derived classes.
(Inherited from COrder.) | |
| SetOrderNumber |
Sets the OrderNumber on the COrder. MUST BE USED WITH CAUTION.
(Inherited from COrder.) | |
| SetOrderStage | Overloaded. | |
| SetRecognizedCashAmount |
Sets the RecognizedCashAmount on the COrder. Only available to derived classes.
(Inherited from COrder.) | |
| SetTransPAYGlAccount |
Sets the GL Account number to be used on the PAY Transaction when saving the COrder.
(Inherited from COrder.) | |
| SetTransPAYGlAcctFinancialEntityCode |
Sets the Financial Entity Code to be used on the PAY Transaction when saving the COrder.
(Inherited from COrder.) | |
| ToString | (Inherited from Object.) | |
| Validate |
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
| Name | Description | |
|---|---|---|
| mEditStatus | The edit status (unchanged, modified, etc) of this record. (Inherited from iboBase.) | |
| mErrors | The current list of errors encountered by this class instance during processing. (Inherited from iboBase.) | |
| mOrderLines |
A collection of associated COrderLine objects.
(Inherited from COrder.) |
Properties
| Name | Description | |
|---|---|---|
| Address1 |
Gets or sets the first line of the physical ship-to address.
(Inherited from COrder.) | |
| Address2 |
Gets or sets the second line of the physical ship-to address.
(Inherited from COrder.) | |
| Address3 |
Gets or sets the third line of the physical ship-to address.
(Inherited from COrder.) | |
| AddressFormatCode |
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.) | |
| AffectInventoryFlag |
Gets or sets an indicator of whether or not inventory was/will be affected by this COrder.
(Inherited from COrder.) | |
| AutoCalculateFreightFlag |
Gets or sets an indicator of whether the freight on this order was/will be calculated automatically or set manually.
| |
| AutoCalculateHandlingFlag |
Gets or sets an indicator of whether the current order should automatically calculate handling charges.
| |
| AutoCalculateRestockingFlag |
Gets or sets an indicator of whether the current order should automatically calculate restocking charges.
| |
| AutoFreightAmount |
Gets the automatically calculated freight charge for this order.
| |
| AutoFreightType |
Gets or sets the freight type used in the automatic freight calculation
| |
| AutoHandlingAmount |
Gets the automatically calculated handling charge for this order.
| |
| BackorderPreference |
Gets or sets the a value that determines what to do when items on the order are backordered.
| |
| BackorderPriority |
Gets or sets the priority that will be applied to any backordered portion of the order.
| |
| BackorderReleasedOn |
Gets or sets the date and time that a backordered order was released for shipping.
| |
| BackorderStatus |
Gets or sets the current backorder status of the order.
| |
| Balance |
Gets the current unpaid balance on this COrder.
(Inherited from COrder.) | |
| Barcode |
Gets the US Postal Service Barcode representation of the ship-to address's ZIP or ZIP+4
(Inherited from COrder.) | |
| Batch | (Inherited from COrder.) | |
| BatchNumber | (Inherited from COrder.) | |
| BillToContact | (Inherited from COrder.) | |
| BillToContactId | (Inherited from COrder.) | |
| CancellationFee |
Gets the monetary amount of any cancellation fee that has been added to this COrder.
(Inherited from COrder.) | |
| CarrierRoute |
Gets or sets the carrier route data for the ship-to address. Used by the USPS to sort mail.
(Inherited from COrder.) | |
| CashAccountCode |
Gets or sets a reference to the cash account that should receive/process this payment.
(Inherited from COrder.) | |
| CashGLAccount |
Gets the General Ledger Cash Account used on this order.
| |
| CheckPOPaymentNumber |
Gets or sets the payment number, e.g., the check number for checks or PO number for purchase orders.
(Inherited from COrder.) | |
| City |
Gets or sets the city (town, village, etc.) of the physical ship-to address.
(Inherited from COrder.) | |
| CommissionRate |
Gets or sets the salesperson's commission rate for this order.
| |
| ConfirmationOn |
Gets or sets the date and time on which an order confirmation was sent to the customer.
| |
| Country |
Gets or sets the name of the Country where the physical ship-to address is located.
(Inherited from COrder.) | |
| CreditCardExpiration |
Gets or sets the Expiration date of the credit card for credit card payments.
(Inherited from COrder.) | |
| CreditCardExpirationEncrypted |
Gets the credit card expiration date associated with the payment after it has been encrypted.
(Inherited from COrder.) | |
| CreditCardNumber |
Gets or sets the credit card number for payments made by credit card.
(Inherited from COrder.) | |
| CreditCardSecurityCode |
Gets or sets the credit card security code found on the credit card.
(Inherited from COrder.) | |
| CreditCardSecurityCodeEncrypted |
Gets the credit card security code associated with the payment after it has been encrypted.
(Inherited from COrder.) | |
| CreditDebitCardAuthorizationCode |
Gets or sets the credit card authorization code typically returned from a 3rd party credit card processing service.
(Inherited from COrder.) | |
| CreditDebitCardHoldersName |
Gets or sets the name of the credit card holder, as it appears on the card.
(Inherited from COrder.) | |
| CreditDebitCardNumberEncrypted |
Gets the credit or debit card number associated with the payment after it has been encrypted.
(Inherited from COrder.) | |
| CustomerReferenceValue |
Gets or sets a reference value that is essentially a note that relates this COrder to something else.
(Inherited from COrder.) | |
| CustomerTypeCode |
Gets or sets a reference to the CCustomerType of the bill-to customer/contact.
(Inherited from COrder.) | |
| DebitCardIssueDate |
Gets or sets the Issue Date from a European debit card, for debit card payment.
(Inherited from COrder.) | |
| DebitCardIssueNumber |
Gets or sets the Issue Number from a European debit card, for debit card payment.
(Inherited from COrder.) | |
| DebitCardNumber |
Gets or sets the debit card number for payments made by debit card.
(Inherited from COrder.) | |
| DeliveryPointBarcode |
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.) | |
| Designation |
Gets or sets the designation that follows the ship-to customer's name.
(Inherited from COrder.) | |
| DisableAutoFreightCalcOnError |
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.) | |
| DiscountPercent |
Gets or sets the percentage discount to be applied to the entire order.
| |
| EditStatus |
Indicates the current edit status of this object, i.e., New, Modified, Deleted, or Unchanged. See EEditStatus (Inherited from iboBase.) | |
| EmailAddress |
The email address of the customer.
(Inherited from COrder.) | |
| EnteredBy |
Gets the "user name" of the person who entered the COrder.
(Inherited from COrder.) | |
| EnteredOn |
Gets or sets the date on which the COrder was entered.
(Inherited from COrder.) | |
| Errors |
The collection of CError objects (error and warning messages) associated with this object instance
(Inherited from iboBase.) | |
| ErrorsCount |
Gets the number of error and warning messages that have been set on this object.
(Inherited from iboBase.) | |
| Fax |
Gets or sets the FAX number (facsimile telephone number) of the customer.
(Inherited from COrder.) | |
| FinancialEntityCode |
Gets or sets a reference to the Financial Entity (Organization) with which this COrder is associated.
(Inherited from COrder.) | |
| FirstName |
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.) | |
| FormattedAddress |
Gets or sets the full, formatted ship to address.
(Inherited from COrder.) | |
| FreightHandlingTax |
Gets the freight and handling tax for this order.
| |
| FullName |
Gets the full name of the customer to which the COrder was/should be shipped.
(Inherited from COrder.) | |
| HoldCode |
Gets or sets a value indicating that the COrder is on hold and why.
(Inherited from COrder.) | |
| HoldComment |
Gets or sets a comment about why the COrder was put on hold.
(Inherited from COrder.) | |
| HoldFlag |
Gets an indicator of whether or not the COrder is on hold.
(Inherited from COrder.) | |
| IgnoreFieldValidationErrors |
Gets or sets an indication of whether field validation errors should be ignored
when setting selected contact-related fields.
(Inherited from COrder.) | |
| Informal |
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.) | |
| InstituteContactId |
Gets or sets the ContactId of the Institute/Company with which the ship-to contact is associated.
(Inherited from COrder.) | |
| InstituteCustomerTypeCode |
Gets a reference to the CCustomerType of the Institute/Company with which the ship-to contact is associated.
(Inherited from COrder.) | |
| InstituteName |
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.) | |
| InstituteSort |
Gets the Institute name, optimized for sorting
(Inherited from COrder.) | |
| InvoiceDate |
Gets or sets the invoice date associated with this COrder.
(Inherited from COrder.) | |
| InvoiceNumber |
Gets or sets the invoice number associated with this COrder.
(Inherited from COrder.) | |
| InvoiceReferenceNumber |
Get the reference number associated with the invoice created when the COrder is saved and the financial
transactions are created.
(Inherited from COrder.) | |
| IsFundRaisingOrder |
Gets an indicator of whether this COrder contains fundraising items.
(Inherited from COrder.) | |
| IsIncludedInInventoryValuation |
Gets or sets an indicator of whether this order is ready to be included in the inventory valuation process.
| |
| IsOrderLinesEmpty |
Gets an indicator of whether or not order-lines exists for this item.
(Inherited from COrder.) | |
| IsOrderTaxable |
Gets an indicator of whether or not this COrder should be taxed.
(Inherited from COrder.) | |
| LastFirst | (Inherited from COrder.) | |
| LastName |
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.) | |
| MailCode |
Gets or sets the Mail Code associated with the ship-to address, for sorting in large mailings.
(Inherited from COrder.) | |
| ManualFreightAmount |
Gets or set the manually calculated freight charge for this order.
| |
| ManualHandlingAmount |
Gets or set the manually calculated handling charge for this order.
| |
| MiddleName |
Gets or sets the middle name of the ship-to customer.
(Inherited from COrder.) | |
| Note |
Gets or sets any comments that need to be made about the COrder.
(Inherited from COrder.) | |
| NumberOfLines |
Gets the number of order lines on the COrder.
(Inherited from COrder.) | |
| OrderedOn |
Gets or sets the date on which the COrder was placed.
(Inherited from COrder.) | |
| OrderLines |
Gets an array of the COrderLine objects associated with the order.
| |
| OrderLinesCount |
Gets a count of the number of COrderLines on the COrder.
(Inherited from COrder.) | |
| OrderNumber |
Gets the automatically generated sequential order number assigned to this COrder.
(Inherited from COrder.) | |
| OrderTypeCode |
Gets or sets a reference to the type of this COrder.
(Inherited from COrder.) | |
| Payment | (Inherited from COrder.) | |
| PaymentInfoComment1 |
Gets the first transaction comment information associated with the payment.
(Inherited from COrder.) | |
| PaymentInfoComment2 |
Gets the second transaction comment information associated with the payment.
(Inherited from COrder.) | |
| PaymentType |
Gets or sets a value that indicates what type of payment is being made with this COrder.
(Inherited from COrder.) | |
| Phone |
Gets or sets the telephone number of this contact.
(Inherited from COrder.) | |
| PostalCode |
Gets or sets the postal code (zip code, post code) associated with the physical ship-to address.
(Inherited from COrder.) | |
| Prefix |
Gets or sets the prefix (personal title) to the ship to customer's name. Like Mr., Mrs., etc.
(Inherited from COrder.) | |
| PrepaidInvoiceReferenceNumber |
Gets or sets the invoice reference number of the pre-paid invoice associated with this COrder.
(Inherited from COrder.) | |
| PrintBusinessTitleOnShipTo |
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.) | |
| PrintInstituteNameOnShipTo |
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.) | |
| RecognizedCashAmount |
Gets the monetary amount of the order that has been recognized as cash by the accounting system.
| |
| Salesperson |
Gets or sets the "name" of the sales person who made the sale.
(Inherited from COrder.) | |
| ScheduledDate |
Gets or sets the date that the order is scheduled to ship.
| |
| ShipMethodCode |
Gets or sets a reference to the shipping method used to ship this order.
| |
| ShipPapersOn |
Gets or sets the date and time at which the shipping papers were generated/printed for this order.
| |
| ShippedOn |
Gets or sets the date and time at which the order shipped.
| |
| ShipToAddress |
Gets or sets the CAddressBasic object representing the physical address to which this COrder will ship.
(Inherited from COrder.) | |
| ShipToAddressNumber | (Inherited from COrder.) | |
| ShipToContact | (Inherited from COrder.) | |
| ShipToContactBasic |
Gets the CContactBasic object representing the contact to whom this COrder will ship.
(Inherited from COrder.) | |
| ShipToContactId | (Inherited from COrder.) | |
| SourceCode |
Gets or sets the marketing Source Code that prompted the COrder.
(Inherited from COrder.) | |
| SourceSystem |
Gets a code indicating which iMIS sub-system originated the COrder.
(Inherited from COrder.) | |
| Stage |
Gets the current processing stage of this COrder. (Inherited from COrder.) | |
| StateProvince |
Gets or sets the State, Province, or equivalent in which the physical ship-to address is located.
(Inherited from COrder.) | |
| Suffix |
Gets or sets the suffix to the ship-to customer's name. Like Sr., Jr., etc.
(Inherited from COrder.) | |
| Tax1 |
Gets the total tax for the primary tax authority on this COrder.
(Inherited from COrder.) | |
| Tax2 |
Gets the total tax for the secondary tax authority on this COrder.
(Inherited from COrder.) | |
| Tax3 |
Gets the total tax for the third level tax authority on this COrder.
(Inherited from COrder.) | |
| TaxAuthorityCode1 |
Gets or sets a reference to the primary tax authority for the COrder.
(Inherited from COrder.) | |
| TaxAuthorityCode2 |
Gets or sets a reference to the secondary tax authority for the COrder.
(Inherited from COrder.) | |
| TaxAuthorityCode3 |
Gets or sets a reference to the third level tax authority for the COrder.
(Inherited from COrder.) | |
| TaxExemptNumber |
Gets or sets the bill-to contact's government issued Tax Exemption number.
| |
| TaxFinancialEntity |
Gets the Financial Entity to be used for tax calculation purposes
(Inherited from COrder.) | |
| TaxRate1 |
Gets the tax rate for the primary tax authority for the COrder.
(Inherited from COrder.) | |
| TaxRate2 |
Gets the tax rate for the secondary tax authority for the COrder.
(Inherited from COrder.) | |
| TaxRate3 |
Gets the tax rate for the third level tax authority for the COrder.
(Inherited from COrder.) | |
| TaxType |
Gets an enumerated value representing the type of tax applied to this COrder.
(Inherited from COrder.) | |
| TermsCode |
Gets or sets a reference to the financial terms for this COrder.
(Inherited from COrder.) | |
| Title | (Inherited from COrder.) | |
| TollFreePhone |
Gets or sets the toll free telephone number of this customer.
(Inherited from COrder.) | |
| TotalCharges |
Gets the total charge (monetary) amount of the order.
(Overrides COrder..::.TotalCharges.) | |
| TotalExtendedAmount |
Gets the total (monetary) amount of the charges for all items on the COrder.
(Inherited from COrder.) | |
| TotalFreightAmount |
Gets the total freight charges for this order.
| |
| TotalHandlingAmount |
Gets or sets the total handling charges for this order.
| |
| TotalPayments |
Gets the cumulative amount paid against this order's charges.
(Inherited from COrder.) | |
| TotalPSTTaxableAmount |
Gets the total monetary amount of the order lines that are PST taxable.
(Inherited from COrder.) | |
| TotalQuantityBackordered |
Gets the total number of items on the order that are currently backordered.
| |
| TotalQuantityOrdered |
Gets the total number of items on the order.
| |
| TotalTax |
The total tax for this COrder. (Same as Tax1 + Tax2 + Tax3).
(Inherited from COrder.) | |
| TotalTaxableAmount |
Gets the total charges on the order prior to taxation.
| |
| TotalUndiscountedAmount |
Gets the total (monetary) amount of the charges for all items on the COrder prior to taking any discounts.
(Inherited from COrder.) | |
| TotalWeight |
Gets the total weight of all of the items on the order.
| |
| UpdatedBy |
Gets the "user name" of the person who last updated the COrder.
(Inherited from COrder.) | |
| UpdatedOn |
Gets or the date on which the COrder was last updated.
(Inherited from COrder.) | |
| UseMemberPrice |
Gets or sets an indicator of whether or not member pricing should be used on this COrder.
(Inherited from COrder.) | |
| VatTaxCodeFreightAndHandling |
Gets or sets the Country Code to use for calculating the VAT (Value Added Tax) on the order's Freight and Handling charges.
|