PaymentTransaction Class |
Represents actual payments, which increase or decrease the balance of a payment account. Entity: Cash_Payment_Transactions
Inheritance HierarchySystemObject
Aloe.SystemFrameworks.DomainDomainObject
Aloe.SystemFrameworks.DomainEditableDomainObject
Aloe.SystemFrameworks.DomainEntityObject
Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
Aloe.EnterpriseOne.Model.GeneralDocument
Aloe.EnterpriseOne.Model.Finance.PaymentsPaymentTransaction
Aloe.SystemFrameworks.DomainDomainObject
Aloe.SystemFrameworks.DomainEditableDomainObject
Aloe.SystemFrameworks.DomainEntityObject
Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
Aloe.EnterpriseOne.Model.GeneralDocument
Aloe.EnterpriseOne.Model.Finance.PaymentsPaymentTransaction
Namespace: Aloe.EnterpriseOne.Model.Finance.Payments
Assembly: Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5
SyntaxThe PaymentTransaction type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PaymentTransaction | Initializes a new instance of the PaymentTransaction 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.) |
| 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.) |
| CustomProperties |
Gets the custom properties of the object.
(Inherited from EnterpriseOneEntityObject.) |
| Direction | I for Payment issue, R for payment receipt. [Required] [Default("R")] [Filter(eq)] |
| DistributedAmounts | List of DocumentDistributedAmount child objects, based on the DocumentDistributedAmount.Document back reference (Inherited from Document.) |
| 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.) |
| FiscalPrinterPosDevice | For POS Sales Order payments. Specifies the POS Device from fiscal printer type on which the receipt is printed. Null when the payment transaction is not created for a POS Sale Order. [Filter(multi eq)] |
| 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 PaymentTransactionLine child objects, based on the Finance.Payments.PaymentTransactionLine.PaymentTransaction back reference |
| 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 PaymentTransaction. |
| ObjectState | Gets the state of the domain object. (Overrides DocumentObjectState.) |
| OriginalPaymentTransaction | Original Payment Transaction. [Filter(multi eq)] |
| 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.) |
| ParentPaymentSlipAmount | The Payment Slip Amount, which the current payment transaction fulfills . null when the current document does not execute any Payment Slip Amount. [Filter(multi eq)] |
| Party | The party that is paying or receiving the money. [Required] [Filter(multi eq)] |
| PaymentAccount | The account towards which the payment was effected. [Filter(multi eq)] |
| PaymentReason | The payment reason, as defined in Payment Reasons. [Filter(multi eq)] |
| PaymentSlip | When not null specifies that this payment was part of a payment slip. [Filter(multi eq)] |
| PaymentSlipNo | The number of the payment slip. Can be used to directly indicate the number without referring to Payment_Slips. [Filter(eq)] |
| PaymentType | Specifies the payment type used to pay, when using this payment account. null when the payment type is unknown or unspecified. [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 Order payments. Specifies the POS Location, in which the payment is performed. Null when the payment transaction is not created for a POS Sale Order. [Filter(multi eq)] |
| PosOperator | For POS Sales Order payments. Specifies the POS Operator, who created the payment order. Null when the payment transaction is not created for a POS Sale Order. [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.) |
| 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 PaymentTransactionsRepository repository methods |
| RequiresAllocation | True=The total amount should be allocated to payment orders; false=Payment orders are not required. [Required] [Default(true)] [Filter(eq)] |
| ResponsiblePerson | The person that is responsible for this order or transaction. It could be the sales person, the orderer, etc. (Inherited from Document.) |
| ReversalReason | The reason for the reversal of the payment. |
| ReverseOfDocument | The document which the current document is reverse of (Inherited from Document.) |
| 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.) |
| 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.) |
| TotalAmount | The total amount payed. The distribution of the amount among source orders is specified with payment transacion lines. [Currency: TotalAmountCurrency] [Required] [Default(0)] |
| TotalAmountCurrency | The currency of the total amount. [Required] [Filter(multi eq)] |
| 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 | |
|---|---|---|
| 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.) |
| CreateDepositOrder |
Creates a new deposit order and adds a zero payment line for it.
|
| Delete | Deletes the domain object. (Overrides DocumentDelete.) |
| 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.) |
| GetHashCode |
Returns a hash code for this instance.
(Inherited from EntityObject.) |
| 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.) |
| 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.) |
| SetPosOperator |
Set the POS operator by using PosLocation and currently logged-in user
|
| SetPosOperatorForCurrentUser |
Set the POS operator by using PosLocation and currently logged-in user
|
| 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