Newer Version Available

This content describes an older version of this product. View Latest

RevenueTransactionErrorLog

Contains information about errors that occurred while processing subscription management requests. This object is available in API version 55.0 and later.
A revenue transaction error log provides information about errors that occur when a user interacts with the related primary record. For example, if an error occurs when a user tries to create an invoice from an order, Subscription Management creates a revenue transaction error log related to the order. The revenue transaction error log’s category indicates the action being taken when the error occurred. For example, if the error’s category is InitiateCancel, the error occurred when the user was creating a cancellation order.

A revenue transaction error log persists until another error with the same category, primary record, and (optionally) related record occurs. You can see revenue transaction error log records in Salesforce Lightning as related records on their primary record. Or, you can use a SOQL query.

Supported Calls

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

Special Access Rules

This object is available with Subscription Management.

Fields

Field Details
Category
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
If an error occurs during the processing of a request, the request uses this field to provide context about the type of error. For example, if an error occurs while processing an OrderToInvoice request, the OrderToInvoice request sets the category to OrderToInvoice.
Possible values are:
  • ApplyAPI
  • ConvertNegativeInvoiceLineToCredit—available in API version 56.0 and later.
  • Core Invoice Generation Failure
  • CreditInvoiceAPI
  • CreditTaxIntegrationAPI
  • InitiateAmendment—available in API version 56.0 and later.
  • InitiateCancel
  • InitiateRenewal
  • InsufficientAccess—Insufficient Access to start Invoice run
  • InvoiceBatchRun
  • InvoiceBatchRunInvoiceGeneration
  • InvoiceBatchRunPostProcessor
  • InvoiceBatchRunPreProcessor
  • InvoiceBatchRunRecovery
  • InvoiceBatchRunSelectionStep
  • InvoiceBatchRunSummarizer
  • InvoiceBatchRunTaxProcessor
  • Invalid Tax API Input
  • Invalid Tax Integration Input
  • OrderToAsset
  • OrderToBillingSchedule
  • OrderToInvoice
  • PaymentSale
  • PaymentScheduleGeneration—available in API version 56.0 and later.
  • QuoteToOrder—available in API version 56.0 and later.
  • Post Tax API Failure
  • Post-Credit Tax Failure
  • Pre-Credit Tax Failure
  • StandaloneCreditAPI
  • Tax API Failure
  • Unknown Failure—available in API version 56.0 and later.
  • VoidPostedInvoiceAPI
ErrorCode
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The error code; for example, INVALID_INPUT.
ErrorLogNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
An auto generated unique ID that identifies the error.
ErrorMessage
Type
textarea
Properties
filter, Group, Nillable, Sort
Description
Contains information about the error and how to resolve it.
OwnerId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the user who made the request that resulted in the creation of the error log.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PrimaryRecordId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the record that’s associated with this error. For example, if the error occurred during a OrderToInvoice request, the primary ID is the ID of the order.
This is a polymorphic relationship field.
Relationship Name
PrimaryRecord
Relationship Type
Lookup
Refers To
Asset, BillingBatchScheduler, BillingSchedule, CardPaymentMethod, CreditMemo, Invoice, InvoiceBatchRun, InvoiceBatchRunRecovery, Order, PaymentBatchRun, PaymentGateway, Quote
RelatedRecordId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Optional. The ID of a record that can provide additional context about the error. For example, if PrimaryRecordId is the ID of an order, this field could be the ID of an order item.
This is a polymorphic relationship field.
Relationship Name
RelatedRecord
Relationship Type
Lookup
Refers To
BillingBatchScheduler, BillingSchedule, BillingScheduleGroup, CreditMemo, CreditMemoLine, Invoice, InvoiceLine, OrderItem, PaymentSchedule, PaymentScheduleItem, QuoteLineItem