AP Credit Note API v2

From AutoCount Resource Center
Jump to navigation Jump to search

Technical Specification

  1. Net Total is a read-only field that is calculated from the total amount of detail (APCNDTLEntity).
  2. Net Total must be positive value
  3. Knockoff Total Amount must be equal or smaller than Net Total

References of AutoCount Accounting version 2.0

AutoCount.Accounting.dll
AutoCount.Accounting.UI.dll
AutoCount.dll
AutoCount.MainEntry.dll
AutoCount.UI.dll
AutoCount.ARAP.dll

AP Credit Note API Usage

New with knockoff AP Invoice

public void New(AutoCount.Authentication.UserSession userSession)
{
    AutoCount.ARAP.APCN.APCNDataAccess cmd = AutoCount.ARAP.APCN.APCNDataAccess.Create(userSession, userSession.DBSetting);
    AutoCount.ARAP.APCN.APCNEntity doc = cmd.NewAPCN();
    AutoCount.ARAP.APCN.APCNDTLEntity dtl = null;

    //doc.DocNo = "<<New>>";
    doc.CreditorCode = "400-X001";
    doc.DocDate = new DateTime(2018, 6, 22);
    doc.Description = "Discount";
    doc.SupplierCNNo = "DSC-00015";
    doc.SupplierInvoiceNo = "BIL-00101";

    //Default available values: "PURCHASE", "GENERAL"
    //Note that user is able to change the above values
    //that is maintained in General Maintenance > Journal Type Maintenance
    doc.JournalType = "PURCHASE";

    //Default available values: "DISCOUNT", "RETURN"
    //Values are maintained in General Maintenance > C/N Type Maintenance
    doc.CNType = "DISCOUNT";

    //Add a new detail record
    dtl = doc.NewDetail();
    dtl.AccNo = "520-0000";
    dtl.Description = "Item Sale Discount";
    dtl.Amount = 50.00M;

    //Knockoff AP Invoice or AP Debit Note
    //"PI-00001" is AP Invoice Document Number
    doc.KnockOff(AutoCount.Document.DocumentType.APInvoice, "PI-00001", 50M);

    try
    {
        cmd.SaveAPCN(doc, userSession.LoginUserID);
        //Log success
        AutoCount.AppMessage.ShowMessage($"New APCN '{doc.DocNo}' is Created.");
    }
    catch (AutoCount.AppException ex)
    {
        //Log fail
        AutoCount.AppMessage.ShowMessage("Fail to create new APCN.\n" + ex.Message);
    }
}

Edit with knockoff AP Invoice

Load AP C/N with Document No

public void Edit(AutoCount.Authentication.UserSession userSession)
{
    AutoCount.ARAP.APCN.APCNDataAccess cmd = AutoCount.ARAP.APCN.APCNDataAccess.Create(userSession, userSession.DBSetting);
    AutoCount.ARAP.APCN.APCNEntity doc = cmd.GetAPCN("CN-00001");
    AutoCount.ARAP.APCN.APCNDTLEntity dtl = null;

    if (doc == null)
    {
        //log unable to load "CN-00001", or not found
        return;
    }

    //Clear all details of this document
    doc.ClearDetails();
    doc.ClearKnockOff();

    doc.DocDate = new DateTime(2018, 6, 21);
    doc.Description = "Discount";
    doc.Reason = "Pricing Adjustment";
    doc.SupplierCNNo = "DSC-00015";
    doc.SupplierInvoiceNo = "BIL-00101";

    //Default available values: "PURCHASE", "GENERAL"
    //Note that user is able to change the above values
    //that is maintained in General Maintenance > Journal Type Maintenance
    doc.JournalType = "PURCHASE";

    //Default available values: "DISCOUNT", "RETURN"
    //Note that user is able to change the above values
    doc.CNType = "RETURN";

    dtl = doc.NewDetail();
    dtl.AccNo = "520-0000";
    dtl.Description = "Return of Item A";
    dtl.Amount = 50.00M;

    //Knockoff AP Invoice or AP Debit Note
    //"PI-00001" is AP Invoice Document Number
    doc.KnockOff(AutoCount.Document.DocumentType.APInvoice, "PI-00001", 50M);

    try
    {
        cmd.SaveAPCN(doc, userSession.LoginUserID);
        //Log success
        AutoCount.AppMessage.ShowMessage($"New APCN '{doc.DocNo}' is Created.");
    }
    catch (AutoCount.AppException ex)
    {
        //Log fail
        AutoCount.AppMessage.ShowMessage("Fail to create new APCN.\n" + ex.Message);
    }
}

Load AP C/N with SupplierCNNo

public void EditWithSupplierCreditNoteNo(AutoCount.Authentication.UserSession userSession)
{
    string supplierCNNo = "DSC-00015";
    string creditorCode = "400-X001";

    AutoCount.ARAP.APCN.APCNDataAccess cmd = AutoCount.ARAP.APCN.APCNDataAccess.Create(userSession, userSession.DBSetting);
    AutoCount.ARAP.APCN.APCNEntity doc = cmd.GetAPCN(supplierCNNo, creditorCode);
    AutoCount.ARAP.APCN.APCNDTLEntity dtl = null;

    if (doc == null)
    {
        //log unable to load "CN-00001", or not found
        return;
    }

    //Clear all details of this document
    doc.ClearDetails();
    doc.ClearKnockOff();

    doc.DocDate = new DateTime(2018, 6, 21);
    doc.Description = "Discount";
    doc.Reason = "Pricing Adjustment";
    doc.SupplierCNNo = supplierCNNo;
    doc.SupplierInvoiceNo = "BIL-00101";

    //Default available values: "PURCHASE", "GENERAL"
    //Note that user is able to change the above values
    //that is maintained in General Maintenance > Journal Type Maintenance
    doc.JournalType = "PURCHASE";

    //Default available values: "DISCOUNT", "RETURN"
    //Note that user is able to change the above values
    doc.CNType = "RETURN";

    dtl = doc.NewDetail();
    dtl.AccNo = "520-0000";
    dtl.Description = "Return of Item A";
    dtl.Amount = 50.00M;

    //Knockoff AP Invoice or AP Debit Note
    //"PI-00001" is AP Invoice Document Number
    doc.KnockOff(AutoCount.Document.DocumentType.APInvoice, "PI-00001", 50M);

    try
    {
        cmd.SaveAPCN(doc, userSession.LoginUserID);
        //Log success
        AutoCount.AppMessage.ShowMessage($"New APCN '{doc.DocNo}' is Created.");
    }
    catch (AutoCount.AppException ex)
    {
        //Log fail
        AutoCount.AppMessage.ShowMessage("Fail to create new APCN.\n" + ex.Message);
    }
}

Cancel (Void)

public void Cancel(AutoCount.Authentication.UserSession userSession)
{
    AutoCount.ARAP.APCN.APCNDataAccess cmd = AutoCount.ARAP.APCN.APCNDataAccess.Create(userSession, userSession.DBSetting);
    string docNo = "CN-00001";

    try
    {
        cmd.CancelAPCN(docNo, userSession.LoginUserID);
        //cmd.CancelAPCN("DSC-00015", "400-X001", userSession.LoginUserID); //Cancel with SupplierCNNo
        AutoCount.AppMessage.ShowMessage($"APCN 'docNo' is Created.");
    }
    catch (AutoCount.AppException ex)
    {
        //Log fail
        AutoCount.AppMessage.ShowMessage($"Fail to cancel APCN {docNo}.\n" + ex.Message);
    }
}

Delete

public void Delete(AutoCount.Authentication.UserSession userSession)
{
    AutoCount.ARAP.APCN.APCNDataAccess cmd = AutoCount.ARAP.APCN.APCNDataAccess.Create(userSession, userSession.DBSetting);
    string docNo = "CN-00001";

    try
    {
        cmd.DeleteAPCN(docNo, userSession.LoginUserID);
        AutoCount.AppMessage.ShowMessage($"ARCN 'docNo' is Deleted.");
    }
    catch (AutoCount.AppException ex)
    {
        //Log fail
        AutoCount.AppMessage.ShowMessage($"Fail to delete APCN {docNo}.\n" + ex.Message);
    }
}

Get Document No. from Supplier Invoice No.

public string GetDocNoOfSupplierInvNo(string supplierInvNo, AutoCount.Authentication.UserSession userSession)
{
    object oDocNo = userSession.DBSetting.ExecuteScalar("SELECT DocNo FROM APInvoice WHERE SupplierInvoiceNo=?", supplierInvNo);

    //C# 6.0
    return oDocNo?.ToString();  //return oDocNo != null ? oDocNo.ToString() : null;
}


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