GetPayablesInvoiceByKey

Description

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

Parameters

Parameter	Type	Description
key	PayablesDocumentKey	The payables document key object that specifies the payables invoice to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetPayablesInvoiceByKeyResult	PayablesInvoice	A payables invoice object.

Interfaces

• Dynamics GP
• Purchasing

Examples

The following C# example retrieves a payables invoice object with the key value "00000000000000457". 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;
            PayablesInvoice payablesInvoice;

            // 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 = "00000000000000457";

            // Retrieve the payables invoice object
            payablesInvoice = wsDynamicsGP.GetPayablesInvoiceByKey(documentKey, context);

            // Display the vendor name property from the payables invoice object
            MessageBox.Show("Vendor: " + payablesInvoice.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;
            PayablesInvoice payablesInvoice;

            // 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 = "00000000000000457";

            // Retrieve the payables invoice object
            payablesInvoice = wsDynamicsGP.GetPayablesInvoiceByKey(documentKey, context);

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

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