GetPurchaseInvoiceByKey

Description

Retrieves a single purchase invoice object based on the specified purchase transaction key.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Purchasing

Examples

The following C# example retrieves a purchase invoice object with the key value "RCT1160". A message box displays the Vendor Name property from the purchase invoice 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;
            PurchaseTransactionKey purchaseInvoiceKey;
            PurchaseInvoice purchaseInvoice;

            // 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 purchase transaction key to specify the purchase invoice
            purchaseInvoiceKey = new PurchaseTransactionKey();
            purchaseInvoiceKey.Id = "RCT1160";

            // Retrieve the purchase invoice object
            purchaseInvoice = wsDynamicsGP.GetPurchaseInvoiceByKey(purchaseInvoiceKey, context);

            // Display the vendor name property from the purchase invoice object
            MessageBox.Show("Vendor name: " + purchaseInvoice.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;
            PurchaseTransactionKey purchaseInvoiceKey;
            PurchaseInvoice purchaseInvoice;

            // 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 purchase transaction key to specify the purchase invoice
            purchaseInvoiceKey = new PurchaseTransactionKey();
            purchaseInvoiceKey.Id = "RCT1160";

            // Retrieve the purchase invoice object
            purchaseInvoice = wsDynamicsGP.GetPurchaseInvoiceByKey(purchaseInvoiceKey, context);

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

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