Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Description
Deletes a purchase order based on the purchase transaction key value supplied.
Parameters
Parameter |
Type |
Description |
|---|---|---|
key |
The purchase transaction key that specifies the purchase order to delete. |
|
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
- Purchasing
Examples
The following C# example deletes the purchase order with the purchase transaction key value of "PO2072". DeletePurchaseOrder can be used with only purchase orders that have a status of "New".
** 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 purchaseOrderDeletePolicy;
// 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 = "PO2072";
// Get the delete policy for purchase order objects
purchaseOrderDeletePolicy = wsDynamicsGP.GetPolicyByOperation("DeletePurchaseOrder", context);
// Delete the purchase order
wsDynamicsGP.DeletePurchaseOrder(purchaseOrderKey, context, purchaseOrderDeletePolicy);
}
}
}
** 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;
PurchaseTransactionKey purchaseOrderKey;
Policy purchaseOrderDeletePolicy;
// 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 = "PO2072";
// Get the delete policy for purchase order objects
purchaseOrderDeletePolicy = wsDynamicsGP.GetPolicyByOperation("DeletePurchaseOrder", context);
// Delete the purchase order
wsDynamicsGP.DeletePurchaseOrder(purchaseOrderKey, context, purchaseOrderDeletePolicy);
// Close the service
if(wsDynamicsGP.State != CommunicationState.Faulted)
{
wsDynamicsGP.Close();
}
}
}
}