Invoice entity messages and methods

 

Applies To: Dynamics CRM 2015

An invoice is an order that has been billed. The schema name for this entity is Invoice. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message	Description
AssignRequest	Assigns an invoice to another user or team.
AssociateRequest	Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the invoice entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
CompoundCreateRequest	Deprecated. Creates an invoice and its related invoice detail. Use CreateRequest.
CompoundUpdateRequest	Deprecated. Updates an invoice and its related invoice detail. Use UpdateRequest.
CreateRequest	Creates an invoice. You can also call the IOrganizationService.Create method.
DeleteRequest	Deletes an invoice. You can also call the IOrganizationService.Delete method.
DisassociateRequest	Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Disassociate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the invoice entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
GenerateInvoiceFromOpportunityRequest	Generates an invoice from an opportunity.
GetQuantityDecimalRequest	Gets the quantity decimal value of a product for the entity specified in the target.
GrantAccessRequest	Shares an invoice with another security principal (user or team).
InitializeFromRequest	Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.
LockInvoicePricingRequest	Locks the price per unit for the products in the specified invoice.
ModifyAccessRequest	Changes the access rights for an invoice previously shared with another security principal (user or team).
RemoveRelatedRequest	Deprecated. Removes the relationship between an invoice and a contact. Use DisassociateRequest or Disassociate instead.
RetrieveRequest	Retrieves an invoice. You can also call the IOrganizationService.Retrieve method.
RetrieveDuplicatesRequest	Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.
RetrieveMultipleRequest	Retrieves a collection of invoices. You can also call the IOrganizationService.RetrieveMultiple method.
RetrievePrincipalAccessRequest	Retrieves the access rights that the specified security principal (user or team) has to an invoice
RetrieveSharedPrincipalsAndAccessRequest	Retrieves all the security principals (users or teams) that have access to an invoice, together with their access rights to the invoice.
RevokeAccessRequest	Removes all access rights to an invoice for the specified security principal (user or team).
RollupRequest	Retrieves all the invoices related to the specified record (account or contact).
SetRelatedRequest	Deprecated. Creates a relationship between an invoice and a contact. Use AssociateRequest or Associate instead.
SetStateRequest	Sets the state of an invoice. If you are using early bound types, use the InvoiceState enumeration. For a list of the state values, refer to the Invoice entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
UnlockInvoicePricingRequest	Unlocks the price per unit for the products in the specified invoice.
UpdateRequest	Use this message to update an invoice. You can also call the IOrganizationService.Update method.

See Also

Quote, order, and invoice entities
Invoice entity privileges
InvoiceDetail (invoice product) entity messages and methods

© 2016 Microsoft. All rights reserved. Copyright