Interface LineItemStateTransitionMessage

Generated after a successful Transition LineItem State update action.

interface LineItemStateTransitionMessage {
    createdAt: string;
    createdBy?: CreatedBy;
    fromState: StateReference;
    id: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    lineItemId: string;
    lineItemKey?: string;
    quantity: number;
    resource: Reference;
    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
    resourceVersion: number;
    sequenceNumber: number;
    toState: StateReference;
    transitionDate: string;
    type: "LineItemStateTransition";
    version: number;
}

Properties

createdAt createdBy? fromState id lastModifiedAt lastModifiedBy? lineItemId lineItemKey? quantity resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber toState transitionDate type version

Properties

Readonly createdAt

createdAt: string

Date and time (UTC) the Message was generated.

Optional Readonly createdBy

createdBy?: CreatedBy

IDs and references that created the Message.

Readonly fromState

fromState: StateReference

State the Line Item was transitioned from.

Readonly id

id: string

Unique identifier of the Message. Can be used to track which Messages have been processed.

Readonly lastModifiedAt

lastModifiedAt: string

Value of createdAt.

Optional Readonly lastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the Message.

Readonly lineItemId

lineItemId: string

Unique identifier of the Line Item.

Optional Readonly lineItemKey

lineItemKey?: string

User-defined unique identifier of the LineItem.

Readonly quantity

quantity: number

Number of Line Items for which the State was transitioned.

Readonly resource

resource: Reference

Reference to the resource on which the change or action was performed.

Optional Readonly resourceUserProvidedIdentifiers

resourceUserProvidedIdentifiers?: UserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

Readonly resourceVersion

resourceVersion: number

Version of the resource on which the change or action was performed.

Readonly sequenceNumber

sequenceNumber: number

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

Readonly toState

toState: StateReference

State the Line Item was transitioned to.

Readonly transitionDate

transitionDate: string

Date and time (UTC) the transition of the Line Item State was performed.

Readonly type

type: "LineItemStateTransition"

Readonly version

version: number

Version of a resource. In case of Messages, this is always 1.

Settings

Member Visibility

Theme

On This Page

createdAtcreatedByfromStateidlastModifiedAtlastModifiedBylineItemIdlineItemKeyquantityresourceresourceUserProvidedIdentifiersresourceVersionsequenceNumbertoStatetransitionDatetypeversion