InvoiceOrder Class

Invoice Orders can be created by different modules and order the creation of Invoices. Entity: Crm_Invoice_Orders

Inheritance Hierarchy

SystemObject
  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.InvoicingInvoiceOrder

Namespace: Aloe.EnterpriseOne.Model.Crm.Invoicing
Assembly: Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5

Syntax

C++

Copy

public class InvoiceOrder : LogisticsDocument

Public Class InvoiceOrder
	Inherits LogisticsDocument

public ref class InvoiceOrder : public LogisticsDocument

type InvoiceOrder =  
    class
        inherit LogisticsDocument
    end

The InvoiceOrder type exposes the following members.

Constructors

	Name	Description
	InvoiceOrder	Initializes a new instance of the InvoiceOrder class with specific ObjectTransaction

Top

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.)
	ApplyDate	Apply date to be passed to the invoice. When not null specifies that the VAT entry should be applied for a different period than that specified by the document date.
	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.)
	CreditNoteDescription	Descriptions/reason for the credit note.
	CreditNoteOriginalInvoice	When the order is for credit note, may contain the original Invoice. null for normal orders or when the original document is unknown. [Filter(multi eq)]
	CreditNoteOriginalInvoiceOrder	When the invoice is a credit note, can specify the original Invoice Order, on which this is based. null for normal invoice orders or when the original document is unknown. [Filter(multi 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 to whom to invoice. [Required] [Filter(multi eq)]
	CustomProperties	Gets the custom properties of the object. (Inherited from EnterpriseOneEntityObject.)
	DealType	VAT deal type for this invoice order. This deal type is copied to the invoice to create VAT entries. [Filter(multi eq)]
	DeliveryDate	Date, when the delivery was effected. When null = document date.
	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.)
	DocumentAmounts	List of DocumentAmount child objects, based on the DocumentAmount.Document back reference (Inherited from LogisticsDocument.)
	DocumentCurrency	The currency in which the document is issued. All amounts are in this currency. [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.)
	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.)
	FromCompanyDivision	The division of the company, issuing the document. null when the document is not issued by any specific division (Inherited from Document.)
	FromParty	The party which issued the document [Required] (Inherited from Document.)
	Id	The unique Id of the entity object (Inherited from EntityObject.)
	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]
	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 InvoiceOrderLine child objects, based on the Crm.Invoicing.InvoiceOrderLine.InvoiceOrder 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 InvoiceOrder.
	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, specifies the default payment account for the payment order. [Filter(multi eq)]
	PaymentDueDate	When not null specifies due date for the payment.
	PaymentDueStartDate	The date when the payment becomes due for documents with one installment.
	PaymentType	When not null specifies the payment type for the invoice. [Filter(multi eq)]
	PaymentTypeDescription	Description of the payment type. Initially copied from the name of the Payment Type. [Required]
	PlanningOnly	Indicates that the document is used only for planning (and as consequence its state cannot be greater than Planned) [Required] (Inherited from Document.)
	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.)
	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 InvoiceOrdersRepository repository methods
	ResponsiblePerson	The person that is responsible for this order or transaction. It could be the sales person, the orderer, etc. (Inherited from Document.)
	ReverseOfDocument	The document which the current document is reverse of (Inherited from Document.)
	SalesOrder	Default value and filter for the lines. Used to differenciate the invoice order for each sales order. [Filter(multi eq)]
	Sequence	The sequence that will be used to give new numbers to the documents of this type (Inherited from Document.)
	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	Gets or sets the store of the logistics document. Some logistics documents do not support store. (Inherited from LogisticsDocument.)
	SupportsDocumentAmounts	Gets a value indicating whether the document supports document amounts. (Overrides LogisticsDocumentSupportsDocumentAmounts.)
	SupportsDocumentCurrency	(Overrides LogisticsDocumentSupportsDocumentCurrency.)
	SupportsStore	Gets a value indicating whether the document supports store. (Inherited from LogisticsDocument.)
	ToCompanyDivision	The division of the company, receiving the document. null when the document is not received by any specific division (Inherited from Document.)
	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.)

Top

Methods

	Name	Description
	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.)
	CreateAdjustmentDocument	Creates an adjustment document that doesn't adjust anything. Can be modified and saved. (Inherited from Document.)
	Delete	Deletes the domain object. (Overrides DocumentDelete.)
	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.)
	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.)
	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.)
	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.)
	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.)

Top

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.)

Top

Reference

Aloe.EnterpriseOne.Model.Crm.Invoicing Namespace