UnlockInvoicePricingRequest Class

 

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)

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

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

NameDescription
System_CAPS_pubmethodUnlockInvoicePricingRequest()

Initializes a new instance of the UnlockInvoicePricingRequest class.

NameDescription
System_CAPS_pubpropertyExtensionData

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

System_CAPS_pubpropertyInvoiceId

Gets or sets the ID of the invoice.

System_CAPS_pubpropertyItem[String]

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

System_CAPS_pubpropertyParameters

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

System_CAPS_pubpropertyRequestId

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

System_CAPS_pubpropertyRequestName

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

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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.");

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

Return to top

Microsoft Dynamics CRM 2016 and CRM Online

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: