Setup Electronic Format Payment (EFT) in AX 2009

A few days ago I created a new post on how to create a new Electroni Payment Format (EFT) in X++. The post can be seen here: http://axwonders.blogspot.com/2011/08/create-electronic-payment-format-ax.html


In this post I will show how to setup the EFT based on the class I created before in AX 2009.


1 - Open Accounts Payable | Setup | Payment | Methods of Payments and create a new record as follows:


NOTE: I will be using a Payment Method called EFT Mexico for this example, but you can name this anything in the Interface method in the class you will create to customize an Electronic Payment.

In the link above look at the class named KUMVendOutPaym_SA and look for a method named PaymInterfaceName. You will see the following code:

public PaymInterfaceName interfaceName()

{

    ;

    return 'EFT Mexico';

}

Create Electronic Payment Format - AX 2009

Electronic payments are being used heavily today. It is importnat to understand how these work and how to implement them as they save lots of time and even more paperwork. In addition, AX 2009 provides some out-of-the-box payment templates, but they are not very felxible and very often we need to create our own.

Now the good thing about creating our own is that we can inherit from two base classes. (1) VendOutPaym and (2) VendOutPaymRecord.

VendOutPaym is ussually used to create the header and closing records of a payment file. On the other hand, VendOutPaymRecord is used to create the the lines records of the payment file. So, if we have a payment journal (AP > Journals > Payments> Payment Journal) with 10 lines, we should see only one header line, (in my case) only one Bank line (after header), 10 line records (Payment journal lines) and one closing line with totals, got the idea?

So, we would have to create two classes. One to write the header and closing records and one to write the journal lines, ok?

Here is the first class to write header and closing records. Because in my file the empey spaces needed to be filled with only 0's, I created a method that's called getProcessedStr that takes a string and an integer. The string is the actual value that will be written into the file but needs extra 0's. The int is the total lenght of this record in the text file.

Mark Customer Invoices for settlement with AX 2009 - Mark Invoices

After creating a payment journal (http://axwonders.blogspot.com/2011/06/create-axapta-payment-journal.html ), you might want to mark the invoices for settlement. This task is done by looping through the just created Payment Journal and then by querying the CustTransOpen Table and instantiating the CustTrans table from the CustTransOpen.CustTrans() method.


The following is the code to mark invoices. Also, the code loops through each payment journal transaction.

Also, the logic behind it is that the SpecTrans table needs to have two records in order to offset an open invoice with a transaction. So the code below inserts two records to the SpecTrans table. One is for all the open transactions (invoices - Sales) and the other is for all the payment transactions (paymet - Payment)

For example:

select firstonly invCustTrans where invCustTrans.AccountNum == custTable.AccountNum
            && invCustTrans.TransType == LedgerTransType::Sales
            && !invCustTrans.LastSettleDate;

the code above will select all the customer transactions with a TransType of Sales.

On the other hand, the code below will select all the customer transaction with a TransType of Payment.

select firstonly payCustTrans where payCustTrans.AccountNum == custTable.AccountNum
            && payCustTrans.TransType == LedgerTransType::Payment
            && !payCustTrans.LastSettleDate;

Then we need to insert the two instances of CustTrans into the SpecTrans table:

specOffsetVoucher.insert(invCustTrans.dataAreaId, invCustTrans.TableId, invCustTrans.RecId, invCustTrans.AmountCur, invCustTrans.CurrencyCode, NoYes::No);

specOffsetVoucher.insert(payCustTrans.dataAreaId, payCustTrans.TableId, payCustTrans.RecId, payCustTrans.AmountCur, payCustTrans.CurrencyCode, true);
The following is the whole code:

Create Axapta Payment Journal

The following code creates a payment journal in AX.

public void PaymentJournalLineCreation()

{

    boolean                     ret;

    CustTable                   custTable;

    LedgerJournalName           LedgerJournalName;

    LedgerJournalTable          ledgerJournalTable;

    LedgerJournalTrans          ledgerJournalTrans;

    LedgerJournalCheckPost      ledgerJournalCheckPost;

    NumberSeq numberseq;

    ;

    //Get customer account

    this.getCustomerAccount();

    //Get currency

    this.setCurrency();

    //Set JournalNameId

    this.setJournalNameId(LedgerJournalACType::Bank);

    //Get table buffer

    custTable = CustTable::find(customerAccount, false);

    // Find a ledgerJournalName record

    select firstonly LedgerJournalName

    where LedgerJournalName.JournalName == journalNameId;

    //Get next available voucher number

    numberseq = NumberSeq::newGetVoucherFromCode(LedgerJournalName.VoucherSeries);

    ledgerJournalTrans.Voucher = numberseq.voucher();

    //Generate the transaction line

    ledgerJournalTrans.JournalNum = ledgerJournalId;

    ledgerJournalTrans.CurrencyCode = currencyCode;

    ledgerJournalTrans.ExchRate = Currency::exchRate(ledgerJournalTrans.CurrencyCode);

    ledgerJournalTrans.AccountNum = customerAccount;

    ledgerJournalTrans.accountName();

    ledgerJournalTrans.AccountType = LedgerJournalACType::Cust;

    ledgerJournalTrans.Dimension[1] = custTable.Dimension[1];

    LedgerJournalTrans.KUMTeamDescription();

    ledgerJournalTrans.Dimension[2] = custTable.Dimension[2];

    ledgerJournalTrans.KUMDetailDescription();

    ledgerJournalTrans.Dimension[3] = custTable.Dimension[3];

    ledgerJournalTrans.KUMEventDescription();

    ledgerJournalTrans.AmountCurCredit = paymentAmount;

    ledgerJournalTrans.TransDate = PaymentDate;

    ledgerJournalTrans.Txt = '@COL1576'; //Payment, Thank you

    ledgerJournalTrans.PaymMode = custTable.PaymMode;

    ledgerJournalTrans.PostingProfile = 'DFLT';

    ledgerJournalTrans.BankTransType = 'Chck-rcpt';

    ledgerJournalTrans.Payment = custTable.PaymTermId;

    ledgerJournalTrans.CustVendBankAccountId = this.GetCustomerBankAccountID(customerAccount);

    ledgerJournalTrans.SettleVoucher = SettlementType::OpenTransact;

    ledgerJournalTrans.TransactionType = LedgerTransType::Payment;

    ledgerJournalTrans.Approved = NoYes::Yes;

    ledgerJournalTrans.ApprovedBy = curUserId();

    ledgerJournalTrans.Due = systemdateget();

    ledgerJournalTrans.TaxGroup = 'DFLT';

    ledgerJournalTrans.OffsetAccount = bankAccount;

    ledgerJournalTrans.OffsetAccountType = LedgerJournalACType::Bank;

    ledgerJournalTrans.offsetAccountName();

    ledgerJournalTrans.PaymentStatus = CustVendPaymStatus::None;

    ledgerJournalTrans.insert();

}

There are some methods calls in the previous code. These are the following:

//Find customer account based on Customer Reference Number

public CustAccount getCustomerAccount()

{

    CustAccount     custAccount;

    CustBankAccount custBankAccount;

    int             countRecords = 0;

    ;

    switch (JournalFormatType)

    {

        case KMN_CustPaymentJournalFormatType::Mexico:

            select * from custBankAccount where custBankAccount.MsgToBank == customerReference;

            custAccount = custBankAccount.CustAccount;

            this.parmCustAccount(custAccount);

            break;

    }

    return custAccount;

}

//Sets the currency value to the property

public void setCurrency()

{

    ;

    //Set property

    this.parmCurrencyCode(CompanyInfo::standardCurrency());

}

public void setJournalNameId(LedgerJournalACType _journalType)

{

    LedgerJournalNameId _journalNameId;

    ;

    switch(_journalType)

    {

        case LedgerJournalACType::Bank:

            _journalNameId = 'CR';

            break;

    }

    this.parmLedgerJournalNameId(_journalNameId);

}

NOTE: I'm using accessory methods for most of the variables in this code (this is a class), so remember to declare them in the classDeclaration and create your own properties.