MGCLatticePaymentJournalLineContract

Data contract representing a payment journal line with account number, debit/credit amounts, currency, method of payment, bank account, the invoice a customer payment pays, and the prepayment flag with the order the payment is marked against.

Methods

new

Initializes a new instance of the MGCLatticePaymentJournalLineContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticePaymentJournalLineContract class.

• Visibility: public
• Returns: MGCLatticePaymentJournalLineContract A new MGCLatticePaymentJournalLineContract instance.

No parameters.

parmInvoiceId

Gets or sets the invoice this customer payment pays (LedgerJournalTrans.Invoice). Optional; CUSTOMER payments only: settleCustomerTransactions can then locate the receipt by this number (PaymentInvoiceId). A vendor payment line refuses it - on a vendor line the field is the line's own invoice number and F&O's duplicate-invoice check rejects a posted one; identify a vendor payment by its voucher instead.

• Visibility: public
• Returns: InvoiceId The invoice number the payment applies to.

Name	Type	Optional	Description
_invoiceId	InvoiceId	Yes	The invoice number the payment applies to.

parmAccountNum

Gets or sets the customer or vendor account number.

• Visibility: public
• Returns: str The AccountNum value.

Name	Type	Optional	Description
_accountNum	str	Yes	The AccountNum value.

parmAmountCurDebit

Gets or sets the debit amount in the transaction currency.

• Visibility: public
• Returns: real The AmountCurDebit value.

Name	Type	Optional	Description
_amountCurDebit	real	Yes	The AmountCurDebit value.

parmAmountCurCredit

Gets or sets the credit amount in the transaction currency.

• Visibility: public
• Returns: real The AmountCurCredit value.

Name	Type	Optional	Description
_amountCurCredit	real	Yes	The AmountCurCredit value.

parmCurrencyCode

Gets or sets the currency code for the transaction.

• Visibility: public
• Returns: CurrencyCode The CurrencyCode value.

Name	Type	Optional	Description
_currencyCode	CurrencyCode	Yes	The CurrencyCode value.

parmBankAccountId

Gets or sets the bank account the payment is made from or received into: the line's offset account, of type Bank. Optional; when empty the journal name's offset account applies.

• Visibility: public
• Returns: CompanyBankAccountId The BankAccountId value.

Name	Type	Optional	Description
_bankAccountId	CompanyBankAccountId	Yes	The BankAccountId value.

parmMethodOfPayment

Gets or sets the method of payment code.

• Visibility: public
• Returns: str The MethodOfPayment value.

Name	Type	Optional	Description
_methodOfPayment	str	Yes	The MethodOfPayment value.

parmDescription

Gets or sets the descriptive text for the journal or transaction.

• Visibility: public
• Returns: str The Description value.

Name	Type	Optional	Description
_description	str	Yes	The Description value.

parmTransDate

Gets or sets the transaction date for the journal line.

• Visibility: public
• Returns: TransDate The TransDate value.

Name	Type	Optional	Description
_transDate	TransDate	Yes	The TransDate value.

parmAccountNumExternalKey

Gets or sets the external system's key of the customer (customer payments) or vendor (vendor payments), in place of AccountNum. Uses the request's ExternalSystem.

• Visibility: public
• Returns: MGCLatticeExternalKey The AccountNumExternalKey value.

Name	Type	Optional	Description
_accountNumExternalKey	MGCLatticeExternalKey	Yes	The AccountNumExternalKey value.

parmIsPrepayment

Gets or sets whether the line is a prepayment (the payment journal's Prepayment journal voucher option). A prepayment posts with the prepayment posting profile of the accounts receivable or accounts payable parameters. Optional; false by default.

• Visibility: public
• Returns: boolean The IsPrepayment value.

Name	Type	Optional	Description
_isPrepayment	boolean	Yes	The IsPrepayment value.

parmSalesOrderId

Gets or sets the sales order this customer payment is marked against for settlement (the sales order's Settle transactions): when the order is invoiced, the invoice is settled with the payment. Optional; customer payments only. The order's invoice account must be the line's customer.

• Visibility: public
• Returns: SalesId The SalesOrderId value.

Name	Type	Optional	Description
_salesOrderId	SalesId	Yes	The SalesOrderId value.

parmSalesOrderIdExternalKey

Gets or sets the external system's key of the sales order, in place of SalesOrderId. Uses the request's ExternalSystem.

• Visibility: public
• Returns: MGCLatticeExternalKey The SalesOrderIdExternalKey value.

Name	Type	Optional	Description
_salesOrderIdExternalKey	MGCLatticeExternalKey	Yes	The SalesOrderIdExternalKey value.

parmPurchaseOrderId

Gets or sets the purchase order this vendor payment is marked against for settlement (the purchase order's Settle transactions): when the order is invoiced, the invoice is settled with the payment. Optional; vendor payments only. The order's invoice account must be the line's vendor.

• Visibility: public
• Returns: PurchId The PurchaseOrderId value.

Name	Type	Optional	Description
_purchaseOrderId	PurchId	Yes	The PurchaseOrderId value.

parmPurchaseOrderIdExternalKey

Gets or sets the external system's key of the purchase order, in place of PurchaseOrderId. Uses the request's ExternalSystem.

• Visibility: public
• Returns: MGCLatticeExternalKey The PurchaseOrderIdExternalKey value.

Name	Type	Optional	Description
_purchaseOrderIdExternalKey	MGCLatticeExternalKey	Yes	The PurchaseOrderIdExternalKey value.