invoicedetail EntityType

Line item in an invoice containing detailed billing information for a product.

Entity Set Path
[organization URI]/api/data/v9.0/invoicedetails
Base Type
crmbaseentity
Display Name
Invoice Line
Primary Key
invoicedetailid
Primary Key Attribute
productidname
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
actualdeliveryon Edm.DateTimeOffset

Enter the date when the invoiced product was delivered to the customer.

Display Name: Delivered On

baseamount Edm.Decimal

Shows the total price of the invoice product, based on the price per unit, volume discount, and quantity.

Display Name: Amount

baseamount_base Edm.Decimal

Value of the Amount in base currency.

Display Name: Amount (Base)

Read Only
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
description Edm.String

Type additional information to describe the product line item of the invoice.

Display Name: Description

exchangerate Edm.Decimal

Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.

Display Name: Exchange Rate

Read Only
extendedamount Edm.Decimal

Shows the total amount due for the invoice product, based on the sum of the unit price, quantity, discounts, and tax.

Display Name: Extended Amount

extendedamount_base Edm.Decimal

Value of the Extended Amount in base currency.

Display Name: Extended Amount (Base)

Read Only
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

invoicedetailid Edm.Guid

Unique identifier of the invoice product line item.

Display Name: Invoice Product

invoiceispricelocked Edm.Boolean

Information about whether invoice product pricing is locked.

Display Name: Invoice Is Price Locked

Read Only
Default Options
Value Label
1 Yes
0 No
invoicestatecode Edm.Int32

Status of the invoice product.

Display Name: Invoice Status

Read Only
iscopied Edm.Boolean

Select whether the invoice product is copied from another item or data source.

Display Name: Copied

Default Options
Value Label
1 Yes
0 No
ispriceoverridden Edm.Boolean

Select whether the price per unit is fixed at the value in the specified price list or can be overridden by users who have edit rights to the invoice product.

Display Name: Pricing

Default Options
Value Label
1 Override Price
0 Use Default
isproductoverridden Edm.Boolean

Select whether the product exists in the Microsoft Dynamics 365 product catalog or is a write-in product specific to the parent invoice.

Display Name: Select Product

Default Options
Value Label
1 Write In
0 Existing
lineitemnumber Edm.Int32

Type the line item number for the invoice product to easily identify the product in the invoice and make sure it's listed in the correct order.

Display Name: Line Item Number

manualdiscountamount Edm.Decimal

Type the manual discount amount for the invoice product to deduct any negotiated or other savings from the product total.

Display Name: Manual Discount

manualdiscountamount_base Edm.Decimal

Value of the Manual Discount in base currency.

Display Name: Manual Discount (Base)

Read Only
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
msdyn_billingmethod Edm.Int32

Billing method for the project invoice line. Valid values are Time and Material and Fixed Price

Display Name: Billing Method

Default Options
Value Label
192350000 Time and Material
192350001 Fixed Price
msdyn_chargeableamount Edm.Decimal

The amount from included line details that is chargeable.

Display Name: Chargeable Amount

msdyn_chargeableamount_base Edm.Decimal

Value of the Chargeable Amount in base currency.

Display Name: Chargeable Amount (Base)

Read Only
msdyn_complimentaryamount Edm.Decimal

The amount from included line details that is complimentary and won't be charged.

Display Name: Complimentary Amount

msdyn_complimentaryamount_base Edm.Decimal

Value of the Complimentary Amount in base currency.

Display Name: Complimentary Amount (Base)

Read Only
msdyn_contractline Edm.String

Shows the project contract line for this invoice line.

Display Name: Project Contract Line

msdyn_contractlineamount Edm.Decimal

Amount from the related project contract line if present.

Display Name: Contract Line Amount

msdyn_contractlineamount_base Edm.Decimal

Value of the project contract line amount in base currency.

Display Name: Contract Line Amount (Base)

Read Only
msdyn_invoicedtilldate Edm.Decimal

Amount already invoiced to customer for the same project contract line.

Display Name: Amount Previously Invoiced

msdyn_invoicedtilldate_base Edm.Decimal

Value of the Amount Previously Invoiced in base currency.

Display Name: Amount Previously Invoiced (Base)

Read Only
msdyn_lineorder Edm.Int32

Shows the order of this invoice product within the invoice.

Display Name: Line Order

msdyn_linetype Edm.Int32

The field to distinguish the Invoice lines to be of project service or field service

Display Name: Line Type

Default Options
Value Label
690970000 Project Service Line
690970001 Field Service Line
msdyn_nonchargeableamount Edm.Decimal

The amount from included line details that is non-chargeable.

Display Name: Non Chargeable Amount

msdyn_nonchargeableamount_base Edm.Decimal

Value of the Non Chargeable Amount in base currency.

Display Name: Non Chargeable Amount (Base)

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

parentbundleid Edm.Guid

Choose the parent bundle associated with this product

Display Name: Parent Bundle

priceperunit Edm.Decimal

Type the price per unit of the invoice product. The default is the value in the price list specified on the parent invoice for existing products.

Display Name: Price Per Unit

priceperunit_base Edm.Decimal

Value of the Price Per Unit in base currency.

Display Name: Price Per Unit (Base)

Read Only
pricingerrorcode Edm.Int32

Pricing error for the invoice product line item.

Display Name: Pricing Error

Default Options
Value Label
0 None
1 Detail Error
2 Missing Price Level
3 Inactive Price Level
4 Missing Quantity
5 Missing Unit Price
6 Missing Product
7 Invalid Product
8 Missing Pricing Code
9 Invalid Pricing Code
10 Missing UOM
11 Product Not In Price Level
12 Missing Price Level Amount
13 Missing Price Level Percentage
14 Missing Price
15 Missing Current Cost
16 Missing Standard Cost
17 Invalid Price Level Amount
18 Invalid Price Level Percentage
19 Invalid Price
20 Invalid Current Cost
21 Invalid Standard Cost
22 Invalid Rounding Policy
23 Invalid Rounding Option
24 Invalid Rounding Amount
25 Price Calculation Error
26 Invalid Discount Type
27 Discount Type Invalid State
28 Invalid Discount
29 Invalid Quantity
30 Invalid Pricing Precision
31 Missing Product Default UOM
32 Missing Product UOM Schedule
33 Inactive Discount Type
34 Invalid Price Level Currency
35 Price Attribute Out Of Range
36 Base Currency Attribute Overflow
37 Base Currency Attribute Underflow
productassociationid Edm.Guid

Unique identifier of the product line item association with bundle in the invoice

Display Name: Bundle Item Association

productdescription Edm.String

Type a name or description to identify the type of write-in product included in the invoice.

Display Name: Write-In Product

productname Edm.String

Calculated field that will be populated by name and description of the product.

Display Name: Product Name

producttypecode Edm.Int32

Product Type

Display Name: Product type

Default Options
Value Label
1 Product
2 Bundle
3 Required Bundle Product
4 Optional Bundle Product
5 Project-based Service
propertyconfigurationstatus Edm.Int32

Status of the property configuration.

Display Name: Property Configuration

Default Options
Value Label
0 Edit
1 Rectify
2 Not Configured
quantity Edm.Decimal

Type the amount or quantity of the product included in the invoice's total amount due.

Display Name: Quantity

quantitybackordered Edm.Decimal

Type the amount or quantity of the product that is back ordered for the invoice.

Display Name: Quantity Back Ordered

quantitycancelled Edm.Decimal

Type the amount or quantity of the product that was canceled for the invoice line item.

Display Name: Quantity Canceled

quantityshipped Edm.Decimal

Type the amount or quantity of the product that was shipped.

Display Name: Quantity Shipped

sequencenumber Edm.Int32

Shows the ID of the data that maintains the sequence.

Display Name: Sequence Number

shippingtrackingnumber Edm.String

Type a tracking number for shipment of the invoiced product.

Display Name: Shipment Tracking Number

shipto_city Edm.String

Type the city for the customer's shipping address.

Display Name: Ship To City

shipto_country Edm.String

Type the country or region for the customer's shipping address.

Display Name: Ship To Country/Region

shipto_fax Edm.String

Type the fax number for the customer's shipping address.

Display Name: Ship To Fax

shipto_freighttermscode Edm.Int32

Select the freight terms to make sure shipping orders are processed correctly.

Display Name: Freight Terms

Default Options
Value Label
1 FOB
2 No Charge
shipto_line1 Edm.String

Type the first line of the customer's shipping address.

Display Name: Ship To Street 1

shipto_line2 Edm.String

Type the second line of the customer's shipping address.

Display Name: Ship To Street 2

shipto_line3 Edm.String

Type the third line of the shipping address.

Display Name: Ship To Street 3

shipto_name Edm.String

Type a name for the customer's shipping address, such as "Headquarters" or "Field office", to identify the address.

Display Name: Ship To Name

shipto_postalcode Edm.String

Type the ZIP Code or postal code for the shipping address.

Display Name: Ship To ZIP/Postal Code

shipto_stateorprovince Edm.String

Type the state or province for the shipping address.

Display Name: Ship To State/Province

shipto_telephone Edm.String

Type the phone number for the customer's shipping address.

Display Name: Ship To Phone

tax Edm.Decimal

Type the tax amount for the invoice product.

Display Name: Tax

tax_base Edm.Decimal

Value of the Tax in base currency.

Display Name: Tax (Base)

Read Only
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only
volumediscountamount Edm.Decimal

Shows the discount amount per unit if a specified volume is purchased. Configure volume discounts in the Product Catalog in the Settings area.

Display Name: Volume Discount

Read Only
volumediscountamount_base Edm.Decimal

Value of the Volume Discount in base currency.

Display Name: Volume Discount (Base)

Read Only
willcall Edm.Boolean

Select whether the invoice product should be shipped to the specified address or held until the customer calls with further pick up or delivery instructions.

Display Name: Ship To

Default Options
Value Label
1 Will Call
0 Address

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Shows who created the record.

_createdonbehalfby_value createdonbehalfby

Shows who created the record on behalf of another user.

_invoiceid_value invoiceid

Unique identifier of the invoice associated with the invoice product line item.

_modifiedby_value modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value modifiedonbehalfby

Shows who last updated the record on behalf of another user.

_msdyn_agreement_value msdyn_agreement

Unique identifier for Agreement associated with Invoice Product.

_msdyn_agreementinvoiceproduct_value msdyn_agreementinvoiceproduct

Unique identifier for Agreement Invoice Product associated with Invoice Product.

_msdyn_currency_value msdyn_currency

Unique identifier for Currency associated with Invoice Product.

_msdyn_orderinvoicingproduct_value msdyn_OrderInvoicingProduct

Unique identifier for Order Invoicing Product associated with Invoice Product.

_msdyn_project_value msdyn_Project

Shows the project for this invoice line.

_msdyn_workorderid_value msdyn_workorderid

Unique identifier for Work Order associated with Invoice Product.

_msdyn_workorderproductid_value msdyn_workorderproductid

Unique identifier for Work Order Product associated with Invoice Product.

_msdyn_workorderserviceid_value msdyn_workorderserviceid

Unique identifier for Work Order Service associated with Invoice Product.

_ownerid_value createdby

Owner Id

_owningbusinessunit_value createdby

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

_productid_value productid

Choose the product to include on the invoice.

_salesrepid_value salesrepid

Choose the user responsible for the sale of the invoice product.

_transactioncurrencyid_value transactioncurrencyid

Choose the local currency for the record to make sure budgets are reported in the correct currency.

_uomid_value uomid

Choose the unit of measurement for the base unit quantity for this purchase, such as each or dozen.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_invoicedetailbase_createdby
createdonbehalfby systemuser lk_invoicedetail_createdonbehalfby
invoiceid invoice invoice_details
modifiedby systemuser lk_invoicedetailbase_modifiedby
modifiedonbehalfby systemuser lk_invoicedetail_modifiedonbehalfby
msdyn_agreement msdyn_agreement msdyn_msdyn_agreement_invoicedetail_Agreement
msdyn_agreementinvoiceproduct msdyn_agreementinvoiceproduct msdyn_msdyn_agreementinvoiceproduct_invoicedetail_AgreementInvoiceProduct
msdyn_currency transactioncurrency msdyn_transactioncurrency_invoicedetail_Currency
msdyn_OrderInvoicingProduct msdyn_orderinvoicingproduct msdyn_msdyn_orderinvoicingproduct_invoicedetail_OrderInvoiceProduct
msdyn_Project msdyn_project msdyn_msdyn_project_invoicedetail_Project
msdyn_workorderid msdyn_workorder msdyn_msdyn_workorder_invoicedetail
msdyn_workorderproductid msdyn_workorderproduct msdyn_msdyn_workorderproduct_invoicedetail
msdyn_workorderserviceid msdyn_workorderservice msdyn_msdyn_workorderservice_invoicedetail
owningteam team team_invoicedetail
owninguser systemuser user_invoicedetail
parentbundleid_invoicedetail invoicedetail invoicedetail_parent_invoicedetail
productassociationid_productassociation productassociation productAssociation_invoice_details
productid product product_invoice_details
salesrepid systemuser system_user_invoicedetail
transactioncurrencyid transactioncurrency transactioncurrency_invoicedetail
uomid uom unit_of_measurement_invoice_details

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
InvoiceDetail_AsyncOperations asyncoperation regardingobjectid_invoicedetail
InvoiceDetail_BulkDeleteFailures bulkdeletefailure regardingobjectid_invoicedetail
InvoiceDetail_Dynamicpropertyinstance dynamicpropertyinstance regardingobjectid_invoicedetail
invoicedetail_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_invoicedetail
invoicedetail_parent_invoicedetail invoicedetail parentbundleid_invoicedetail
invoicedetail_principalobjectattributeaccess principalobjectattributeaccess objectid_invoicedetail
InvoiceDetail_ProcessSessions processsession regardingobjectid_invoicedetail
InvoiceDetail_SyncErrors syncerror regardingobjectid_invoicedetail_syncerror

Operations

The following operations can be used with the invoicedetail entity type.

Name Binding
CalculatePrice Not Bound
RetrieveProductProperties Entity

Solutions

The following solutions include the invoicedetail entity type.

Name Description
Field Service Microsoft Dynamics 365 for Field Service allows organizations of any size to deliver intelligent, world class field service, managing all aspects of the end-to-end field service management cycle. Features include scheduling, mobile, asset management, inventory control, customer notifications, and resource utilization controls that help maximize efficiency and minimize costs.
Sales Dynamics 365 workload for sales.
Project Service Automation Microsoft Dynamics 365 for Project Service Automation is an end-to-end solution that helps sales and delivery teams engage customers and deliver billable projects on time and within budget. Project Service gives you the tools you need to: Estimate, quote, and contract work; Plan and assign resources; Enable team collaboration; Capture time, expense, and progress data for real-time insights and accurate invoicing.

See also