Revenue Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Revenue Cloud Developer Resources
Product Catalog Management
Salesforce Pricing
Product Configurator
Transaction Management
Usage Management
Rate Management
Dynamic Revenue Orchestrator
Billing
Billing Standard Objects
AccountingPeriod
BillingBatchScheduler
BillingBatchFilterCriteria
BillingMilestonePlan
BillingMilestonePlanItem
BillingPeriodItem
BillingPolicy
BillingSchedule
BillingScheduleGroup
BillingTreatment
BillingTreatmentItem
BsgRelationship
CreditMemo
CreditMemoAddressGroup
CreditMemoInvApplication
CreditMemoLine
CreditMemoLineInvoiceLine
CreditMemoLineTax
GeneralLedgerAccount
GeneralLedgerAcctAsgntRule
InvBatchDraftToPostedRun
Invoice
InvoiceAddressGroup
InvoiceBatchRun
InvoiceBatchRunCriteria
InvoiceBatchRunRecovery
InvoiceDocument
InvoiceLine
InvoiceLineRelationship
InvoiceLineTax
LegalEntity
LegalEntyAccountingPeriod
PaymentBatchRun
PaymentLineInvoiceLine
PaymentSchedule
PaymentSchedulePolicy
PaymentScheduleTreatment
PaymentScheduleTreatmentDtl
PymtSchdDistributionMethod
PaymentScheduleItem
PaymentTerm
PaymentTermItem
RevenueTransactionErrorLog
TaxEngine
TaxEngineProvider
TaxPolicy
TaxTreatment
Billing Fields on Standard Objects
Salesforce Payments Objects in Billing
Billing Platform Events
Billing Standard Invocable Actions
Billing Business APIs
Billing Apex Reference
Billing Metadata API Types
Revenue Cloud Associated Objects
PDF

CreditMemoLine

Represents the product, service, adjustment, or tax line items included in a credit memo. This object is available in API version 62.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported Calls

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

Special Access Rules

You need the Credit Memo Operations User permission set to access this object.

Fields

Field Details
AdjustmentAmount
Type
currency
Properties
Filter, Nillable, Sort, Update
Description
The amount of this credit memo line item if its type is Adjustment.
AdjustmentAmountWithTax
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of the adjustment amount and the adjustment tax amount. Available in API versions 62.0 and 63.0.
AdjustmentTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount of the tax related to the adjustment amount. Available in API versions 62.0 and 63.0.
Balance
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount of the credit memo line available for allocation.
BillingAddressId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the billing address related to this credit memo line.
This field is a relationship field.
Relationship Name
BillingAddress
Refers To
CreditMemoAddressGroup
ChargeAmount
Type
currency
Properties
Filter, Nillable, Sort, Update
Description
The amount of this credit memo line item if its type is Charge.
ChargeAmountWithTax
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of the charge amount and the charge tax amount. Available in API versions 62.0 and 63.0.
ChargeTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount of the tax related to the charge amount. Available in API versions 62.0 and 63.0.
CorpCurrencyCnvChargeAmt
Type
double
Properties
Filter, Nillable, Sort, Update
Description
The amount of the credit memo line item if its type is Charge in corporate currency. Available in API version 63.0 and later.
CorpCurrencyCnvTotalTaxAmt
Type
double
Properties
Filter, Nillable, Sort, Update
Description
The sum of the total amount with the tax on the credit memo line in corporate currency. Available in API version 63.0 and later.
CorporateCurrencyCvsnDate
Type
date
Properties
Filter, Group, Nillable, Sort, Update
Description
The date on which the credit memo line amounts are converted to the corporate currency. Available in API version 63.0 and later.
CorporateCurrencyCvsnRate
Type
double
Properties
Filter, Nillable, Sort, Update
Description
The exchange rate that's used to convert the credit memo line amounts to the corporate currency. Available in API version 63.0 and later.
CorporateCurrencyIsoCode
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
The currency ISO code of the corporate currency. Available in API version 63.0 and later.
CreditMemoId
Type
reference
Properties
Filter, Group, Sort
Description
Required. The ID of the parent credit memo.
This field is a relationship field.
Relationship Name
CreditMemo
Relationship Type
Master-detail
Refers To
CreditMemo (the master object)
Description
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
Additional details about the credit memo line.
EndDate
Type
date
Properties
Filter, Group, Nillable, Sort, Update
Description
The description of the credit memo line.
LegalEntityAccountingPeriodId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The ID of the legal entity accounting period record of the credit memo line.
This field is a relationship field.
Relationship Name
LegalEntityAccountingPeriod
Refers To
LegalEntyAccountingPeriod
LegalEntityId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The ID of the legal entity record related to the credit memo line.
This field is a relationship field.
Relationship Name
LegalEntity
Refers To
LegalEntity
LineAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount of the credit memo line.
This field is a calculated field.
Name
Type
string
Properties
Filter, Group, idLookup, Sort, Update
Description
Required. The name of the credit memo line.
NetCreditsApplied
Type
currency
Properties
Filter, Nillable, Sort
Description
The total amount applied to invoice lines from the credit memo. This amount is calculated by subtracting the total unapplied credit amount from the total applied credit amount.
This field is a calculated field.
Product2Id
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The ID of the product or service being credited in the credit memo line.
This field is a relationship field.
Relationship Name
Product2
Refers To
Product2
ReferenceEntityItemId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The order product or invoice line corresponding to this credit memo line.
This field is a polymorphic relationship field.
Relationship Name
ReferenceEntityItem
Refers To
InvoiceLine, OrderItem
ReferenceEntityItemType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type of transaction that generated the credit memo line.
Valid values are:
  • Delivery Charge
  • Fee
  • Order Product
ReferenceEntityItemTypeCode
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type of object that generated the credit memo line.
Valid values are:
  • Charge
  • Product
ShipFromAddressId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The address from which the product in the credit memo line is shipped. Available in API version 64.0 and later.
This field is a relationship field.
Relationship Name
ShipFromAddress
Refers To
CreditMemoAddressGroup
ShippingAddressId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the shipping address.
This field is a relationship field.
Relationship Name
ShippingAddress
Refers To
CreditMemoAddressGroup
StartDate
Type
date
Properties
Filter, Group, Nillable, Sort, Update
Description
The first date of the billing for the service for credit memo lines generated from a time-based service.
Status
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The status of the credit memo line. This field is inherited from the credit memo.
TaxAmount
Type
currency
Properties
Filter, Nillable, Sort, Update
Description
The total tax amount for the credit memo.
TaxTreatmentId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the tax treatment record for the credit memo line.
This field is a relationship field.
Relationship Name
TaxTreatment
Refers To
TaxTreatment