NegInvcLineProcessedEvent

Notifies subscribers when a negative invoice line is converted to a credit memo. This object is available in API version 56.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

Subscriber	Supported?
Apex Triggers
Flows
Processes
Pub/Sub API
Streaming API (CometD)

Subscription Channel

/event/NegInvcLineProcessedEvent

Event Delivery Allocation Enforced

Special Access Rules

This object is available when Subscription Management is enabled.

Fields

CorrelationIdentifier

Type: string

Properties: Nillable

Description: Reserved for future use.

CrMemoProcessErrDtlEvents

Type: CrMemoProcessErrDtlEvent

Properties: Nillable

Description: Contains a list of error messages and error codes if the request failed. This field is available only in API versions 55.0–58.0. See the ErrorDetails field for error messages and error codes.

CreditMemoId

Type: reference

Properties: Nillable

Description: The ID of the credit memo created as a result of the successful conversion of a negative invoice line. This field is a relationship field.

Relationship Name: CreditMemo

Relationship Type: Lookup

Refers To: CreditMemo

ErrorDetails

Type: string

Properties: Nillable

Description: If the request fails, this field shows error messages, error codes, and the ID of the record on which the errors occurred. This field is available in API 58.0 and later.

EventUuid

Type: string

Properties: Nillable

Description: A universally unique identifier (UUID) that identifies a platform event message.

InvoiceId

Type: reference

Properties: Nillable

Description: ID of the invoice that this event is in reference to. This field is a relationship field.

Relationship Name: Invoice

Relationship Type: Lookup

Refers To: Invoice

IsAutomatedNegativeInvoiceLineConversion

Type: boolean

Properties: Defaulted on create

Description: Indicates whether this event is generated either by an automated process to convert negative invoice lines to credit memos or by a manual process. If true, the event was generated by an automatic process. If false, the event was generated by a manual process.

IsSuccess

Type: boolean

Properties: Defaulted on create

Description: Indicates that the negative invoice lines were converted successfully to credit memos. The default value is false.

ReplayId

Type: string

Properties: Nillable

Description: Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.

RequestIdentifier

Type: string

Properties: Nillable

Description: This field is always empty.

Example

A user successfully submits a negative invoice line, which creates one credit memo, and generates this platform event when the request completes.

1{
2  CrMemoProcessErrDtlEvents: null
3  CreatedById: "005xx000001X8efAAC"
4  CreatedDate: "2022-08-11T16:44:34.652Z"
5  CreditMemoId: "50gxx000000gwFyAAI"
6  ErrorDetails:."[]"
7..InvoiceId: "3ttxx0000001Vg5AAE"
8  IsSuccess: true
9  RequestIdentifier: null