UpdateSalesInvoice

Description

Updates the specified sales invoice object, storing the current values in the database.

Parameters

Parameter	Type	Description
salesInvoice	SalesInvoice	The sales invoice object that is being updated.
context	Context	Specifies information about how the method will be called.
policy	Policy	Specifies the set of behaviors and behavior options to be applied during the operation.

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves the sales invoice with the sales document key value "STDINV2255" and sets the comment property to "Requested ship date confirmed". The UpdateSalesInvoice operation saves the new comment and all the sales invoice object's existing properties to the database.

** 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;
            SalesDocumentKey salesInvoiceKey;
            SalesInvoice salesInvoice;
            Policy salesInvoiceUpdatePolicy;

            // 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 sales document key
            salesInvoiceKey = new SalesDocumentKey();
            salesInvoiceKey.Id = "STDINV2255";

            // Retrieve the sales invoice
            salesInvoice = wsDynamicsGP.GetSalesInvoiceByKey(salesInvoiceKey, context);

            // Set the comment property
            salesInvoice.Comment = "Requested ship date confirmed";

            // Get the update policy for sales invoices
            salesInvoiceUpdatePolicy = wsDynamicsGP.GetPolicyByOperation("UpdateSalesInvoice", context);

            // Update the sales invoice object
            wsDynamicsGP.UpdateSalesInvoice(salesInvoice, context, salesInvoiceUpdatePolicy);
        }
    }
}

** 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;
            SalesDocumentKey salesInvoiceKey;
            SalesInvoice salesInvoice;
            Policy salesInvoiceUpdatePolicy;

            // 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 sales document key
            salesInvoiceKey = new SalesDocumentKey();
            salesInvoiceKey.Id = "STDINV2255";

            // Retrieve the sales invoice
            salesInvoice = wsDynamicsGP.GetSalesInvoiceByKey(salesInvoiceKey, context);

            // Set the comment property
            salesInvoice.Comment = "Requested ship date confirmed";

            // Get the update policy for sales invoices
            salesInvoiceUpdatePolicy = wsDynamicsGP.GetPolicyByOperation("UpdateSalesInvoice", context);

            // Update the sales invoice object
            wsDynamicsGP.UpdateSalesInvoice(salesInvoice, context, salesInvoiceUpdatePolicy);

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