invoice EntityType

Description: Order that has been billed.

Entity Set path: [organization URI]/api/data/v8.0/invoices

Base Type: crmbaseentity EntityType

Display Name: Invoice

Primary Key: invoiceid

Primary Name Attribute: name

Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to invoice

Operations using the invoice entity type.

Properties

Properties represent fields of data stored in the entity. Some properties are not writable.

Name Type Details

_accountid_value

Edm.Guid

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

Computed property

Read-only property

_contactid_value

Edm.Guid

Description: Unique identifier of the contact associated with the invoice.

Computed property

Read-only property

_createdby_value

Edm.Guid

Description: Shows who created the record.

Computed property

Read-only property

_createdonbehalfby_value

Edm.Guid

Description: Shows who created the record on behalf of another user.

Computed property

Read-only property

_customerid_value

Edm.Guid

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

_modifiedby_value

Edm.Guid

Description: Shows who last updated the record.

Computed property

Read-only property

_modifiedonbehalfby_value

Edm.Guid

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

Computed property

Read-only property

_opportunityid_value

Edm.Guid

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

Computed property

Read-only property

_ownerid_value

Edm.Guid

Description: Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.

_owningbusinessunit_value

Edm.Guid

Description: Unique identifier of the business unit that owns the invoice.

Computed property

Read-only property

_owningteam_value

Edm.Guid

Description: Unique identifier of the team who owns the invoice.

Computed property

Read-only property

_owninguser_value

Edm.Guid

Description: Unique identifier of the user who owns the invoice.

Computed property

Read-only property

_pricelevelid_value

Edm.Guid

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

Computed property

Read-only property

_salesorderid_value

Edm.Guid

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

Computed property

Read-only property

_transactioncurrencyid_value

Edm.Guid

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

Computed property

Read-only property

billto_city

Edm.String

Description: Type the city for the customer's billing address.

Display Name: Bill To City

billto_composite

Edm.String

Description: Shows the complete Bill To address.

Display Name: Bill To Address

Read-only property

billto_country

Edm.String

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

Display Name: Bill To Country/Region

billto_fax

Edm.String

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

Display Name: Bill To Fax

billto_line1

Edm.String

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

Display Name: Bill To Street 1

billto_line2

Edm.String

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

Display Name: Bill To Street 2

billto_line3

Edm.String

Description: Type the third line of the billing address.

Display Name: Bill To Street 3

billto_name

Edm.String

Description: 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

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

Display Name: Bill To ZIP/Postal Code

billto_stateorprovince

Edm.String

Description: Type the state or province for the billing address.

Display Name: Bill To State/Province

billto_telephone

Edm.String

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

Display Name: Bill To Phone

createdon

Edm.DateTimeOffset

Description: Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.

Display Name: Created On

Read-only property

datedelivered

Edm.DateTimeOffset

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

Display Name: Date Delivered

description

Edm.String

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

Display Name: Description

discountamount

Edm.Decimal

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

Display Name: Invoice Discount Amount

discountamount_base

Edm.Decimal

Description: Shows the Invoice Discount field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Invoice Discount Amount (Base)

Read-only property

discountpercentage

Edm.Decimal

Description: 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

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

Display Name: Due Date

entityimage

Edm.Binary

Description: The default image for the entity.

Display Name: Entity Image

entityimage_timestamp

Edm.Int64

Description:

Read-only property

entityimage_url

Edm.String

Description:

Read-only property

entityimageid

Edm.Guid

Description: For internal use only.

Display Name: Entity Image Id

Read-only property

exchangerate

Edm.Decimal

Description: 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 property

freightamount

Edm.Decimal

Description: 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

Description: Shows the Freight Amount field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Freight Amount (Base)

Read-only property

importsequencenumber

Edm.Int32

Description: Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

invoiceid

Edm.Guid

Description: Unique identifier of the invoice.

Display Name: Invoice

invoicenumber

Edm.String

Description: Shows the identifying number or code of the invoice.

Display Name: Invoice ID

ispricelocked

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Prices Locked

lastbackofficesubmit

Edm.DateTimeOffset

Description: 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

modifiedon

Edm.DateTimeOffset

Description: Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Type a descriptive name for the invoice.

Display Name: Name

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

paymenttermscode

Edm.Int32

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

Default Options:

1 : Net 30
2 : 2% 10, Net 30
3 : Net 45
4 : Net 60

Display Name: Payment Terms

pricingerrorcode

Edm.Int32

Description: Type of pricing error for the invoice.

Default Options:

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

Display Name: Pricing Error

prioritycode

Edm.Int32

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

Default Options:

1 : Default Value

Display Name: Priority

processid

Edm.Guid

Description: Shows the ID of the process.

Display Name: Process

shippingmethodcode

Edm.Int32

Description: Select a shipping method for deliveries sent to this address.

Default Options:

1 : Airborne
2 : DHL
3 : FedEx
4 : UPS
5 : Postal Mail
6 : Full Load
7 : Will Call

Display Name: Shipping Method

shipto_city

Edm.String

Description: Type the city for the customer's shipping address.

Display Name: Ship To City

shipto_composite

Edm.String

Description: Shows the complete Ship To address.

Display Name: Ship To Address

Read-only property

shipto_country

Edm.String

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

Display Name: Ship To Country/Region

shipto_fax

Edm.String

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

Display Name: Ship To Fax

shipto_freighttermscode

Edm.Int32

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

Default Options:

1 : Default Value

Display Name: Ship To Freight Terms

shipto_line1

Edm.String

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

Display Name: Ship To Street 1

shipto_line2

Edm.String

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

Display Name: Ship To Street 2

shipto_line3

Edm.String

Description: Type the third line of the shipping address.

Display Name: Ship To Street 3

shipto_name

Edm.String

Description: 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

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

Display Name: Ship To ZIP/Postal Code

shipto_stateorprovince

Edm.String

Description: Type the state or province for the shipping address.

Display Name: Ship To State/Province

shipto_telephone

Edm.String

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

Display Name: Ship To Phone

stageid

Edm.Guid

Description: Shows the ID of the stage.

Display Name: Process Stage

statecode

Edm.Int32

Description: 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.

Default Options:

0 : Active
1 : Closed (deprecated)
2 : Paid
3 : Canceled

Display Name: Status

statuscode

Edm.Int32

Description: Select the invoice's status.

Default Options:

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

Display Name: Status Reason

timezoneruleversionnumber

Edm.Int32

Description: For internal use only.

Display Name: Time Zone Rule Version Number

totalamount

Edm.Decimal

Description: 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

Description: Shows the Total Amount field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Total Amount (Base)

Read-only property

totalamountlessfreight

Edm.Decimal

Description: 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

Description: Shows the Pre-Freight Amount field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Total Pre-Freight Amount (Base)

Read-only property

totaldiscountamount

Edm.Decimal

Description: 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

Description: Shows the Total Discount Amount field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Total Discount Amount (Base)

Read-only property

totallineitemamount

Edm.Decimal

Description: 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

Description: Shows the Detail Amount field converted to the system's default base currency. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Total Detail Amount (Base)

Read-only property

totallineitemdiscountamount

Edm.Decimal

Description: 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

Description: Shows the total of 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 (Base)

Read-only property

totaltax

Edm.Decimal

Description: 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

Description: Shows the Total Tax field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Total Tax (Base)

Read-only property

traversedpath

Edm.String

Description: For internal use only.

Display Name: Traversed Path

utcconversiontimezonecode

Edm.Int32

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

Display Name: UTC Conversion Time Zone Code

versionnumber

Edm.Int64

Description: Version number of the invoice.

Display Name: Version Number

Read-only property

willcall

Edm.Boolean

Description: 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.

Default Options:

1 : Will Call
0 : Address

Display Name: Ship To

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced.

Name Type Partner

createdby

systemuser EntityType

lk_invoicebase_createdby

createdonbehalfby

systemuser EntityType

lk_invoice_createdonbehalfby

customerid_account

account EntityType

invoice_customer_accounts

customerid_contact

contact EntityType

invoice_customer_contacts

modifiedby

systemuser EntityType

lk_invoicebase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_invoice_modifiedonbehalfby

opportunityid

opportunity EntityType

opportunity_invoices

ownerid

principal EntityType

owner_invoices

owningbusinessunit

businessunit EntityType

business_unit_invoices

owningteam

team EntityType

team_invoices

owninguser

systemuser EntityType

system_user_invoices

pricelevelid

pricelevel EntityType

price_level_invoices

salesorderid

salesorder EntityType

order_invoices

transactioncurrencyid

transactioncurrency EntityType

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

contactinvoices_association

contact EntityType

contactinvoices_association

invoice_activity_parties

activityparty EntityType

partyid_invoice

Invoice_ActivityPointers

activitypointer EntityType

regardingobjectid_invoice

Invoice_Annotation

annotation EntityType

objectid_invoice

Invoice_Appointments

appointment EntityType

regardingobjectid_invoice_appointment

Invoice_AsyncOperations

asyncoperation EntityType

regardingobjectid_invoice

Invoice_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_invoice

invoice_connections1

connection EntityType

record1id_invoice

invoice_connections2

connection EntityType

record2id_invoice

invoice_details

invoicedetail EntityType

invoiceid

Invoice_Emails

email EntityType

regardingobjectid_invoice_email

Invoice_Faxes

fax EntityType

regardingobjectid_invoice_fax

Invoice_Letters

letter EntityType

regardingobjectid_invoice_letter

Invoice_Phonecalls

phonecall EntityType

regardingobjectid_invoice_phonecall

Invoice_RecurringAppointmentMasters

recurringappointmentmaster EntityType

regardingobjectid_invoice_recurringappointmentmaster

Invoice_ServiceAppointments

serviceappointment EntityType

regardingobjectid_invoice_serviceappointment

Invoice_SocialActivities

socialactivity EntityType

regardingobjectid_invoice_socialactivity

Invoice_Tasks

task EntityType

regardingobjectid_invoice_task

Operations bound to invoice

The following operations are bound to the invoice entity type.

Name Bound to

GetInvoiceProductsFromOpportunity Action

Entity

LockInvoicePricing Action

Entity

Operations using the invoice entity type.

The following operations use the invoice entity type in a parameter or return type.

Name How used Description

ConvertSalesOrderToInvoice Action

ReturnType

Converts a sales order to an invoice.

GetInvoiceProductsFromOpportunity Action

entity Parameter

Retrieves the products from an opportunity and copy them to the invoice.

LockInvoicePricing Action

entity Parameter

Locks the total price of products and services that are specified in the invoice.

関連項目

他のリソース

Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics CRM 2016 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.