This method voids a purchase order document.
Parameter |
Type |
Description |
---|---|---|
key |
A purchase transaction key object that specifies the purchase order 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. |
The following C# example voids the purchase order with the purchase transaction key “PO2071”. VoidPurchaseOrder can be used with only purchase orders that have a status of “New”. The VoidPurchaseOrder operation either moves the purchase order to history or removes it from the system.
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; PurchaseTransactionKey purchaseOrderKey; Policy purchaseOrderVoidPolicy; // 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 object to specify the purchase order purchaseOrderKey = new PurchaseTransactionKey(); purchaseOrderKey.Id = "PO2071"; // Get the void policy for purchase order objects purchaseOrderVoidPolicy = wsDynamicsGP.GetPolicyByOperation("VoidPurchaseOrder", context); // Void the purchase order wsDynamicsGP.VoidPurchaseOrder(purchaseOrderKey, context, purchaseOrderVoidPolicy); } } }
Native endpoint
using System; using System.Collections.Generic; using System.Linq; using System.Text; using DynamicsGPWebServiceSample.DynamicsGPService; namespace DynamicsGPWebServiceSample { class Program { static void Main(string[] args) { CompanyKey companyKey; Context context; PurchaseTransactionKey purchaseOrderKey; Policy purchaseOrderVoidPolicy; // 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 object to specify the purchase order purchaseOrderKey = new PurchaseTransactionKey(); purchaseOrderKey.Id = "PO2071"; // Get the void policy for purchase order objects purchaseOrderVoidPolicy = wsDynamicsGP.GetPolicyByOperation("VoidPurchaseOrder", context); // Void the purchase order wsDynamicsGP.VoidPurchaseOrder(purchaseOrderKey, context, purchaseOrderVoidPolicy); // Close the service if(wsDynamicsGP.State != CommunicationState.Faulted) { wsDynamicsGP.Close(); } } } }