CreditMemoLine

Represents product, service, adjustment, or tax line items that were included in a credit memo.

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: Create, Filter, Nillable, Sort, Update
  • Description: Amount of this credit memo line item if its type is Adjustment.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Sum of the adjustment amount and the adjustment tax amount. This field is available when Subscription Management is enabled.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Amount of the tax related to the adjustment amount. This field is available when Subscription Management is enabled.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 62.0

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 55.0

  • Description:

    ID of the billing address related to this credit memo line.

    This field is a relationship field. This field is available when Subscription Management is enabled.

  • Relationship name: BillingAddress

  • Relationship type: relationship

  • Refers to: CreditMemoAddressGroup

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Amount of this credit memo line item if its type is Charge.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Sum of the adjustment amount and the adjustment tax amount. This field is available when Subscription Management is enabled.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Amount of the tax related to the charge amount. This field is available when Subscription Management is enabled.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 65.0
  • Type: double
  • Properties: Filter, Nillable, Sort, Update
  • Introduced: API version 63.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: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    ID of the parent credit memo.

    This field is a relationship field.

  • Relationship name: CreditMemo

  • Relationship type: masterdetail

  • Refers to: CreditMemo

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Description of the credit memo line.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: For credit memos made from a time-based service, the end date of the line item being credited.
  • Type: double
  • Properties: Filter, Nillable, Sort, Update
  • Introduced: API version 66.0
  • 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: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 49.0

  • Type: reference

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

  • Introduced: API version 62.0

  • Relationship name: LegalEntityAccountingPeriod

  • Relationship type: relationship

  • Refers to: LegalEntyAccountingPeriod

  • Type: reference

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

  • Introduced: API version 62.0

  • Relationship name: LegalEntity

  • Relationship type: relationship

  • Refers to: LegalEntity

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 49.0

  • Description:

    Amount of the credit memo line.

    This field is a calculated field.

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the credit memo line.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 62.0

  • Type: reference

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

  • Description:

    The product or service being credited in the credit memo line.

    This field is a relationship field.

  • Relationship name: Product2

  • Relationship type: relationship

  • Refers to: Product2

  • Type: reference

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

  • Introduced: API version 48.0

  • Description:

    The order product or invoice line corresponding to this credit memo line.

    This field is a polymorphic relationship field.

  • Relationship name: ReferenceEntityItem

  • Relationship type: polymorphic

  • Refers to: InvoiceLine, OrderItem, OrderItemSummary

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The type of transaction that generated the credit memo line.
  • Possible values:
    • DeliveryCharge — DeliveryCharge
    • OrderProduct — OrderProduct
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The type of object that generated the credit memo line.
  • Possible values:
    • Charge — Charge
    • Product — Product

  • Type: reference

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

  • Description:

    The credit memo line related to this line item.

    This field is a relationship field.

  • Relationship name: RelatedLine

  • Relationship type: relationship

  • Refers to: CreditMemoLine

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 64.0

  • Relationship name: ShipFromAddress

  • Relationship type: relationship

  • Refers to: CreditMemoAddressGroup

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 55.0

  • Description:

    The ID of the shipping address.

    This field is a relationship field. This field is available when Subscription Management is enabled.

  • Relationship name: ShippingAddress

  • Relationship type: relationship

  • Refers to: CreditMemoAddressGroup

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: For credit memo lines generated from a time-based service, the first date of the billing for the service.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: State of the credit memo line. Inherited from the credit memo.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total tax for the credit memo.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The code used to calculate the tax rate for the invoice line.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 55.0
  • Description: The document number that tracks taxes calculated for this credit memo line. This field is available when Subscription Management is enabled.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date used to calculate the credit memo line’s TaxAmount.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: User-defined name for applied tax.
  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Percentage value used for calculating tax.

  • Type: picklist

  • Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

  • Introduced: API version 54.0

  • Description:

    Tracks whether the taxes were calculated for this credit memo line.

    The default value is None. This field is available when Subscription Management is enabled.

  • Possible values:

    • Complete — Complete
    • Error — Error
    • None — None
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 55.0
  • Description: Tracks the transaction number of the tax calculated for this credit memo line. This field is available when Subscription Management is enabled.

  • Type: reference

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

  • Introduced: API version 55.0

  • Description:

    The ID of the tax treatment for the credit memo line.

    This field is a relationship field. This field is available when Subscription Management is enabled.

  • Relationship name: TaxTreatment

  • Relationship type: relationship

  • Refers to: TaxTreatment

  • Type: picklist
  • Properties: Filter, Group, Restricted picklist, Sort
  • Description: The type of transaction for the invoice line.
  • Possible values:
    • Adjustment — Adjustment
    • Charge — Charge
    • Tax — Tax

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.