CreditMemo
Represents a document that’s used to reduce the amount that a buyer owes a seller under the terms of an earlier invoice. This object is available in API version 62.0 and later.
describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update()
You need the Credit Memo Operations User permission set to access this object.
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The amount of the credit memo that’s available for allocation.
- Type: reference
- Properties: Filter, Group, Nillable, Sort, Update
- Description: This field is inherited from the account’s
Bill to Accountfield.
This field is a relationship field.
- Relationship Name: BillToContact
- Refers To: Contact
- Type: reference
- Properties: Filter, Group, Sort, Update
- Description: Required. The ID of the customer account associated with this credit memo.
This field is a relationship field.
- Relationship Name: BillingAccount
- Refers To: Account
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Description: Specifies whether the credit memo is created due to writing off an invoice, converting negative invoice lines, or referencing an existing record.
Valid values are InvoiceWriteOff, Referenced, or Standalone. This field is available in API version 64.0 and later.
- Type: double
- Properties: Filter, Nillable, Sort
- Description: The sum of the total amount with tax on the credit memo in corporate currency. Available in API version 63.0 and later.
- Type: date
- Properties: Filter, Group, Nillable, Sort
- Description: The date on which the credit memo amounts are converted to the corporate currency. Available in API version 63.0 and later.
- Type: double
- Properties: Filter, Nillable, Sort
- Description: The exchange rate that’s used to convert credit memo amounts to the corporate currency. Available in API version 63.0 and later.
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Description: The currency ISO code of the corporate currency. Available in API version 63.0 and later.
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Description: Specifies whether the credit memo originated in Salesforce or an external system.
Valid values are External or Salesforce.
- Type: date
- Properties: Filter, Group, Nillable, Sort
- Description: The date when the credit memo was posted.
- Type: dateTime
- Properties: Filter, Nillable, Sort
- Description: The date and time when the credit memo was locked. This field is available in API version 68.0 and later.
- Type: string
- Properties: Filter, Group, Nillable, Sort, Update
- Description: The number of the credit memo.
- Type: string
- Properties: Filter, Group, Nillable, Sort, Update
- Description: Additional details about the credit memo.
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description: Required. The auto-generated reference number for the credit memo.
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The effective date of the credit memo. If this field is empty, the credit date is used. For reporting purposes only; this field drives no other logic.
- Type: string
- Properties: Filter, Group, Nillable, Sort, Update
- Description: An external system’s ID for the credit memo.
- Type: string
- Properties: Filter, Group, Nillable, Sort, Update
- Description: The name of the external system that also contains the credit memo.
- Type: double
- Properties: Filter, Nillable, Sort, Update
- Description: The total amount with tax value in functional currency. Available in API version 66.0 and later.
- Type: date
- Properties: Filter, Group, Nillable, Sort, Update
- Description: The date on which the total amount with tax value is converted into functional currency. Available in API version 66.0 and later.
- Type: double
- Properties: Filter, Nillable, Sort, Update
- Description: The exchange rate that’s used to convert the total amount with tax value into functional currency. Available in API version 66.0 and later.
- Type: string
- Properties: Filter, Group, Nillable, Sort, Update
- Description: The ISO code of the functional currency. Available in API version 66.0 and later.
- Type: boolean
- Properties: Defaulted on create, Filter, Group, Sort
- Description: Required. Indicates whether the credit memo is locked for editing (
true) or not (false). This field is available in API version 68.0 and later.
The default value is false.
- Type: dateTime
- Properties: Filter, Nillable, Sort
- Description: The timestamp when the current user last accessed a credit memo record indirectly, for example, through a list view or related record.
- Type: dateTime
- Properties: Filter, Nillable, Sort
- Description: The timestamp when the current user last viewed a credit memo record. If this value is null, it’s possible that the user only accessed the credit memo record or a related list view (
LastReferencedDate), but not viewed the credit memo record itself.
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The legal entity accounting period record that’s related to the credit memo. This field is available in API version 65.0 and later.
This field is a relationship field.
- Relationship Name: LegalEntityAccountingPeriod
- Refers To: LegalEntyAccountingPeriod
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The legal entity record that’s related to the credit memo. This field is available in API version 65.0 and later.
This field is a relationship field.
- Relationship Name: LegalEntity
- Refers To: LegalEntity
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The total difference between the credit applied to and credit unapplied from the invoice.
This field is a calculated field.
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The total refund amount applied to the credit memo after subtracting the total unapplied refund amount. This field is available in API version 68.0 and later.
This field is a calculated field.
- Type: reference
- Properties: Filter, Group, Sort, Update
- Description: Required. The ID of the user who owns a credit memo record.
This field is a polymorphic relationship field.
- Relationship Name: Owner
- Refers To: Group, User
- Type: picklist
- Properties: Filter, Group, Nillable, Sort
- Description: The reason code for the credit memo’s category. For example, BD can be the reason code when the credit memo’s category is
InvoiceWriteOffand the reason for the invoice write-off is bad debt. This field is available in API version 64.0 and later.
- Type: reference
- Properties: Filter, Group, Nillable, Sort, Update
- Description: The ID of the record that this credit memo was generated from. For example, the order, order summary, or invoice.
This field is a polymorphic relationship field.
- Relationship Name: ReferenceEntity
- Refers To: Invoice, Order
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The ID of the Saved Payment Method record that’s used for the credit memo. This field is available in API version 68.0 and later.
This field is a relationship field.
- Relationship Name: SavedPaymentMethod
- Refers To: SavedPaymentMethod
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Description: Specifies whether the credit memo amount was applied to an invoice or an invoice line.
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Description: Specifies which Salesforce API created the credit memo.
Valid values are Invoice, NegativeInvoiceLineConversion, Standalone, VoidPostedInvoice, or WriteOffPostedInvoice—Available in API version 64.0 and later.
- Type: picklist
- Properties: Filter, Group, Restricted picklist, Sort, Update
- Description: Required. The status of the credit memo.
Valid values are:
CanceledDraftErrorPendingPostedVoid In Progress—Available in API version 64.0 and later.Voided
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The sum of the
TotalAmountfield values for the credit memo’s adjustment lines.
This field is a calculated field.
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The sum of the credit memo’s adjustment line amounts, including tax. Available in API versions 62.0 and 63.0.
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The sum of the credit memo’s adjustment line tax. Adjustment line balances are excluded. Available in API versions 62.0 and 63.0.
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The sum of the credit memo’s
TotalLineAmountandTotalAdjustmentAmountfield values.
This field is a calculated field.
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The total credit memo amount, with tax included.
This field is a calculated field.
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The sum of the
TotalAmountfield values for the credit memo’s charge lines.
This field is a calculated field.
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The sum of the credit memo’s charge line amounts, including tax. Available in API versions 62.0 and 63.0.
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The sum of the credit memo’s charge tax amount. Available in API versions 62.0 and 63.0.
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The sum of the
TotalAmountfield values for the credit memo’s tax lines.
This field is a calculated field.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The total tax calculated at the transaction header level. Available in API version 66.0 and later.