CreditMemo

Represents a document that is used to reduce the amount that a buyer owes a seller under the terms of an earlier invoice.

A credit memo always decreases the balance of an invoice. Users can apply positive credit memos to positive invoices, for example, a $10 credit memo reduces the balance of a $100 invoice line to $90.

Introduced in API version 48.0.

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

  • This object is available with Order Management, Subscription Management, and Billing (Revenue Cloud).
  • For information about this object that’s available with Billing (Revenue Cloud), including its special access rules, see the Revenue Cloud Developer Guide.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Amount of the credit memo that’s available for allocation.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    Inherited from the account’s Bill to Account field.

    This field is a relationship field.

  • Relationship name: BillToContact

  • Relationship type: relationship

  • Refers to: Contact

  • Type: reference

  • Properties: Filter, Group, Sort, Update

  • Description:

    The customer account associated with this credit memo.

    This field is a relationship field.

  • Relationship name: BillingAccount

  • Relationship type: relationship

  • Refers to: Account

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort

  • Introduced: API version 66.0

  • Relationship name: BillingProfile

  • Relationship type: relationship

  • Refers to: BillingAccount

  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 64.0
  • Type: double
  • Properties: Filter, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Type: date
  • Properties: Filter, Group, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Type: double
  • Properties: Filter, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Type: string
  • Properties: Filter, Group, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 54.0
  • Description: Indicates whether the credit memo originated in Salesforce or an external system.
  • Possible values:
    • External — External
    • Salesforce — Salesforce
  • Type: date
  • Properties: Filter, Group, Nillable, Sort
  • Description: The date when the credit memo was posted.
  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 68.0
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Description: A credit memo numbering alternative to DocumentNumber, containing a number in a format of your choice. Credit memo numbering is optional.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Description of the credit memo.
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: System-generated number for organizing financial documents, for example DOC-0000123.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 53.0
  • Description: Represents 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: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 54.0
  • Description: Contains an external system’s ID for the credit memo.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 54.0
  • Description: Contains the name of the external system that also contains the credit memo.
  • Type: double
  • Properties: Filter, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Type: date
  • Properties: Filter, Group, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Type: double
  • Properties: Filter, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Type: string
  • Properties: Filter, Group, Nillable, Sort, Update
  • Introduced: API version 66.0

  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Introduced: API version 68.0

  • Default value: false

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 65.0

  • Relationship name: LegalEntityAccountingPeriod

  • Relationship type: relationship

  • Refers to: LegalEntyAccountingPeriod

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 65.0

  • Relationship name: LegalEntity

  • Relationship type: relationship

  • Refers to: LegalEntity

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 53.0

  • Description:

    Represents the total difference between the credit applied to and credit unapplied from the invoice.

    This field is a calculated field.

  • Type: picklist
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 64.0

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 48.0

  • 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

  • Relationship type: polymorphic

  • Refers to: Invoice, Order, OrderSummary

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 68.0

  • Relationship name: SavedPaymentMethod

  • Relationship type: relationship

  • Refers to: SavedPaymentMethod

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 66.0

  • Relationship name: SequencePolicy

  • Relationship type: relationship

  • Refers to: SequencePolicy

  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 62.0
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 55.0
  • Description: Indicates which Salesforce API created the credit memo.
  • Possible values:
    • Invoice — Invoice — Indicates that Credit Invoice API created the credit memo and applied it to the invoice.
    • NegativeInvoiceLineConversion — NegativeInvoiceLineConversion — Indicates that Subscription Management created the credit memo when a negative invoice line was converted.
    • Standalone — Standalone — Indicates that the Credit Memo API created the credit memo.
    • VoidPostedInvoice — VoidPostedInvoice — Indicates that the Void a Posted Invoice API created the credit memo to offset the amount that was voided on the invoice.
  • Type: picklist
  • Properties: Filter, Group, Restricted picklist, Sort, Update
  • Description: Status of the credit memo.
  • Possible values:
    • Canceled — Canceled — Indicates that the credit memo isn’t being used and doesn’t have a financial impact.
    • Error — Error — Indicates that the credit memo has an error and doesn’t have a financial impact.
    • Pending — Pending — Indicates that the credit memo is being processed but hasn’t yet been posted as a financial transaction.
    • Posted — Posted — The credit memo has been recorded as a financial transaction. Most fields can’t be edited.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 49.0

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description:

    Sum of TotalAmount values for the credit memo’s adjustment lines.

    This field is a calculated field.

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: The sum of the credit memo’s adjustment line amounts, including tax.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: The sum of the credit memo’s adjustment line tax. Adjustment line balances are excluded.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description:

    Sum of the credit memo’s TotalLineAmount and TotalAdjustmentAmount.

    This field is a calculated field.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description:

    Total credit memo amount, with tax included.

    This field is a calculated field.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description:

    Sum of TotalAmount values for the credit memo’s charge lines.

    This field is a calculated field.

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: The sum of the credit memo’s charge line amounts, including tax.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 53.0
  • Description: Credit memo amount that’s been applied to invoices.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 53.0
  • Description: Credit memo amount that’s been unapplied from invoices.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description:

    Sum of TotalAmount values for the credit memo’s tax lines.

    This field is a calculated field.

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 66.0

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.