Newer Version Available

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

CreditMemoLine

Represents a partial or full application of a credit memo’s balance against an invoice or invoice 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, Update
Description
Sum of adjustments made to the credit memo.
ChargeAmount
Type
currency
Properties
Filter, Nillable, Sort, Update
Description
Sum of charges made to the credit memo.
CreditMemoId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the parent credit memo.
Description
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
Description of the credit memo line.
EndDate
Type
date
Properties
Filter, Group, Nillable, Sort, Update
Description
For credit memos made from a time-based service, the end date of the billing for the service.
Name
Type
string
Properties
Filter, Group, idLookup, Sort, Update
Description
Name of the credit memo line.
Product2Id
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The product that was charged or ordered to create the credit memo line.
ReferenceEntityItemId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The order item or adjustment item that created the credit memo line.
ReferenceEntityItemType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of transaction that created the credit memo line.
Possible values are:
  • DeliveryCharge
  • OrderProduct
ReferenceEntityItemTypeCode
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of object that created the credit memo 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.
StartDate
Type
date
Properties
Filter, Group, Nillable, Sort, Update
Description
For credit memo lines made from a time-based service, the first date of the billing for the service.
Status
Type
string
Properties
Filter, Group, Nillable, Sort
Description
State of the credit memo line. Inherited from the invoice’s status.
TaxAmount
Type
currency
Properties
Filter, Nillable, Sort, Update
Description
Total tax for the credit memo.
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 credit memo line’s TaxAmount.
TaxName
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
User-defined name for 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 credit memo line before any applicable tax.
TotalAmountWithTax
Type
currency
Properties
Filter, Nillable, Sort
Description
Total amount of tax for this credit memo line, with tax included. Sum of TotalAmount and TaxAmount.
Type
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Shows the type of transaction for the invoice line.
Possible values are:
  • Adjustment
  • Charge
  • Tax