AdjustmentAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort, Update
- Description
- Amount of this credit memo line item if its type is Adjustment.
|
AdjustmentAmountWithTax |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Sum of the adjustment amount and the adjustment tax amount.
- This field is available in API version 49.0 and later. This field is
available when Subscription Management is enabled.
|
AdjustmentTaxAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Amount of the tax related to the adjustment amount.
- This field is available in API version 55.0 and later. This field is
available when Subscription Management is enabled.
|
BillingAddressId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- ID of the billing address related to this credit memo line.
- This field is a relationship field. This field is available in API version
55.0 and later. This field is available when Subscription Management is
enabled.
- Relationship Name
- BillingAddress
- Relationship Type
- Lookup
- Refers To
- CreditMemoAddressGroup
|
ChargeAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort, Update
- Description
- Amount of this credit memo line item if its type is Charge.
|
ChargeAmountWithTax |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Sum of the adjustment amount and the adjustment tax amount.
- This field is available in API version 55.0 and later. This field is
available when Subscription Management is enabled.
|
ChargeTaxAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Amount of the tax related to the charge amount.
- This field is available in API version 55.0 and later. This field is
available when Subscription Management is enabled.
|
CreditMemoId
|
- Type
- reference
- Properties
- Filter, Group, Sort
- Description
- ID of the parent credit memo.
- This field is a relationship field.
- Relationship Name
- CreditMemo
- Relationship Type
- Lookup
- Refers To
- CreditMemo
|
CurrencyIsoCode |
- Type
- picklist
- Properties
- Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort,
Update
- Description
- Three-letter ISO 4217 currency code associated with the credit memo
line.
- The default value is USD.
|
Description
|
- Type
- string
- Properties
- Filter, Group, Nillable, Sort, Update
- Description
- Description of the credit memo line.
|
EndDate
|
- Type
- date
- Properties
- Filter, Group, Nillable, Sort, Update
- Description
- For credit memos made from a time-based service, the end date of the line
item being credited.
|
LineAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Amount of the credit memo line.
- This field is a calculated field. This field is available in API version
49.0 and later.
|
Name
|
- Type
- string
- Properties
- Filter, Group, idLookup, Sort, Update
- Description
- Name of the credit memo line.
|
Product2Id
|
- Type
- reference
- Properties
- 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
- Lookup
- 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. This field is available in
API version 53.0 and later.
- Relationship Name
- ReferenceEntityItem
- Relationship Type
- Lookup
- Refers To
- OrderItemSummary, OrderProduct, InvoiceLine
|
ReferenceEntityItemType
|
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description
- The type of transaction that generated the credit memo line.
- Possible values are:
- DeliveryCharge
- OrderProduct
|
ReferenceEntityItemTypeCode
|
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description
- The type of object that generated the credit memo line.
- Possible values are:
|
RelatedLineId
|
- Type
- reference
- Properties
- 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
- Lookup
- Refers To
- CreditMemoLine
|
ShippingAddressId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the shipping address.
- This field is a relationship field. This field is available in API version
55.0 and later. This field is available when Subscription Management is
enabled.
- Relationship Name
- ShippingAddress
- Relationship Type
- Lookup
- Refers To
- CreditMemoAddressGroup
|
StartDate
|
- Type
- date
- Properties
- 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.
|
Status
|
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- State of the credit memo line. Inherited from the credit memo.
|
TaxAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort, Update
- Description
- Total tax for the credit memo.
|
TaxCode
|
- Type
- string
- Properties
- Filter, Group, Nillable, Sort, Update
- Description
- The code used to calculate the tax rate for the invoice line.
|
TaxDocumentNumber |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The document number that tracks taxes calculated for this credit memo
line.
- This field is available in API version 55.0 and later. This field is
available when Subscription Management is enabled.
|
TaxEffectiveDate
|
- Type
- date
- Properties
- Filter, Group, Nillable, Sort, Update
- Description
- The date used to calculate the credit memo line’s
TaxAmount.
|
TaxName
|
- Type
- string
- Properties
- Filter, Group, Nillable, Sort, Update
- Description
- User-defined name for applied tax.
|
TaxRate
|
- Type
- percent
- Properties
- Filter, Nillable, Sort, Update
- Description
- Percentage value used for calculating tax.
|
TotalAmount
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The total amount of the credit memo line before any applicable tax.
|
TotalAmountWithTax
|
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Total amount of tax for this credit memo line, with tax included. Sum of
TotalAmount and TaxAmount.
|
TaxStatus |
- Type
- picklist
- Properties
- Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Tracks whether the taxes were calculated for this credit memo line.
- Possible values are:
- The default value is None. This field is available in API version 55.0 and
later. This field is available when Subscription Management is enabled.
|
TaxTransactionNumber |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Tracks the transaction number of the tax calculated for this credit memo
line. This field is available in API version 55.0 and later. This field is
available when Subscription Management is enabled.
|
TaxTreatmentId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the tax treatment for the credit memo line.
- This field is a relationship field. This field is available in API version
55.0 and later. This field is available when Subscription Management is
enabled.
- Relationship Name
- TaxTreatment
- Relationship Type
- Lookup
- Refers To
- TaxTreatment
|
Type
|
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- Description
- The type of transaction for the invoice line.
- Possible values are:
|