VoidCashReceipt
Description
This method voids a cash receipt.
Parameters
Parameter |
Type |
Description |
---|---|---|
key |
A receivables document key object that specifies the cash receipt to void. |
|
context |
Specifies information about how the method will be called. |
|
policy |
Specifies the set of behaviors and behavior options to be applied during the operation. |
Interfaces
- Dynamics GP
- Sales
Examples
The following C# example voids the cash receipt with the receivables document key "PYMNT000000000167". The VoidCashReceipt operation reverses the cash receipt but does not delete the document.
** Legacy endpoint**
using System; using System.Collections.Generic; using System.Text; using DynamicsGPWebServiceSample.DynamicsGPService; namespace DynamicsGPWebServiceSample { class Program { static void Main(string[] args) { CompanyKey companyKey; Context context; ReceivablesDocumentKey cashReceiptKey; Policy cashReceiptVoidPolicy; // 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 the receivables document key to specify the cash receipt object cashReceiptKey = new ReceivablesDocumentKey(); cashReceiptKey.Id = "PYMNT000000000167"; // Get the void policy for cash receipts cashReceiptVoidPolicy = wsDynamicsGP.GetPolicyByOperation("VoidCashReceipt", context); // Void the cash receipt wsDynamicsGP.VoidCashReceipt(cashReceiptKey, context, cashReceiptVoidPolicy); } } }
** Native endpoint **
using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.ServiceModel; using DynamicsGPWebServiceSample.DynamicsGPService; namespace DynamicsGPWebServiceSample { class Program { static void Main(string[] args) { CompanyKey companyKey; Context context; ReceivablesDocumentKey cashReceiptKey; Policy cashReceiptVoidPolicy; // 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 the receivables document key to specify the cash receipt object cashReceiptKey = new ReceivablesDocumentKey(); cashReceiptKey.Id = "PYMNT000000000167"; // Get the void policy for cash receipts cashReceiptVoidPolicy = wsDynamicsGP.GetPolicyByOperation("VoidCashReceipt", context); // Void the cash receipt wsDynamicsGP.VoidCashReceipt(cashReceiptKey, context, cashReceiptVoidPolicy); // Close the service if(wsDynamicsGP.State != CommunicationState.Faulted) { wsDynamicsGP.Close(); } } } }