GetReceivablesFinanceChargeByKey

Description

Retrieves a single receivables finance charge object based on the specified receivables document key. The value returned by this method can be affected by entity ID filtering.

Parameters

Parameter	Type	Description
key	ReceivablesDocumentKey	The receivables document key object that specifies the receivables finance charge to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetReceivablesFinanceChargeByKeyResult	ReceivablesFinanceCharge	A receivables finance charge object.

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves a receivables finance charge object with the key value "FC20010". A message box displays the amount from the receivables finance charge object.

** Legacy endpoint**

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            ReceivablesDocumentKey financeChargeKey;
            ReceivablesFinanceCharge financeCharge;

            // Create an instance of the service
            DynamicsGP wsDynamicsGP = new DynamicsGP();

            // Be sure the default credentials are used
            wsDynamicsGP.UseDefaultCredentials = true;

            // Create a context with which to call the service
            context = new Context();

            // Specify which company to use (sample company)
            companyKey = new CompanyKey();
            companyKey.Id = (-1);

            // Set up the context object
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Create a receivables document key object to specify the receivables finance charge
            financeChargeKey = new ReceivablesDocumentKey();
            financeChargeKey.Id = "FC20010";

            // Retrieve the receivables finance charge object
            financeCharge = wsDynamicsGP.GetReceivablesFinanceChargeByKey(financeChargeKey, context);

            // Display the finance charge amount
            MessageBox.Show("Total finance charge: " + financeCharge.DocumentAmount.Value.ToString("C"));
        }
    }
}

** Native endpoint **

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            ReceivablesDocumentKey financeChargeKey;
            ReceivablesFinanceCharge financeCharge;

            // Create an instance of the service
            DynamicsGPClient wsDynamicsGP = new DynamicsGPClient();

            // Create a context with which to call the service
            context = new Context();

            // Specify which company to use (sample company)
            companyKey = new CompanyKey();
            companyKey.Id = (-1);

            // Set up the context object
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Create a receivables document key object to specify the receivables finance charge
            financeChargeKey = new ReceivablesDocumentKey();
            financeChargeKey.Id = "FC20010";

            // Retrieve the receivables finance charge object
            financeCharge = wsDynamicsGP.GetReceivablesFinanceChargeByKey(financeChargeKey, context);

            // Display the finance charge amount
            MessageBox.Show("Total finance charge: " + financeCharge.DocumentAmount.Value.ToString("C"));

            // Close the service
            if(wsDynamicsGP.State != CommunicationState.Faulted)
            {
                wsDynamicsGP.Close();
            }
        }
    }
}