Newer Version Available

This content describes an older version of this product. View Latest

InvoiceLine

Represents the amount that a buyer must pay for a product, service, or fee. Invoice lines are created based on the amount of an order line. This object is available in API version 48.0 and later.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update()

Special Access Rules

To access these entities, your org must have a Salesforce Order Management license. These entities are available only in Lightning Experience.

Fields

Field Details
AdjustmentAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Sum of adjustments made to the invoice line.
ChargeAmount
Type
currency
Properties
Filter, Nillable, Sort, Update
Description
Sum of charges made to the invoice line.
Description
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
Description of the invoice line.
GroupReferenceEntityItemId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
Grouping field for adjustment line items.
This is a relationship field.
Relationship Name
GroupReferenceEntityItem
Relationship Type
Lookup
Refers To
OrderItem
InvoiceId
Type
reference
Properties
Filter, Group, Sort
Description
The invoice that contains this invoice line.
This is a relationship field.
Relationship Name
Invoice
Relationship Type
Lookup
Refers To
Invoice
InvoiceLineEndDate
Type
date
Properties
Filter, Group, Sort, Update
Description
For invoice lines made from a time-based service, the end date of the billing for the service.
InvoiceLineStartDate
Type
date
Properties
Filter, Group, Sort, Update
Description
For invoice lines made from a time-based service, the first date of the billing for the service.
InvoiceStatus
Type
string
Properties
Filter, Group, Nillable, Sort
Description
State of the invoice line. Inherited from the invoice’s status.
Name
Type
string
Properties
Filter, Group, idLookup, Sort, Update
Description
Name of the invoice line.
Product2Id
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The product that was charged or ordered to create the invoice line.
This is a relationship field.
Relationship Name
Product2
Relationship Type
Lookup
Refers To
Product2
Quantity
Type
double
Properties
Filter, Nillable, Sort, Update
Description
Number of units of the order product that created the invoice line.
ReferenceEntityItemId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The order item or adjustment item that created the invoice line.
This is a relationship field.
Relationship Name
ReferenceEntityItem
Relationship Type
Lookup
Refers To
OrderItem
ReferenceEntityItemType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type of transaction that created the invoice line.
Possible values are:
  • DeliveryCharge
  • OrderProduct
ReferenceEntityItemTypeCode
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type of object that created the invoice line.
Possible values are:
  • Charge
  • Product
RelatedLineId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The original invoice line that was adjusted or taxed.
Relationship Name
RelatedLine
Relationship Type
Lookup
Refers To
InvoiceLine
TaxAmount
Type
currency
Properties
Filter, Nillable, Sort, Update
Description
Total tax for the invoice line.
TaxCode
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
The code used to calculate tax rate for the invoice line.
TaxEffectiveDate
Type
date
Properties
Filter, Group, Nillable, Sort, Update
Description
The date used to calculate the invoice line’s TaxAmount.
TaxName
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
User-defined name for the applied tax.
TaxRate
Type
percent
Properties
Filter, Nillable, Sort, Update
Description
Percentage value used for calculating tax.
TotalAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The total amount of the invoice line before any applicable tax.
TotalAmountWithTax
Type
currency
Properties
Filter, Nillable, Sort
Description
Total amount of tax for this invoice line, with tax included. Sum of TotalAmount and TaxAmount.
Type
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Shows the type of transaction for the invoice line.
Possible values are:
  • Adjustment
  • Charge
  • Tax
UnitPrice
Type
currency
Properties
Filter, Nillable, Sort, Update
Description
Price for one unit of the item on the invoice line.