CreditMemo

Represents a document that is used to adjust or rectify errors made in an invoice. The invoice has already been processed and sent to a customer. This object is available in API version 48.0 and later.

A credit memo always decreases the balance of an invoice or invoice lines. Users can apply positive credit memos to positive invoices or invoice lines, and negative credit memos to negative invoices or invoice lines. For example, a $10 credit memo would reduce the balance of a $100 invoice line to $90. A -$10 credit memo would reduce the balance of a -$100 credit memo to -$110.

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
Balance	Type currency Properties Filter, Nillable, Sort Description Amount of the credit memo available for allocation.
BillToContactId	Type reference Properties Filter, Group, Nillable, Sort, Update Description Inherited from the account’s Bill to Account.
BillingAccountId	Type reference Properties Filter, Group, Sort, Update Description The customer account for this invoice.
CreditDate	Type date Properties Filter, Group, Sort, Update Description The date that the credit memo was posted.
CreditMemoNumber	Type string Properties Filter, Group, Nillable, Sort, Update Description System number for the credit memo.
Description	Type string Properties Filter, Group, Nillable, Sort, Update Description Description of the credit memo.
DocumentNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated number for organization of financial documents. Can be sequential or random.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
OwnerId	Type reference Properties Filter, Group, Sort, Update Description The user who owns a credit memo record.
ReferenceEntityId	Type reference Properties Filter, Group, Nillable, Sort, Update Description The ID of the order or order summary that created this credit memo.
Status	Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description Status of the credit memo. Possible values are: `Canceled`: Reserved for future use. `Draft`: The credit memo is not yet recorded as a financial transaction. Certain fields can still be edited. `Pending`: Reserved for future use. `Posted`: The credit memo has been recorded as a financial transaction. Most fields can’t be edited.
TotalAdjustmentAmount	Type currency Properties Filter, Nillable, Sort Description Sum of TotalAmountvalues for the credit memo’s adjustment lines.
TotalAmount	Type currency Properties Filter, Nillable, Sort Description Sum of the credit memo’s TotalLineAmount and TotalAdjustmentAmount.
TotalAmountWithTax	Type currency Properties Filter, Nillable, Sort Description Total credit memo amount, with tax included.
TotalChargeAmount	Type currency Properties Filter, Nillable, Sort Description Sum of TotalAmount values for the credit memo’s charge lines. values for all of this credit memo’s credit memo lines.
TotalTaxAmount	Type currency Properties Filter, Nillable, Sort Description Sum of TotalAmount values for the credit memo’s tax lines.

Object Reference for Salesforce and Lightning Platform

CreditMemo

Supported Calls

Special Access Rules

Fields