GetCashReceiptByKey

Description

Retrieves a single cash receipt object based on the receivables document key value supplied.

Parameters

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

Return Value:

Value	Type	Description
GetCashReceiptByKeyResult	CashReceipt	A cash receipt object.

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves the cash receipt object with the key value "PYMNT000000000265". A message box displays the customer ID and the amount of the cash receipt.

** 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 cashReceiptKey;
            CashReceipt cashReceipt;

            // 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 to specify the cash receipt
            cashReceiptKey = new ReceivablesDocumentKey();
            cashReceiptKey.Id = "PYMNT000000000265";

            // Retrieve the cash receipt object
            cashReceipt = wsDynamicsGP.GetCashReceiptByKey(cashReceiptKey, context);

            // Display the customer and cash amount
            MessageBox.Show("Customer: " + cashReceipt.CustomerKey.Id + "  Amount: "
            + cashReceipt.Amount.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 cashReceiptKey;
            CashReceipt cashReceipt;

            // 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 to specify the cash receipt
            cashReceiptKey = new ReceivablesDocumentKey();
            cashReceiptKey.Id = "PYMNT000000000265";

            // Retrieve the cash receipt object
            cashReceipt = wsDynamicsGP.GetCashReceiptByKey(cashReceiptKey, context);

            // Display the customer and cash amount
            MessageBox.Show("Customer: " + cashReceipt.CustomerKey.Id + "  Amount: "
            + cashReceipt.Amount.Value.ToString("C"));

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