MGCLatticeGeneralJournalLineContract

Data contract representing a general journal line: its account and offset account, debit/credit amounts, currency, description, and the invoice, payment and bank details of a customer, vendor or bank line.

Methods

new

Initializes a new instance of the MGCLatticeGeneralJournalLineContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeGeneralJournalLineContract class.

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

No parameters.

parmMainAccountId

Gets or sets the main ledger account identifier. Not together with AccountType / AccountNum.

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

Name	Type	Optional	Description
_mainAccountId	str	Yes	The MainAccountId value.

parmOffsetMainAccountId

Gets or sets the offset main ledger account identifier. Not together with OffsetAccountType / OffsetAccountNum.

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

Name	Type	Optional	Description
_offsetMainAccountId	str	Yes	The OffsetMainAccountId 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. Required on a line whose account is a main account; on a customer, vendor or bank line it defaults to the account's currency.

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

Name	Type	Optional	Description
_currencyCode	CurrencyCode	Yes	The CurrencyCode 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.

parmDimensions

Gets or sets the financial dimension values of the line's account: merged into the main account of a ledger line, and into the default dimensions of a customer, vendor or bank line.

• Visibility: public
• Returns: List The financial dimension values list.

Name	Type	Optional	Description
_dimensions	List	Yes	The financial dimension values list.

parmOffsetCompany

Gets or sets the legal entity of the offset account (postIntercompanyJournal only).

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

Name	Type	Optional	Description
_offsetCompany	str	Yes	The OffsetCompany value.

parmAccountType

Gets or sets the type of the line's account, sent as an integer: 0 = Ledger (default), 1 = Customer, 2 = Vendor, 6 = Bank. Used with AccountNum; not together with MainAccountId.

• Visibility: public
• Returns: int The AccountType value.

Name	Type	Optional	Description
_accountType	int	Yes	The AccountType value.

parmAccountNum

Gets or sets the line's account of the type AccountType names: a main account, customer account, vendor account or bank account id.

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

Name	Type	Optional	Description
_accountNum	str	Yes	The AccountNum value.

parmAccountNumExternalKey

Gets or sets the external system's key of the line's customer or vendor account, in place of AccountNum. Uses the request's ExternalSystem; customer and vendor accounts only.

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

Name	Type	Optional	Description
_accountNumExternalKey	MGCLatticeExternalKey	Yes	The AccountNumExternalKey value.

parmOffsetAccountType

Gets or sets the type of the line's offset account, sent as an integer: 0 = Ledger (default), 1 = Customer, 2 = Vendor, 6 = Bank. Used with OffsetAccountNum; not together with OffsetMainAccountId.

• Visibility: public
• Returns: int The OffsetAccountType value.

Name	Type	Optional	Description
_offsetAccountType	int	Yes	The OffsetAccountType value.

parmOffsetAccountNum

Gets or sets the line's offset account of the type OffsetAccountType names. Optional: a line without an offset account balances against the other lines of its voucher.

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

Name	Type	Optional	Description
_offsetAccountNum	str	Yes	The OffsetAccountNum value.

parmOffsetAccountNumExternalKey

Gets or sets the external system's key of the line's customer or vendor offset account, in place of OffsetAccountNum. Uses the request's ExternalSystem; customer and vendor accounts only.

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

Name	Type	Optional	Description
_offsetAccountNumExternalKey	MGCLatticeExternalKey	Yes	The OffsetAccountNumExternalKey value.

parmInvoiceId

Gets or sets the line's invoice number (the journal line's Invoice). On a customer or vendor line it is the number of the invoice the line posts; the due date is calculated from the payment terms only when it is sent.

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

Name	Type	Optional	Description
_invoiceId	InvoiceId	Yes	The InvoiceId value.

parmDocumentNumber

Gets or sets the line's document number.

• Visibility: public
• Returns: DocumentNum The DocumentNumber value.

Name	Type	Optional	Description
_documentNumber	DocumentNum	Yes	The DocumentNumber value.

parmDocumentDate

Gets or sets the line's document date. On a vendor invoice line the due date is calculated from it.

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

Name	Type	Optional	Description
_documentDate	DocumentDate	Yes	The DocumentDate value.

parmDueDate

Gets or sets the due date of a customer or vendor line. Optional: it is calculated from the payment terms.

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

Name	Type	Optional	Description
_dueDate	DueDate	Yes	The DueDate value.

parmPaymentTermsId

Gets or sets the terms of payment of a customer or vendor line. Optional: the account's terms of payment.

• Visibility: public
• Returns: PaymTermId The PaymentTermsId value.

Name	Type	Optional	Description
_paymentTermsId	PaymTermId	Yes	The PaymentTermsId value.

parmPostingProfile

Gets or sets the posting profile of a customer or vendor line. Optional: the accounts receivable or accounts payable parameters' posting profile.

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

Name	Type	Optional	Description
_postingProfile	PostingProfile	Yes	The PostingProfile value.

parmSalesTaxGroup

Gets or sets the line's sales tax group. Optional: the customer's or vendor's sales tax group, or the main account's.

• Visibility: public
• Returns: TaxGroup The SalesTaxGroup value.

Name	Type	Optional	Description
_salesTaxGroup	TaxGroup	Yes	The SalesTaxGroup value.

parmItemSalesTaxGroup

Gets or sets the line's item sales tax group. Optional: the ledger account's item sales tax group (on a customer or vendor line only when the line has an invoice number).

• Visibility: public
• Returns: TaxItemGroup The ItemSalesTaxGroup value.

Name	Type	Optional	Description
_itemSalesTaxGroup	TaxItemGroup	Yes	The ItemSalesTaxGroup value.

parmMethodOfPayment

Gets or sets the method of payment of a customer or vendor line. Optional: the account's method of payment.

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

Name	Type	Optional	Description
_methodOfPayment	str	Yes	The MethodOfPayment value.

parmPaymentReference

Gets or sets the line's payment reference.

• Visibility: public
• Returns: PaymReference The PaymentReference value.

Name	Type	Optional	Description
_paymentReference	PaymReference	Yes	The PaymentReference value.

parmBankTransactionType

Gets or sets the bank transaction type of a line with a bank account (either side).

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

Name	Type	Optional	Description
_bankTransactionType	BankTransactionType	Yes	The BankTransactionType value.