Newer Version Available

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

ProcessException

Represents a processing failure on an order summary. A separate process is required to resolve the failure that caused the process exception before order summary processing can continue. This object is available in API version 50.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AttachedToId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
ID of the object associated with the ProcessException.
This is a polymorphic relationship field.
Relationship Name
AttachedTo
Relationship Type
Lookup
Refers To
CreditMemo, Invoice, Order, OrderItem, Payment, PaymentAuthorization, Refund, ReturnOrder
CaseId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the case associated with the ProcessException.
This is a relationship field.
Relationship Name
Case
Relationship Type
Lookup
Refers To
Case
Category
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
ProcessingException type. You can customize the category picklist to represent your business processes.
Possible values are:
  • Fulfillment
  • Invoicing
  • Order Activation
  • Order Approval
  • Payment
Description
Type
textarea
Properties
Create, Nillable, Update
Description
Detailed description of the ProcessException.
ExternalReference
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Description of external entities associated with the ProcessException.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Timestamp for when the current user last viewed this record. A null value can mean that this record has only been referenced (LastReferencedDate) and not viewed.
Message
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Short description of the ProcessException
OrderSummaryId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the OrderSummary associated with the ProcessException. The ProcessException component is displayed on this OrderSummary.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the User who currently owns this ProcessException. Default value is the User logged in to the API to perform the create.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
Priority
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Resolution priority for the ProcessException. You can customize the priority picklist to represent your business processes.
Possible values are:
  • High
  • Low
ProcessExceptionNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The unique name of the ProcessException, formatted as PE-(00000000).
Severity
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Severity of the ProcessException. Each severity value corresponds to one severity category. You can customize the severity picklist to represent your business processes. If you customize the severity picklist, include at least one severity value for each severity category.
Possible values are:
  • High
  • Low
SeverityCategory
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Severity category of the ProcessException. Each severity category corresponds to one or more severity values. The severity category is used to show the severity icon in the ProcessException list view.
Possible values are:
  • High
  • Low
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Status of the ProcessException. Each status corresponds to one status category, shown here in parentheses. You can customize the status picklist to represent your business processes. If you customize the status picklist, include at least one status value for each status category.
Possible values are:
  • Ignored (Inactive)
  • New (Active)
  • Paused (Inactive)
  • Resolved (Resolved)
  • Triaged (Active)
  • Voided (Inactive)
StatusCategory
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Status category of the ProcessException. Each status category corresponds to one or more statuses.
Possible values are:
  • ACTIVE
  • INACTIVE
  • RESOLVED

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.
ProcessExceptionOwnerSharingRule
Sharing rules are available for the object.
ProcessExceptionShare
Sharing is available for the object.