UnlockInvoicePricingRequest Class


Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

For the Web API use the UnlockInvoicePricing Action.

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

Inheritance Hierarchy



[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class UnlockInvoicePricingRequest : OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class UnlockInvoicePricingRequest
    Inherits OrganizationRequest


Name Description
System_CAPS_pubmethod UnlockInvoicePricingRequest()

Initializes a new instance of the UnlockInvoicePricingRequest class.


Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty InvoiceId

Gets or sets the ID of the invoice.

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)


Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)


Message Availability

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


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.


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(
        new ColumnSet("invoiceid", "totalamount")

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

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

// Unlock the invoice pricing
UnlockInvoicePricingRequest unlockInvoiceRequest =
    new UnlockInvoicePricingRequest()
        InvoiceId = _invoiceId

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.

See Also

Microsoft.Crm.Sdk.Messages Namespace
UnlockInvoicePricing message privileges
Invoice entity messages and methods
Sample: Set negative prices in opportunities, quotes, and sales orders
Sample: Process quotes, sales orders and invoices
Sales entities (lead, opportunity, competitor, quote, order, invoice)
How role-based security can be used to control access to entities in Microsoft Dynamics 365
How record-based security can be used to control access to records in Microsoft Dynamics 365

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright