GetPaymentTermsByKey

Description

Retrieves a single payment terms object based on the specified payment terms key.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Common
• Field Service
• Financials
• Human Resources/Payroll
• Inventory
• Manufacturing
• Project Accounting
• Purchasing
• Sales

Examples

The following C# example retrieves a payment terms object with the key value "EOM". A message box displays the payment terms days until due property.

** 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;
            PaymentTermsKey paymentTermsKey;
            PaymentTerms paymentTerms;

            // 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 payment terms key to specify the payment terms object
            paymentTermsKey = new PaymentTermsKey();
            paymentTermsKey.Id = "EOM";

            // Retrieve the payment terms object
            paymentTerms = wsDynamicsGP.GetPaymentTermsByKey(paymentTermsKey, context);

            // Display the days until due property
            MessageBox.Show("Days until due: " + paymentTerms.DaysUntilDue.Value.ToString());
        }
    }
}

** 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;
            PaymentTermsKey paymentTermsKey;
            PaymentTerms paymentTerms;

            // 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 payment terms key to specify the payment terms object
            paymentTermsKey = new PaymentTermsKey();
            paymentTermsKey.Id = "EOM";

            // Retrieve the payment terms object
            paymentTerms = wsDynamicsGP.GetPaymentTermsByKey(paymentTermsKey, context);

            // Display the days until due property
            MessageBox.Show("Days until due: " + paymentTerms.DaysUntilDue.Value.ToString());

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