SalesOrder Class |
Sales order document headers. Entity: Crm_Sales_Orders
Inheritance HierarchySystemObject
Aloe.SystemFrameworks.DomainDomainObject
Aloe.SystemFrameworks.DomainEditableDomainObject
Aloe.SystemFrameworks.DomainEntityObject
Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
Aloe.EnterpriseOne.Model.GeneralDocument
Aloe.EnterpriseOne.Model.GeneralLogisticsDocument
Aloe.EnterpriseOne.Model.Crm.SalesSalesOrder
Aloe.SystemFrameworks.DomainDomainObject
Aloe.SystemFrameworks.DomainEditableDomainObject
Aloe.SystemFrameworks.DomainEntityObject
Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
Aloe.EnterpriseOne.Model.GeneralDocument
Aloe.EnterpriseOne.Model.GeneralLogisticsDocument
Aloe.EnterpriseOne.Model.Crm.SalesSalesOrder
Namespace: Aloe.EnterpriseOne.Model.Crm.Sales
Assembly: Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5
SyntaxThe SalesOrder type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SalesOrder | Initializes a new instance of the SalesOrder class with specific ObjectTransaction |
Properties| Name | Description | |
|---|---|---|
 | AccessKey | The access key, containing the user permissions for this document. null means that all users have unlimited permissions (Inherited from Document.) |
| AdjustedDocument | The primary document, which the current document adjusts. null when this is not an adjustment document (Inherited from Document.) |
| AdjustmentNumber | Consecutive number of the correction that this document is applying to the adjusted document. [Required] (Inherited from Document.) |
| AdjustmentTime | Date/time when the document last has been adjusted by corrective document (Inherited from Document.) |
| AdjustmentUser | The user who adjusted the document (Inherited from Document.) |
| AssignedToUser | The user to which this document is assigned for handling. null means that the document is not assigned to specific user (Inherited from Document.) |
| ChangingAttributes |
Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow.
(Inherited from EditableDomainObject.) |
| Comments | List of DocumentComment child objects, based on the DocumentComment.Document back reference (Inherited from Document.) |
| CompleteTime | Exact time, when the document was last completed[Filter(ge;le)] (Inherited from Document.) |
| CreationTime | Date/Time when the document was created [Required][Filter(ge;le)] (Inherited from Document.) |
| CreationUser | The login name of the user, who created the document [Required][Filter(like)] (Inherited from Document.) |
| CreditLimitOverride | Allows the sales order to be released even in the case of violations of credit limit or presence of overdue receivables. [Required] [Default(false)] [Filter(eq)] |
| CurrencyDirectory | The currency directory, containing all the convertion rates, used by the document. null means that the document does not need currency convertions (Inherited from Document.) |
| Customer | The primary customer, which placed the sales order. [Required] [Filter(multi eq)] |
| CustomerPurchaseOrderDate | Issue date of the referent customer purchase order. [Filter(ge;le)] |
| CustomerPurchaseOrderNo | Reference number of the customer's purchase order. [Filter(eq;like)] |
| CustomProperties |
Gets the custom properties of the object.
(Inherited from EnterpriseOneEntityObject.) |
| Deal | The opportunity (deal) on which this order is based. [Filter(multi eq)] |
| Dealer | The external dealer, associated with the sales order. [Filter(multi eq)] |
| DealType | Deal type to be passed to the invoice. If deal type in entered then the invoice creates VAT entry for this deal type. [Filter(multi eq)] |
| DeliveryTermsCode | Mode of delivery, like CIF, FOB, etc. Used also in Intrastat reporting. |
| DistributedAmounts | List of DocumentDistributedAmount child objects, based on the DocumentDistributedAmount.Document back reference (Inherited from Document.) |
| DistributedAmountsFromOtherDocuments |
Gets the distributed amounts where this document is referenced.
(Inherited from LogisticsDocument.) |
| DistributionChannel | The distribution channel, that is used to deliver the products. [Filter(multi eq)] |
| DocumentAmounts | List of DocumentAmount child objects, based on the DocumentAmount.Document back reference (Inherited from LogisticsDocument.) |
| DocumentCurrency | The currency of the document; e.g. the currency of the amounts in the document. [Required] [Filter(multi eq)] (Overrides LogisticsDocumentDocumentCurrency.) |
| DocumentDate | The date on which the document was issued [Required][Filter(eq;ge;le)][ORD] (Inherited from Document.) |
| DocumentId |
Gets the Id of the document row, related to the domain object
(Inherited from Document.) |
| DocumentNo | Document number, unique within Document_Type_Id [Required][Filter(eq;like)][ORD] (Inherited from Document.) |
| DocumentNotes | Notes for this Document (Inherited from Document.) |
| DocumentText |
Gets the document display text ({DocumentTypeName} {DocumentNo}).
(Inherited from Document.) |
| DocumentType | The user defined type of the document. Determines document behaviour, properties, additional amounts, validation, generations, etc. [Required] (Inherited from Document.) |
| DocumentVersion | [Filter(eq;ge;le)] (Inherited from Document.) |
| EndCustomerParty | The end customer is the customer of the dealer. It is stored for information purposes only. The end customer may not have customer definition; any party can be used. [Filter(multi eq)] |
| EnterpriseCompany | The enterprise company which issued the document [Required] (Inherited from Document.) |
| EnterpriseCompanyLocation | The enterprise company location which issued the document. null means that there is only one location within the enterprise company and locations are not used (Inherited from Document.) |
| EntityName | The entity name of the document equal to the entity name of the document type.[Filter(eq)] [ORD] (Inherited from Document.) |
| ExtendedProperties |
Extended properties contain temporary (not persisted) values in the object instance.
(Inherited from EntityObject.) |
| FileAttachments | List of DocumentFileAttachment child objects, based on the DocumentFileAttachment.Document back reference (Inherited from Document.) |
| FiscalPrinterPosDevice | For POS sales, specifies the fiscal printer. null when the sales is not a POS sale. [Filter(multi eq)] |
| FiscalSalesNumber | Unique number of the sale, assigned for fiscal reporting purposes. The format is according to the applicable legislation. null means that there is no requirement for fiscal sales number for this document or it is unknown. [Filter(multi eq;like)] [ReadOnly] |
| FromCompanyDivision | The division of the company, issuing the document. null when the document is not issued by any specific division (Inherited from Document.) |
| FromDate | When selling a service valid only for a period, denotes the beginning of the period. null means that it is unknown or N/A. |
| FromParty | The party which issued the document [Required] (Inherited from Document.) |
| Id |
The unique Id of the entity object
(Inherited from EntityObject.) |
| IntrastatTransactionNatureCode | Transaction nature; used for Intrastat reporting. |
| IntrastatTransportCountry | Country of origin of the transport company; used for Intrastat reporting. [Filter(multi eq)] |
| IntrastatTransportModeCode | Transport mode; used for Intrastat reporting. |
| IsAdjustingDocument |
Gets a value indicating whether this instance is adjusting document.
(Inherited from Document.) |
| IsGhost |
Returns true when the object is a ghost object
(Inherited from EntityObject.) |
| IsLoaded | Gets a value indicating whether the associated data for this domain object is loaded. (Overrides DocumentIsLoaded.) |
| IsReleased | True if the document is not void and its state is released or greater. [Required] [Default(false)] [Filter(eq)] [ReadOnly] |
| IsSingleExecution | Specifies whether the document is a single execution of its order document. [Required] [Default(false)] [Filter(eq)] [ReadOnly] |
| IsValidField | True when the order is valid (e.g. released and not void). Used for internal processing. [Required] [Default(false)] [ReadOnly] |
| ItemString |
Gets or sets the value of a data attribute
(Inherited from DomainObject.) |
| ItemIDataAttribute |
Gets or sets the value of a data attribute
(Inherited from DomainObject.) |
| LineAmounts | List of DocumentLineAmount child objects, based on the DocumentLineAmount.Document back reference (Inherited from Document.) |
| Lines | List of SalesOrderLine child objects, based on the Crm.Sales.SalesOrderLine.SalesOrder back reference |
| LogisticsLines |
Gets the logistics lines of the document.
(Overrides LogisticsDocumentLogisticsLines.) |
| LogisticsLinesCollections |
Gets the logistics lines collections.
Some documents have more than one child collection with logistics lines.
(Inherited from LogisticsDocument.) |
| MasterDocument | In a multi-document tree, this is the root document, that created the whole tree. If this is the root it is equal to Id [Required] (Inherited from Document.) |
| NoEvents |
Turns on "No events" mode and returns a class, that will turn it off when Disposed. See remarks for more info.
(Inherited from DomainObject.) |
| Notes | Notes for this SalesOrder. |
| ObjectState | Gets the state of the domain object. (Overrides DocumentObjectState.) |
| Parent | In a multi-document tree, this is the direct parent document. If this is the root it is null (Inherited from Document.) |
| ParentDocumentRelationshipType | Type of relationship between the current document and the parent document(s). Affects the constraints for execution/completion for the documents. Possible values: 'S' = 'Subtask', 'N' = 'Next task'. (Inherited from Document.) |
| PaymentAccount | When not null, the payment account, where the payment is expected. null=no expectation for account. [Filter(multi eq)] |
| PaymentDueDate | The last term for the payment of the sales order. [Filter(ge;le)] |
| PaymentDueStartDate | The date when the payment becomes due for documents with one installment. null when the document is with multiple installments. |
| PaymentPlans | List of SalesOrderPaymentPlan child objects, based on the Crm.Sales.SalesOrderPaymentPlan.SalesOrder back reference |
| PaymentType | When not null specifies the payment type for the sales order. [Filter(multi eq)] |
| PlanningOnly | Indicates that the document is used only for planning (and as consequence its state cannot be greater than Planned) [Required] (Inherited from Document.) |
| PosLocation | For POS sales, specifies the POS location, in which the sale is performed. null when the sales is not a POS sale. [Filter(multi eq)] |
| PosOperator | For POS sales, specifies the POS operator, who created the sale. null when the sale is not a POS sale. [Filter(multi eq)] |
| PosTerminal | For POS sales, specifies the POS terminal, on which the sale is entered. null when the sales is not a POS sale. [Filter(multi eq)] |
| PriceList | The price list to be used for determining product prices in the lines. [Filter(multi eq)] |
| PrimeCauseDocument | The document that is the prime cause for creation of the current document (Inherited from Document.) |
| Prints | List of DocumentPrint child objects, based on the DocumentPrint.Document back reference (Inherited from Document.) |
| PromotionalPackages | List of SalesOrderPromotionalPackage child objects, based on the Crm.Sales.SalesOrderPromotionalPackage.SalesOrder back reference |
| ReadOnly | True - the document is read only; false - the document is not read only [Required] (Inherited from Document.) |
| ReferenceDate | The date to which this document refers, i.e. when the action really occurred. If null, Document_Date is taken [Filter(ge;le)] (Inherited from Document.) |
| ReferenceDocumentNo | The number of the document (issued by the other party), which was the reason for the creation of the current document. The numebr should be unique within the party documents [Filter(eq;like)] (Inherited from Document.) |
| ReleaseTime | Exact time, when the document was first released [Filter(ge;le)] (Inherited from Document.) |
| Repository | Provides access to SalesOrdersRepository repository methods |
| RequiredDeliveryDate | The required delivery date for all lines in the sales order. Initially calculated, based on either the Ship To Customer or Customer delivery term. [Filter(ge;le)] |
| ResponsiblePerson | The person that is responsible for this order or transaction. It could be the sales person, the orderer, etc. (Inherited from Document.) |
| ReturnForInvoice | When specified indicates that some of the goods sold in the sales orders invoiced with Return_For_Invoice_Id are returned with the current document. [Filter(multi eq)] |
| ReturnForSalesOrder | When specified indicates that some of the goods sold in Return_For_Sales_Order_Id are returned with the current document. [Filter(multi eq;like)] |
| ReverseOfDocument | The document which the current document is reverse of (Inherited from Document.) |
| SalesPerson | Internal company sales person. [Filter(multi eq)] |
| Sequence | The sequence that will be used to give new numbers to the documents of this type (Inherited from Document.) |
| ShipToCustomer | The customer to whom to ship the sales order. Usually it is a customer entry for a sub-party of the primary customer. [Filter(multi eq)] |
| ShipToPartyContactMechanism | The contact mechanism (address) to whih to ship the sales order. [Filter(multi eq)] |
| State | 0=New;5=Corrective;10=Computer Planned;20=Human Planned;30=Released;40=Completed;50=Closed [Required][Filter(eq;ge;le)] (Inherited from Document.) |
| StateChanges | List of DocumentStateChange child objects, based on the DocumentStateChange.Document back reference (Inherited from Document.) |
| Store | The store from which to issue the sales order. null means that there is no store associated with the sales order or there are different stores for some of the lines. [Filter(multi eq)] (Overrides LogisticsDocumentStore.) |
| SupportsDocumentAmounts |
Gets a value indicating whether the document supports document amounts.
(Overrides LogisticsDocumentSupportsDocumentAmounts.) |
| SupportsDocumentCurrency | (Overrides LogisticsDocumentSupportsDocumentCurrency.) |
| SupportsStore | (Overrides LogisticsDocumentSupportsStore.) |
| ToCompanyDivision | The division of the company, receiving the document. null when the document is not received by any specific division (Inherited from Document.) |
| ToDate | When selling a service valid only for a period, denotes the end of the period. null means that it is unknown or N/A. |
| ToParty | The party which should receive the document (Inherited from Document.) |
| Transaction |
The EnterpriseOne transaction to which this object is attached.
(Inherited from EnterpriseOneEntityObject.) |
| UserStatus | The user status of this document if applicable for this document type. null means unknown or not yet set (Inherited from Document.) |
| Versions | List of DocumentVersion child objects, based on the DocumentVersion.Document back reference (Inherited from Document.) |
| Void | True if the document is null and void [Required][Filter(eq)] (Inherited from Document.) |
| VoidReason | Reason for voiding the document, entered by the user (Inherited from Document.) |
| VoidTime | Date/time when the document has become void (Inherited from Document.) |
| VoidUser | The user who voided the document (Inherited from Document.) |
Methods| Name | Description | |
|---|---|---|
| CalculateVATDeviation |
Calculates the VAT deviation document amount according to the sales order options of the document type and distributes the document amounts.
|
| ChangeState |
Changes the document state to the specified new state
(Inherited from Document.) |
| Complete |
Changes the document state to Completed with all Release-ed sub-documents
(Inherited from Document.) |
| CopyValuesFromReturnForInvoice |
Copies the values from return for invoice.
|
| CopyValuesFromReturnForSalesOrder |
Copies the values from return sales order.
|
| CreateAdjustmentDocument |
Creates an adjustment document that doesn't adjust anything. Can be modified and saved.
(Inherited from Document.) |
| CreateLineLots |
Creates the line lots.
|
| CreateWorkOrders |
Creates a WorkOrder objects based on the SalesOrder.
|
| CreateZeroAmountPaymentOrder |
Creates the zero amount payment order used for advance payments. If such payment order already exists returns null.
|
| Delete | Deletes the domain object. (Overrides DocumentDelete.) |
| DetermineDefaultPosAttributes |
Determine default POS Operator, Terminal and Device for this Sales Order, without actually modifying it.
Note that this might differe from FillFiscalSalesNumber(User), because business rules
might change the object when assiging to properties
|
| DistributeDocumentAmounts |
Distributes the document amounts by the document lines.
(Inherited from LogisticsDocument.) |
| DuplicateObject |
Creates a copy of the object.
(Inherited from EntityObject.) |
| Equals(Object) |
Determines whether the specified Object, is equal to this instance.
(Inherited from EntityObject.) |
| Equals(EntityObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from EntityObject.) |
| ExecuteBusinessRules |
Executes all business rules for the object for the specified BusinessEvent.
The validation fails are saved in the event.
(Inherited from EditableDomainObject.) |
| FillFiscalSalesNumber(String) |
Sets the Fiscal Sales Number (FSN). The function checks for connected fiscal
printer and fills in the required POS attributes (if they have default values).
It is executed only if there is no value for FSN.
|
| FillFiscalSalesNumber(User) |
Sets the Fiscal Sales Number (FSN). The function checks for connected fiscal
printer and fills in the required POS attributes (if they have default values).
It is executed only if there is no value for FSN.
|
| GetAggregateParent |
Gets the aggregate parent of this entity object. If this is the aggregate root the return value is null.
(Inherited from EntityObject.) |
| GetAggregateRoot |
Gets the aggregate root entity object.
If the entity does not have aggregate parent reference aggregate root is this entity object.
(Inherited from EntityObject.) |
| GetAllParentDocuments |
Gets all parent documents, traversing the parent document chain by using the Parent property.
(Inherited from Document.) |
| GetAmountToPay |
Gets the total amount of the document that should be payed by the customer.
(Inherited from LogisticsDocument.) |
| GetAmountToPayForLines |
Gets the total amount of the document that is included in the lines.
(Inherited from LogisticsDocument.) |
| GetChangedAttributes |
Gets the changed attributes for a given DataAttributeChangeEventArgs.
Used for front-end generic business rules to recalculate the state of the object according to attribute change events.
(Inherited from LogisticsDocument.) |
| GetCoveredPaymentAmount |
Determine what amount has been covered by PaymentTransaction-s
by retrieving all relevang PaymentTransactionLine-s that are
for PaymentOrder releated to this document with
are at least minDocStateForPayments
not void. Finally, all lines' CoveredOrderAmount
are
|
| GetDefaultRequiredDeliveryDate |
Gets the default required delivery date.
|
| GetDistributedAmountsOverThisDocument |
Gets the distributed amounts where this document is referenced, including amounts created by this document and other documents. Caches the result.
(Inherited from LogisticsDocument.) |
| GetDocumentAmountsInfo |
Gets the calculated document amounts information.
(Inherited from LogisticsDocument.) |
| GetHashCode |
Returns a hash code for this instance.
(Inherited from EntityObject.) |
| GetPaymentStatus |
Determines the payment status of a document comparing the Amount to pay for the document and
the sum of the covered amounts in released payment transactions referring this document.
(Inherited from LogisticsDocument.) |
| GetPaymentsTransactionLines |
Retrieve payment transaction lines for all payments (not void and state >= minDocState) related to this sales order
|
| GetPrintout |
Gets a document printout as a file. The returned value is Base64 string representation of the file contents.
(Inherited from Document.) |
| GetRelatedObjectsForValidation |
Gets the related objects which would need validation upon validation of this object.
(Inherited from EntityObject.) |
| ImportDocumentAmounts | Imports the percent or unit amount document amounts from the specified source documents. (Inherited from LogisticsDocument.) |
| ImportDocumentTypeAmounts | Copies the document amounts from document type. First removes all existing document amounts. (Inherited from LogisticsDocument.) |
| IssueWarning(String) |
Issues a warning with the specified message.
(Inherited from EditableDomainObject.) |
| IssueWarning(ExpressionFuncString, Object) |
Issues a warning with the specified message. The message can contain standard string placeholders.
(Inherited from EditableDomainObject.) |
| MakeVoid |
Makes the document void. The operation is irreversible.
(Inherited from Document.) |
| MatchesFilter(DataAccessFilter) |
Returns true if this entity object matches the specified filter.
(Inherited from EnterpriseOneEntityObject.) |
| MatchesFilter(DataAccessFilter, IBufferRow) |
Matches the filter against the specified row and returns the result of the match.
(Inherited from EnterpriseOneEntityObject.) |
| RecalcBonusPrograms |
Applies the bonus programs to the sales order.
|
| RecalcPaymentPlanAmounts |
Recalcs the payment plan amounts.
|
| RecalcPromotionalPackages |
Recalcs the promotional packages.
|
| Recalculate |
The document and all of its owned objects will be altered to become valid.
(Inherited from Document.) |
| Refresh |
Refreshes this instance with data from data source.
Only objects with ObjectState equal to Unchanged are refreshed.
(Inherited from EntityObject.) |
| ToString |
Returns a String that represents this instance.
(Inherited from EntityObject.) |
| ToString(String) |
Returns a String that represents this instance.
(Inherited from EntityObject.) |
| TryGet |
Tries to get the specified attribute and returns it or null, when it is not found.
(Inherited from DomainObject.) |
Extension Methods| Name | Description | |
|---|---|---|
 | FillAggregateMissingDefaults |
Recalculates the default values for all objects in the aggregate.
(Defined by EntityObjectExtensions.) |
| FillMissingDefaults |
Executes the late default expression defined in each attribute (if any) if the current value is null or equal to a constant default.
(Defined by EntityObjectExtensions.) |
| FormatString |
Converts the object to string based on the format specified.
(Defined by FormatStringExtensions.) |
| GetExtensibleDataObject |
Gets the extensible data object related to the entity object.
Can return null if such ExtensibleDataObject doesn't exist.
(Defined by ExtensibleDataObjectExtensions.) |
| GetOrCreateExtensibleDataObject |
Returns an ExtensibleDataObject related to the entity object.
If such object doesn't exist the object is created in the same transaction.
(Defined by ExtensibleDataObjectExtensions.) |
| RecalculateMasterAttributes |
Recalculates the values of a master attributes in a master-detail relationship.
(Defined by EntityObjectExtensions.) |
| RecalculateMissingValues |
Recalculates the missing values using the first reactive expression of the attributes.
(Defined by EntityObjectExtensions.) |
See Also