InvoiceProcessedDetailEvent

Represents the notification to customers regarding the results of an attempt to create an invoice from billing schedules as part of /commerce/billing/invoices request. The InvoiceProcessedDetailEvent platform event contains the results of an attempt to create an invoice from one or more billing schedules that share a grouping key. Each InvoiceProcessedDetailEvent platform event for an action is grouped within the parent InvoiceProcessedDetailEvent platform event. This object is available in API version 62.0 and later.

Supported Calls 

describeSObjects()

Supported Subscribers 

SubscriberSupported?
Apex TriggersYes
FlowsYes
ProcessesYes
Pub/Sub APIYes
Streaming API (CometD)Yes

Subscription Channel 

/event/InvoiceProcessedEvent.

Event Delivery Allocation Enforced 

No

Special Access Rules 

This object is available when Billing is enabled.

Fields 

EventUuid 

  • Type: string
  • Properties: Nillable
  • Description: A universally unique identifier (UUID) that identifies a platform event message.

InvoiceErrorDetailEvents 

  • Type: InvoiceErrorDetailEvent[]
  • Properties: Nillable
  • Description: A list of errors that occurred while attempting to create the invoice.

InvoiceId 

  • Type: reference
  • Properties: Nillable
  • Description: The ID of the new invoice.

This field is a relationship field.

  • Relationship Name: Invoice
  • Refers To: Invoice

InvoiceStatus 

  • Type: string
  • Properties: Nillable
  • Description: The value of the Status field on the invoice.

IsSuccess 

  • Type: boolean
  • Properties: Defaulted on create
  • Description: Required. Indicates whether the invoice creation attempt was successful (true) or not (false).

The default value is false.