invoice EntityType

Order that has been billed.

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

Properties

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

Name Type Details
billto_city Edm.String

Type the city for the customer's billing address.

Display Name: Bill To City

billto_composite Edm.String

Shows the complete Bill To address.

Display Name: Bill To Address

Read Only
billto_country Edm.String

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

Display Name: Bill To Country/Region

billto_fax Edm.String

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

Display Name: Bill To Fax

billto_line1 Edm.String

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

Display Name: Bill To Street 1

billto_line2 Edm.String

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

Display Name: Bill To Street 2

billto_line3 Edm.String

Type the third line of the billing address.

Display Name: Bill To Street 3

billto_name Edm.String

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

Display Name: Bill To Name

billto_postalcode Edm.String

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

Display Name: Bill To ZIP/Postal Code

billto_stateorprovince Edm.String

Type the state or province for the billing address.

Display Name: Bill To State/Province

billto_telephone Edm.String

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

Display Name: Bill To Phone

createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
datedelivered Edm.DateTimeOffset

Enter the date when the products included in the invoice were delivered.

Display Name: Date Delivered

description Edm.String

Type additional information to describe the invoice, such as shipping details or product substitutions.

Display Name: Description

discountamount Edm.Decimal

Type the discount amount for the invoice if the customer is eligible for special savings.

Display Name: Invoice Discount Amount

discountamount_base Edm.Decimal

Value of the Invoice Discount Amount in base currency.

Display Name: Invoice Discount Amount (Base)

Read Only
discountpercentage Edm.Decimal

Type the discount rate that should be applied to the Detail Amount field, for use in calculating the Pre-Freight Amount and Total Amount values for the invoice.

Display Name: Invoice Discount (%)

duedate Edm.Date

Enter the date by which the invoice should be paid by the customer.

Display Name: Due Date

emailaddress Edm.String

The primary email address for the entity.

Display Name: Email Address

entityimage Edm.Binary

The default image for the entity.

Display Name: Entity Image

entityimage_timestamp Edm.Int64
Read Only
entityimage_url Edm.String
Read Only
entityimageid Edm.Guid
Read Only
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
freightamount Edm.Decimal

Type the cost of freight or shipping for the products included in the invoice for use in calculating the total amount due.

Display Name: Freight Amount

freightamount_base Edm.Decimal

Value of the Freight Amount in base currency.

Display Name: Freight Amount (Base)

Read Only
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

invoiceid Edm.Guid

Unique identifier of the invoice.

Display Name: Invoice

invoicenumber Edm.String

Shows the identifying number or code of the invoice.

Display Name: Invoice ID

ispricelocked Edm.Boolean

Select whether prices specified on the invoice are locked from any further updates.

Display Name: Prices Locked

Default Options
Value Label
1 Yes
0 No
lastbackofficesubmit Edm.DateTimeOffset

Enter the date and time when the invoice was last submitted to an accounting or ERP system for processing.

Display Name: Last Submitted to Back Office

lastonholdtime Edm.DateTimeOffset

Contains the date time stamp of the last on hold time.

Display Name: Last On Hold Time

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
msdyn_amountdue Edm.Decimal

Enter the amount due on this invoice.

Display Name: Amount Due

msdyn_amountdue_base Edm.Decimal

Value of the Amount Due in base currency.

Display Name: Amount Due (Base)

Read Only
msdyn_hascorrections Edm.Boolean

Indicates if this invoice contains corrections to previous invoices.

Display Name: Has Corrections

Default Options
Value Label
1 Yes
0 No
msdyn_invoicedate Edm.DateTimeOffset

Document date of the Invoice for use in calculation of payment due date

Display Name: Invoice Date

msdyn_ordertype Edm.Int32

Whether the Invoice is for an Item-based or a service maintainence-based sale

Display Name: Type

Default Options
Value Label
192350000 Item based
690970002 Service-Maintenance Based
192350001 Work based
msdyn_projectinvoicestatus Edm.Int32

Project specific status

Display Name: Project Invoice Status

Default Options
Value Label
192350000 Draft
192350001 In Review
192350002 Confirmed
192350003 Invoice Paid
name Edm.String

Type a descriptive name for the invoice.

Display Name: Name

onholdtime Edm.Int32

Shows the duration in minutes for which the invoice was on hold.

Display Name: On Hold Time (Minutes)

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

paymenttermscode Edm.Int32

Select the payment terms to indicate when the customer needs to pay the total amount.

Display Name: Payment Terms

Default Options
Value Label
1 Net 30
2 2% 10, Net 30
3 Net 45
4 Net 60
pricingerrorcode Edm.Int32

Type of pricing error for the invoice.

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
prioritycode Edm.Int32

Select the priority so that preferred customers or critical issues are handled quickly.

Display Name: Priority

Default Options
Value Label
1 Default Value
processid Edm.Guid

Contains the id of the process associated with the entity.

Display Name: Process Id

shippingmethodcode Edm.Int32

Select a shipping method for deliveries sent to this address.

Display Name: Shipping Method

Default Options
Value Label
1 Airborne
2 DHL
3 FedEx
4 UPS
5 Postal Mail
6 Full Load
7 Will Call
shipto_city Edm.String

Type the city for the customer's shipping address.

Display Name: Ship To City

shipto_composite Edm.String

Shows the complete Ship To address.

Display Name: Ship To Address

Read Only
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: Ship To Freight Terms

Default Options
Value Label
1 Default Value
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

stageid Edm.Guid

Contains the id of the stage where the entity is located.

Display Name: Stage Id

statecode Edm.Int32

Shows whether the invoice is active, paid, or canceled. Paid and canceled invoices are read-only and can't be edited unless they are reactivated.

Display Name: Status

Default Options
Value Label
0 Active
1 Closed (deprecated)
2 Paid
3 Canceled
statuscode Edm.Int32

Select the invoice's status.

Display Name: Status Reason

Default Options
Value Label
1 New
2 Partially Shipped
4 Billed
5 Booked (applies to services)
6 Installed (applies to services)
3 Canceled (deprecated)
7 Paid in Full (deprecated)
100001 Complete
100002 Partial
100003 Canceled
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

totalamount Edm.Decimal

Shows the total amount due, calculated as the sum of the products, discount, freight, and taxes for the invoice.

Display Name: Total Amount

totalamount_base Edm.Decimal

Value of the Total Amount in base currency.

Display Name: Total Amount (Base)

Read Only
totalamountlessfreight Edm.Decimal

Shows the total product amount due, minus any discounts. This value is added to freight and tax amounts in the calculation for the total amount due for the invoice.

Display Name: Total Pre-Freight Amount

totalamountlessfreight_base Edm.Decimal

Value of the Total Pre-Freight Amount in base currency.

Display Name: Total Pre-Freight Amount (Base)

Read Only
totaldiscountamount Edm.Decimal

Shows the total discount amount, based on the discount price and rate entered on the invoice.

Display Name: Total Discount Amount

totaldiscountamount_base Edm.Decimal

Value of the Total Discount Amount in base currency.

Display Name: Total Discount Amount (Base)

Read Only
totallineitemamount Edm.Decimal

Shows the sum of all existing and write-in products included on the invoice, based on the specified price list and quantities.

Display Name: Total Detail Amount

totallineitemamount_base Edm.Decimal

Value of the Total Detail Amount in base currency.

Display Name: Total Detail Amount (Base)

Read Only
totallineitemdiscountamount Edm.Decimal

Shows the Manual Discount amounts specified on all products included in the invoice. This value is reflected in the Detail Amount field on the invoice and is added to any discount amount or rate specified on the invoice.

Display Name: Total Line Item Discount Amount

totallineitemdiscountamount_base Edm.Decimal

Value of the Total Line Item Discount Amount in base currency.

Display Name: Total Line Item Discount Amount (Base)

Read Only
totaltax Edm.Decimal

Shows the total of the Tax amounts specified on all products included in the invoice, included in the Total Amount due calculation for the invoice.

Display Name: Total Tax

totaltax_base Edm.Decimal

Value of the Total Tax in base currency.

Display Name: Total Tax (Base)

Read Only
traversedpath Edm.String

A comma separated list of string values representing the unique identifiers of stages in a Business Process Flow Instance in the order that they occur.

Display Name: Traversed Path

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
willcall Edm.Boolean

Select whether the products included in the invoice 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
_accountid_value

Unique identifier of the account with which the invoice is associated.

_contactid_value

Unique identifier of the contact associated with the invoice.

_createdby_value createdby

Shows who created the record.

_createdonbehalfby_value createdonbehalfby

Shows who created the record on behalf of another user.

_customerid_value customerid_accountcustomerid_contact

Select the customer account or contact to provide a quick link to additional customer details, such as account information, activities, and opportunities.

_modifiedby_value modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value modifiedonbehalfby

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

_opportunityid_value opportunityid

Choose the opportunity that the invoice is related to for reporting and analytics.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

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.

_pricelevelid_value pricelevelid

Choose the price list associated with this record to make sure the products associated with the campaign are offered at the correct prices.

_salesorderid_value salesorderid

Choose the order related to the invoice to make sure the order is fulfilled and invoiced correctly.

_slaid_value sla_invoice_sla

Choose the service level agreement (SLA) that you want to apply to the invoice record.

_slainvokedid_value slainvokedid_invoice_sla

Last SLA that was applied to this invoice. This field is for internal use only.

_transactioncurrencyid_value transactioncurrencyid

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

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_invoicebase_createdby
createdonbehalfby systemuser lk_invoice_createdonbehalfby
customerid_account account invoice_customer_accounts
customerid_contact contact invoice_customer_contacts
modifiedby systemuser lk_invoicebase_modifiedby
modifiedonbehalfby systemuser lk_invoice_modifiedonbehalfby
opportunityid opportunity opportunity_invoices
ownerid principal owner_invoices
owningbusinessunit businessunit business_unit_invoices
owningteam team team_invoices
owninguser systemuser system_user_invoices
pricelevelid pricelevel price_level_invoices
salesorderid salesorder order_invoices
sla_invoice_sla sla manualsla_invoice
slainvokedid_invoice_sla sla sla_invoice
stageid_processstage processstage processstage_invoices
transactioncurrencyid transactioncurrency transactioncurrency_invoice

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
bpf_invoice_msdyn_bpf_d8f9dc7f099f44db9d641dd81fbd470d msdyn_bpf_d8f9dc7f099f44db9d641dd81fbd470d bpf_invoiceid
contactinvoices_association contact contactinvoices_association
invoice_activity_parties activityparty partyid_invoice
Invoice_ActivityPointers activitypointer regardingobjectid_invoice
Invoice_Annotation annotation objectid_invoice
Invoice_Appointments appointment regardingobjectid_invoice_appointment
Invoice_AsyncOperations asyncoperation regardingobjectid_invoice
Invoice_BulkDeleteFailures bulkdeletefailure regardingobjectid_invoice
invoice_connections1 connection record1id_invoice
invoice_connections2 connection record2id_invoice
invoice_details invoicedetail invoiceid
Invoice_Emails email regardingobjectid_invoice_email
Invoice_Faxes fax regardingobjectid_invoice_fax
Invoice_Letters letter regardingobjectid_invoice_letter
Invoice_MailboxTrackingFolder mailboxtrackingfolder regardingobjectid_invoice
invoice_msdyn_approvals msdyn_approval regardingobjectid_invoice_msdyn_approval
invoice_msdyn_bookingalerts msdyn_bookingalert regardingobjectid_invoice_msdyn_bookingalert
Invoice_Phonecalls phonecall regardingobjectid_invoice_phonecall
invoice_principalobjectattributeaccess principalobjectattributeaccess objectid_invoice
Invoice_ProcessSessions processsession regardingobjectid_invoice
Invoice_RecurringAppointmentMasters recurringappointmentmaster regardingobjectid_invoice_recurringappointmentmaster
Invoice_ServiceAppointments serviceappointment regardingobjectid_invoice_serviceappointment
Invoice_SocialActivities socialactivity regardingobjectid_invoice_socialactivity
Invoice_SyncErrors syncerror regardingobjectid_invoice_syncerror
Invoice_Tasks task regardingobjectid_invoice_task
msdyn_invoice_msdyn_actual_Invoice msdyn_actual msdyn_Invoice
msdyn_invoice_msdyn_agreementinvoicedate_Invoice msdyn_agreementinvoicedate msdyn_Invoice
msdyn_invoice_msdyn_contractlineinvoiceschedule_Invoice msdyn_contractlineinvoiceschedule msdyn_Invoice
msdyn_invoice_msdyn_invoicelinetransaction_Invoice msdyn_invoicelinetransaction msdyn_Invoice
msdyn_invoice_msdyn_orderinvoicingdate_Invoice msdyn_orderinvoicingdate msdyn_Invoice
msdyn_invoice_msdyn_orderinvoicingsetupdate_Invoice msdyn_orderinvoicingsetupdate msdyn_Invoice
msdyn_invoice_msdyn_paymentdetail_Invoice msdyn_paymentdetail msdyn_invoice
slakpiinstance_invoice slakpiinstance regarding_invoice

Operations

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

Name Binding
CalculatePrice Not Bound
GenerateInvoiceFromOpportunity Not Bound
GetInvoiceProductsFromOpportunity Entity
GetQuantityDecimal Entity
GrantAccess Not Bound
LockInvoicePricing Entity
ModifyAccess Not Bound
msdyn_AddInvoiceLineDetails Entity
msdyn_CorrectInvoice Entity
msdyn_InvoicePaid Entity
msdyn_InvoiceRecalculate Entity
msdyn_PostInvoice Entity
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
Rollup Not Bound

Solutions

The following solutions include the invoice 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.
CRM Extensions For internal use only.
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