DocumentAmountType Class

Represents the different types of additional amounts which are calculated for the documents. Entity: Gen_Document_Amount_Types

Inheritance Hierarchy

SystemObject
  Aloe.SystemFrameworks.DomainDomainObject
    Aloe.SystemFrameworks.DomainEditableDomainObject
      Aloe.SystemFrameworks.DomainEntityObject
        Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
          Aloe.EnterpriseOne.Model.GeneralDocumentAmountType

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

Syntax

C++

Copy

public class DocumentAmountType : EnterpriseOneEntityObject

Public Class DocumentAmountType
	Inherits EnterpriseOneEntityObject

public ref class DocumentAmountType : public EnterpriseOneEntityObject

type DocumentAmountType =  
    class
        inherit EnterpriseOneEntityObject
    end

The DocumentAmountType type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	AddToCustomer	True means that the amount will be charged to the primary customer of the document. [Required] [Default(true)]
	AddToLine	True means that the resulting amount will be added to the amount of each respective line. [Required] [Default(true)]
	AllowedDirections	Specifies condition for the sign of the allowed values for input percent or amount that can be set in the documents. [Default(0)]
	AmountInputAllowed	True when the user is allowed to input fixed amount for distribution. [Required] [Default(false)] [Filter(eq)]
	AmountTypeCode	A code that can be used to uniquely identify the additional amount. Can also be used for sorting purposes. [Required] [Filter(multi eq)] [ORD]
	AmountTypeName	The name of the amount type. [Required] [Filter(like)] [ORD]
	BaseOnLines	True means that the percentages will be applied over lines plus dependant amounts; false means only dependant amounts. [Required] [Default(true)]
	ChangingAttributes	Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow. (Inherited from EditableDomainObject.)
	CustomProperties	Gets the custom properties of the object. (Inherited from EnterpriseOneEntityObject.)
	DefaultPercent	Default percent for amounts for which percent input is allowed; null otherwise.
	Dependencies	List of DocumentAmountTypeDependency child objects, based on the General.DocumentAmountTypeDependency.DocumentAmountType back reference
	Description	The description of this DocumentAmountType.
	DistributeBy	Specifies how the amount will be distributed among the document lines. Valid values are: ('AMOUNT','MEASUREMENT','PRODUCT DEFINITION'). [Required] [Default("AMOUNT")] [Filter(eq)]
	DistributeByMeasurementCategory	Specifies the measurement category to be used for distribution, when the Distribute_By = 'MEASUREMENT'. [Filter(multi eq)]
	ExtendedProperties	Extended properties contain temporary (not persisted) values in the object instance. (Inherited from EntityObject.)
	Id	The unique Id of the entity object (Inherited from EntityObject.)
	IsActive	True when the amount type is active for new records; false - otherwise. [Required] [Default(true)] [Filter(eq)]
	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 EntityObjectIsLoaded.)
	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.)
	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.)
	ObjectState	Gets the state of the domain object. (Overrides EditableDomainObjectObjectState.)
	PercentInputAllowed	True when the user is allowed to input percent of total for distribution. [Required] [Default(true)] [Filter(eq)]
	Repository	Provides access to DocumentAmountTypesRepository repository methods
	RoundScale	The amounts should be rounded with the specified number of digits after the decimal point. null means to use the currency default.
	Settings	List of DocumentAmountTypeSetting child objects, based on the Finance.Intrastat.DocumentAmountTypeSetting.DocumentAmountType back reference
	Transaction	The EnterpriseOne transaction to which this object is attached. (Inherited from EnterpriseOneEntityObject.)
	UnitAmountInputAllowed	Specifies whether the user is allowed to input fixed unit amount for the calculation of the amount. [Required] [Default(false)] [Filter(eq)]

Top

Methods

	Name	Description
	Delete	Deletes the domain object. (Overrides EntityObjectDelete.)
	DependsOn	Returns a value indicating whether the current DocumentAmountType depends on the specified parameter.
	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.)
	GetHashCode	Returns a hash code for this instance. (Inherited from EntityObject.)
	GetRelatedObjectsForValidation	Gets the related objects which would need validation upon validation of this object. (Inherited from EntityObject.)
	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.)
	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.)
	Refresh	Refreshes this instance with data from data source. Only objects with ObjectState equal to Unchanged are refreshed. (Inherited from EntityObject.)
	RoundAmount	Rounds the amount according to RoundScale. If RoundScale is null, the default round scale (2) is used.
	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.General Namespace