UnlockInvoicePricingRequest Class

Article
10/20/2016

Applies To: Dynamics CRM 2015

Contains the data that is needed to unlock pricing for an invoice.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.UnlockInvoicePricingRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class UnlockInvoicePricingRequest : OrganizationRequest

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public ref class UnlockInvoicePricingRequest sealed : OrganizationRequest

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type UnlockInvoicePricingRequest = 
    class
        inherit OrganizationRequest
    end

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class UnlockInvoicePricingRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	UnlockInvoicePricingRequest()	Initializes a new instance of the UnlockInvoicePricingRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	InvoiceId	Gets or sets the ID of the invoice.
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of UnlockInvoicePricingResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Invoice entity and access rights on the record specified in the InvoiceId property. For a complete list of required privileges, see UnlockInvoicePricing message privileges.

Notes to Callers

This message unlocks the total price of products and services specified in the invoice. When the invoice pricing is unlocked, changes to underlying price lists (price level) can affect the prices for an invoice.

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.



// Retrieve the invoice
Invoice updatedInvoice = (Invoice)_serviceProxy.Retrieve(
        Invoice.EntityLogicalName,
        _invoiceId,
        new ColumnSet("invoiceid", "totalamount")
    );

Console.WriteLine("Updated invoice retrieved.");
Console.WriteLine();

Console.WriteLine("Details after lock and update:");
Console.WriteLine("----------------");
Console.WriteLine("Current invoice total: {0}",
    updatedInvoice.TotalAmount.Value);
Console.WriteLine("Current price per item: {0}",
    priceListItem.Amount.Value);
Console.WriteLine("</End of Listing>");
Console.WriteLine();

// Unlock the invoice pricing
UnlockInvoicePricingRequest unlockInvoiceRequest =
    new UnlockInvoicePricingRequest()
    {
        InvoiceId = _invoiceId
    };
_serviceProxy.Execute(unlockInvoiceRequest);

Console.WriteLine("Invoice pricing unlocked.");

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via