AP Payment

From AutoCount Resource Center
Jump to navigation Jump to search

Technical Specification

  1. Payment Knockoff Date must be equal or greater than the Payment Date.
  2. Payment net total must be greater than 0.
  3. Payment net total must be the sum of Payment Amount in Payment Detail
  4. Total of knockoff Amount must not exceed the sum of Payment Amount.
  5. Payment Method is created in General Maintenance | Payment Method Maintenance.

References of AutoCount Accounting version 1.8, 1.9

BCE.AutoCount.dll
BCE.AutoCount.CommonAccounting.dll
BCE.AutoCount.MainEntry.dll
BCE.Utils.dll
BCE.Utils.UI.dll
BCE.AutoCount.ARAP.dll

AP Payment API Usage

New

public void NewAPPayment(BCE.Data.DBSetting dbSetting)
{
    BCE.AutoCount.ARAP.APPayment.APPaymentDataAccess cmd = BCE.AutoCount.ARAP.APPayment.APPaymentDataAccess.Create(dbSetting);
    BCE.AutoCount.ARAP.APPayment.APPaymentEntity doc = cmd.NewAPPayment();

    //If you want to set your own Payment Voucher number, uncomment doc.DocNo to assign document no.
    //System auto assign running number, when DocNo is not defined.
    //doc.DocNo = “PV-0001″;
    doc.CreditorCode = "300-A001";

    // Add one payment detail
    BCE.AutoCount.ARAP.APPayment.APPaymentDTLEntity paymentDetail = doc.NewDetail();
    paymentDetail.PaymentMethod = "CASH";
    paymentDetail.PaymentAmt = 100;
    paymentDetail.ChequeNo = "MBB 123456";

    //Knockoff Invoice
    doc.KnockOff(BCE.AutoCount.Document.DocumentType.APInvoice, "IV-0001", 100);

    try
    {
        cmd.SaveAPPayment(doc, BCE.AutoCount.Authentication.UserAuthentication.GetOrCreate(dbSetting).LoginUserID);
        BCE.Application.AppMessage.ShowMessage($"Success: {doc.DocNo}");
    }
    catch (BCE.Application.AppException ex)
    {
        BCE.Application.AppMessage.ShowMessage(ex.Message);
    }
}

Edit

public void EditAPPayment(BCE.Data.DBSetting dbSetting)
{
	BCE.AutoCount.ARAP.APPayment.APPaymentDataAccess cmd = BCE.AutoCount.ARAP.APPayment.APPaymentDataAccess.Create(dbSetting);
	BCE.AutoCount.ARAP.APPayment.APPaymentEntity doc = cmd.GetAPPayment("PV-0001");

	//If doc (APPayment) is null, doc (APPayment) does not exist in AP Payment;
	//Then exit this function
	if (doc == null)
		return;

	//Detail is the Payment with Payment Method & Amount
	doc.ClearDetails();

	BCE.AutoCount.ARAP.APPayment.APPaymentDTLEntity paymentDetail = doc.NewDetail();
	paymentDetail.PaymentMethod = "CARD";
	paymentDetail.PaymentAmt = 600;

	try
	{
		cmd.SaveAPPayment(doc, BCE.AutoCount.Authentication.UserAuthentication.GetOrCreate(dbSetting).LoginUserID);
		BCE.Application.AppMessage.ShowMessage($"{doc.DocNo} is updated successfully.");
	}
	catch (BCE.Application.AppException ex)
	{
		BCE.Application.AppMessage.ShowMessage($"Failed to update {doc.DocNo}.");
	}
}

Cancel (Void)

private void CancelAPPayment(BCE.Data.DBSetting dbSetting)
{
    BCE.AutoCount.ARAP.APPayment.APPaymentDataAccess cmd = BCE.AutoCount.ARAP.APPayment.APPaymentDataAccess.Create(dbSetting);

    try
    {
        cmd.CancelAPPayment("PV-0001", BCE.AutoCount.Authentication.UserAuthentication.GetOrCreate(dbSetting).LoginUserID);
        BCE.Application.AppMessage.ShowMessage("Payment is Cancelled.");
    }
	catch (BCE.Application.AppException ex)
    {
        BCE.Application.AppMessage.ShowMessage("Failed to Cancel Payment.");
    }
}

Delete

private void DeleteAPPayment(BCE.Data.DBSetting dbSetting)
{
    BCE.AutoCount.ARAP.APPayment.APPaymentDataAccess cmd = BCE.AutoCount.ARAP.APPayment.APPaymentDataAccess.Create(dbSetting);

    try
    {
        cmd.DeleteAPPayment("PV-0001", BCE.AutoCount.Authentication.UserAuthentication.GetOrCreate(dbSetting).LoginUserID);
        BCE.Application.AppMessage.ShowMessage("Pay is deleted.");
    }
    catch (BCE.Application.AppException ex)
    {
        BCE.Application.AppMessage.ShowMessage("Failed to Delete Payment.");
    }
}



Sample Code with Data Model

This sample code provides the example of creating new AP Payment with tested data.

Source Data (Example for reference Only)

Source Data is implemented to hold data that is to be updated into AutoCount Accounting.
The Source Data designed here is for reference only.
You may either create your own data model, or read from your database and assign value to transaction/document of AutoCount Accounting.
public class APPaymentSource
{
	public string CreditorCode { get; set; }
	public string DocumentNo { get; set; }
	public string ReceiptNo2 { get; set; }
	public DateTime DocumentDate { get; set; } = DateTime.Today.Date;
	public string Description { get; set; }
	public string DepositMethod { get; set; }

	//PaymentCurrencyCode will be the currency code of Creditor's Account.
	//Need to define only when PaymentCurrencyCode is different from Creditor's Account Currency
	public string PaymentCurrencyCode { get; set; }

	//Require PaymentToHomeCurrencyRate,
	//when PaymentCurrencyCode is in Foreign Currency 
	public decimal? PaymentToHomeCurrencyRate { get; set; }

	//Require PaymentToCreditorCurrencyRate,
	//when PaymentCurrencyCode is different from Creditor CurrencyCode
	public decimal? PaymentToCreditorCurrencyRate { get; set; }

	public string Project { get; set; }
	public string Department { get; set; }

	public List<APPaymentDetailSource> PaymentDetail = new List<APPaymentDetailSource>();
	public List<PaymentKnockoffSource> PaymentKnockoff = new List<PaymentKnockoffSource>();
}

public class APPaymentDetailSource
{
	public string PaymentMethod { get; set; }
	public string ChequeNo { get; set; }
	public decimal PaymentAmount { get; set; }
	public decimal? BankCharge { get; set; }
	public string BankChargeTaxCode { get; set; }
	public string BankChargeBillNoForGst { get; set; }
	public string PaymentBy { get; set; }
	//If this cheque is returned/bounced cheque
	//Set the returned/bounced date. Otherwise it is null
	public DateTime? ReturnChequeDate { get; set; }
}

public class PaymentKnockoffSource
{
	//Document Type of APPayment knockoff
	public const string APInvoiceDocType = BCE.AutoCount.Document.DocumentType.APInvoice;
	public const string APDebitNoteDocType = BCE.AutoCount.Document.DocumentType.APDN;

	//Must assign with valid document type
	//in this class, you may find both possible document type for APPayment Knockoff
	//(1) APInvoiceDocType, and (2) APDebitNoteDocType
	public string DocType { get; set; }

	//The DocNo must already exist in the respective document type
	public string DocNo { get; set; }

	//The amount to be used to knockoff invoice,
	//the total must not be more than sum of Payment Amount
	public decimal Amount { get; set; }

	//When knockoff date is null,
	//system will use Payment Date as knockoff date
	public DateTime? Date { get; set; }
}

Create New AP Payment

public void NewAPPayment(APPaymentSource source, BCE.Data.DBSetting dbSetting)
{
    //Get the login user id
    string userID = BCE.AutoCount.Authentication.UserAuthentication.GetOrCreate(dbSetting).LoginUserID;

    //Create command object of APPayment
    BCE.AutoCount.ARAP.APPayment.APPaymentDataAccess cmd =
        BCE.AutoCount.ARAP.APPayment.APPaymentDataAccess.Create(dbSetting);
    //Create a new APPayment transaction
    BCE.AutoCount.ARAP.APPayment.APPaymentEntity doc = cmd.NewAPPayment();

    //Assign value to master table
    doc.CreditorCode = source.CreditorCode;
    doc.DocNo = source.DocumentNo ?? doc.DocNo;
    doc.DocNo2 = source.ReceiptNo2 ?? doc.DocNo2;
    doc.DocDate = source.DocumentDate;
    doc.CurrencyCode = source.PaymentCurrencyCode ?? doc.CurrencyCode;
    doc.ToHomeRate = source.PaymentToHomeCurrencyRate ?? doc.ToHomeRate;
    doc.ToCreditorRate = source.PaymentToCreditorCurrencyRate ?? doc.ToCreditorRate;
    doc.ProjNo = source.Project;
    doc.DeptNo = source.Department;

    //Loop and assign value to payment detail
    source.PaymentDetail.ForEach(s => AddAPPaymentDetail(s, doc.NewDetail));

    //Knockoff document
    foreach (PaymentKnockoffSource knockoff in source.PaymentKnockoff)
    {
        if (knockoff.Date.HasValue)
        {
            doc.KnockOff(knockoff.DocType, knockoff.DocNo, knockoff.Amount, knockoff.Date.Value);
        }
        else
        {
            //If Knockoff date is not defined, system will assign Payment Date to Knockoff Date
            doc.KnockOff(knockoff.DocType, knockoff.DocNo, knockoff.Amount);
        }
    }

    try
    {
        cmd.SaveAPPayment(doc, userID);
        //BCE.Application.AppMessage.ShowMessage(string.Format("{0} is created.", doc.DocNo));
    }
    catch (BCE.Application.AppException ex)
    {
        //BCE.Application.AppMessage.ShowMessage(ex.Message);
        //log error
    }
}

Add New AP Payment Detail

private void AddAPPaymentDetail(APPaymentDetailSource source, Func<BCE.AutoCount.ARAP.APPayment.APPaymentDTLEntity> addPaymentDetail)
{
    BCE.AutoCount.ARAP.APPayment.APPaymentDTLEntity dtl = addPaymentDetail();
    dtl.PaymentMethod = source.PaymentMethod;
    dtl.ChequeNo = source.ChequeNo ?? dtl.ChequeNo;
    dtl.PaymentAmt = source.PaymentAmount;
    dtl.BankCharge = source.BankCharge ?? dtl.BankCharge;
    dtl.BankChargeTaxType = source.BankChargeTaxCode ?? dtl.BankChargeTaxType;
    dtl.BankChargeTaxRefNo = source.BankChargeBillNoForGst ?? dtl.BankChargeTaxRefNo;
    dtl.PaymentBy = source.PaymentBy ?? source.PaymentBy;

    if (source.ReturnChequeDate.HasValue)
    {
        dtl.IsRCHQ = true;
        dtl.RCHQDate = source.ReturnChequeDate.Value;
    }
}

Example of AP Payment in Home currency only

Test Data 1

public void TestSampleData1(BCE.Data.DBSetting dbSetting)
{
	APPaymentSource source = new APPaymentSource()
	{
		//Home Currency Debtor, payment with home currency
		CreditorCode = "400-X001",
		Description = "Generated Test Payment 1",
		DocumentDate = new DateTime(2017, 12, 20),
	};

	source.PaymentDetail.Add(new APPaymentDetailSource()
	{
		PaymentMethod = "BANK",
		ChequeNo = "CHQ00012",
		PaymentAmount = 100,
		BankCharge = 0.50M
	});

	//Document type is required for document knockoff
	source.PaymentKnockoff.Add(new PaymentKnockoffSource()
	{
		DocType = PaymentKnockoffSource.APInvoiceDocType,
		DocNo = "B-000002",
		Amount = 70
	});
	source.PaymentKnockoff.Add(new PaymentKnockoffSource()
	{
		DocType = PaymentKnockoffSource.APInvoiceDocType,
		DocNo = "B-000003",
		Amount = 30
	});

	//Create New APPayment in AutoCount Accounting
	NewAPPayment(source, dbSetting);
}

Example of Foreign Customer and payment in customer currency

A payment of SGD100.00 knockoff 2 outstanding invoices, which both invoices currency rate is 3.2.
AutoCount Accounting auto generate Loss in foreign currency transaction.
This is because the currency rate was issued is 3.2 in invoice, and the payment currency rate is 3.1.

Test Data 2

public void TestSampleData2(BCE.Data.DBSetting dbSetting)
{
    APPaymentSource source = new APPaymentSource()
    {
        //Singapore customer, payment in Singapore Dollar
        CreditorCode = "400-S001",
        Description = "Generated Payment - Test Data",
        DocumentDate = new DateTime(2017, 12, 21),

        //If Payment Currency is same as Debtor Currency,
        //"PaymentCurrencyCode" can be excluded
        PaymentCurrencyCode = "SGD",
        PaymentToHomeCurrencyRate = 3.1M,
    };

    source.PaymentDetail.Add(new APPaymentDetailSource()
    {
        PaymentMethod = "BANK",
        ChequeNo = "SGB0009",
        PaymentAmount = 100,    //Currency in SGD
    });

    //Document type is required for document knockoff
    source.PaymentKnockoff.Add(new PaymentKnockoffSource()
    {
        DocType = PaymentKnockoffSource.APInvoiceDocType,
        DocNo = "B-000017",
        Amount = 70
    });
    source.PaymentKnockoff.Add(new PaymentKnockoffSource()
    {
        DocType = PaymentKnockoffSource.APInvoiceDocType,
        DocNo = "B-000018",
        Amount = 30
    });

    NewAPPayment(source, dbSetting);
}


See Also

AutoCount Accounting Account API
AR AP
Transactions Version Transactions Version
AR Debtor (Customer) 1.8, 1.9
2.0
AP Creditor (Supplier) 1.8, 1.9
2.0
AR Invoice 1.8, 1.9
2.0
AP Invoice 1.8, 1.9
2.0
AR Received Payment 1.8, 1.9
2.0
AP Payment 1.8, 1.9
2.0
AR Debit Note 1.8, 1.9
2.0
AP Debit Note 1.8, 1.9
2.0
AR Credit Note 1.8, 1.9
2.0
AP Credit Note 1.8, 1.9
2.0
AR Refund 1.8, 1.9
2.0
AP Refund 1.8, 1.9
2.0
AR Deposit 1.8, 1.9
2.0
AP Deposit 1.8, 1.9
2.0
AR Deposit - Create New or Update
with Refund & Forfeit
1.8, 1.9
2.0
A/R and A/P Contra Entry 1.8, 1.9
2.0

Go to menu

IconAC81.png Go to top
ProgrammerGo.jpg Resources For AutoCount Software Developers