GetPayablesReturnByKey

Description

Retrieves a single payables return object based on the specified payables document key.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Purchasing

Examples

The following C# example retrieves a payables return object with the key value "00000000000000462". A message box displays the vendor name.

** 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;
            PayablesDocumentKey documentKey;
            PayablesReturn payablesReturn;

            // 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 payables document key
            documentKey = new PayablesDocumentKey();
            documentKey.Id = "00000000000000462";

            // Retrieve the payables return object
            payablesReturn = wsDynamicsGP.GetPayablesReturnByKey(documentKey, context);

            // Display the vendor name property from the payables return object
            MessageBox.Show("Vendor name: " + payablesReturn.VendorName);
        }
    }
}

** 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;
            PayablesDocumentKey documentKey;
            PayablesReturn payablesReturn;

            // 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 payables document key
            documentKey = new PayablesDocumentKey();
            documentKey.Id = "00000000000000462";

            // Retrieve the payables return object
            payablesReturn = wsDynamicsGP.GetPayablesReturnByKey(documentKey, context);

            // Display the vendor name property from the payables return object
            MessageBox.Show("Vendor name: " + payablesReturn.VendorName);

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