Simphony JavaScript Extensibility

JavaScript Extensibility Check Details

The check header and the check details are provided for both OPS and STS in the arguments of the SubmitCheckEvent event.

In addition OPS provides the same as part of its context, which is not tight to any event.

Each check detail uses CheckDetailItem as the base class and inherits the properties and method from this base class. The property DetailType can be used to understand the type of the check detail.

CheckHeader

AddExtensibilityData( ExtensibilityDataInfo info )

Description

Adds an ExtensibilityDataInfo to the Check Header

Return Value

bool

RemoveExtensibilityData( ExtensibilityDataDetail item )

Description

Removes the ExtensibilityDataDetail provided from the Check Header

Return Value

bool

Description

Gets the Discount Total for the Menu Item Detail based on the Detail Link

Return Value

decimal

Description

Gets the Extensibility Check Detail Object based on the Detail Link

Return Value

CheckDetailItem

Description

Gets the Extensibility Check Detail as Scriptable, which will help with JavaScript based iteration

Return Value

Object

Description

Gets the Core Check Detail. Should not be used and only present for backwards compatibility

Return Value

CheckDetailItem

GetFlattenedCheckDetail()

Description

Returns a 'flat' list of check details rather than the hierarchy model

Return Value

IEnumerator`1

RevCtrID

Description

RVC ID of the check

Return Value

RevCtrID

CheckNumber

Description

The Check Number assigned to this Check

Return Value

int

RoundNumber

Description

The current Round Number

Return Value

int

Guid

Description

THe GUID assigned to this Check

Return Value

string

Covers

Description

Number of Covers

Return Value

int

DiningTableID

Description

Dining Table ID

Return Value

int

EmployeeID

Description

Employee ID of the Check Owner

Return Value

long

CashierID

Description

Cashier ID

Return Value

int

WorkstationID

Description

Current Workstation ID

Return Value

int

AutofireWorkstationID

Description

Workstation ID that will Auto Fire this Check

Return Value

int

CheckOpenTime

Description

Date/Time this Check was opened

Return Value

DateTime

TableOpenTime

Description

Date/Time this Table was opened or assigned

Return Value

DateTime

CheckCloseTime

Description

Date/Time this Check was closed, only valid for Closed Checks

Return Value

DateTime

FirstPrintTime

Description

Date/Time this Check was first printed

Return Value

DateTime

FirePrintTime

Description

Date/Time this Check was first printed

Return Value

DateTime

TimeToFire

Description

Date/Time when an Auto Fire Check is scheduled to fire, only valid before the Check is fired

Return Value

DateTime

ActualTimeOfFire

Description

Date/Time when an Auto Fire Check was actually fired, only valid after the Check was fired

Return Value

DateTime

AutofireRevCtrID

Description

RVC ID of the Auto Fire Check

Return Value

int

AddedToRevCtrID

Description

RVC ID of the destination Check

Return Value

int

SplitFromRevCtrID

Description

RVC ID of the source Split Check

Return Value

int

AddedToCheckNum

Description

Check Number of the destination Added Check

Return Value

int

SplitFromCheckNum

Description

Check Number of the source Split Check

Return Value

int

ReopenedFromCheckNum

Description

Original Check Number before Reopen

Return Value

int

ReopenedToCheckNum

Description

New Check Number after Reopen

Return Value

int

Status

Description

Check Status as String

Return Value

string

StatusBytes

Description

Check Status as Byte Array

Return Value

Byte[]

ItemsOnHold

Description

Indicates if Items are On Hold

Return Value

bool

DoNotPostTtl

Return Value

bool

ChkOwnerOverride

Description

Indicates if Check Owner was Overriden

Return Value

bool

ChkCreatedOffline

Description

Indicates if Check was created Offline

Return Value

bool

ChkClosedOffline

Description

Indicates if Check was closed Offline

Return Value

bool

ChkPwrCycled

Return Value

bool

ChkLocked

Description

Indicates if Check is Locked

Return Value

bool

PartyChk

Description

Indicates if Party Check

Return Value

bool

SvcAuthPending

Return Value

bool

ChkSvcTtled

Description

Indicates if Check was Service Totaled

Return Value

bool

ChkUnassigned

Return Value

bool

ChkVip

Description

Indicates if VIP Check

Return Value

bool

SplitCheckAdded

Description

Indicates if Split Check was Added

Return Value

bool

Simphony2Check

Return Value

bool

InsertAfterLastPaid

Return Value

bool

SumTtlsPrinted

Description

Indicates if Summary Totals were printed

Return Value

bool

ChkCancelled

Description

Indicates if Check was Cancelled

Return Value

bool

ChkSplitXfer

Description

Indicates if Split Check was transferred

Return Value

bool

ChkAddXfer

Description

Indicates if Add Check was transferred

Return Value

bool

CaOutstanding

Return Value

bool

Training

Description

Indicates if Check is in Training

Return Value

bool

OpnOnSysOverride

Return Value

bool

AutoServiceChargeActive

Description

Indicates if Auto Service Charge is active

Return Value

bool

TmsNewChk

Return Value

bool

BegunAsFastTransaction

Description

Indicates if Check was begun as Fast Transaction

Return Value

bool

ClosedChkAdj

Description

Indicates if Closed Check was Adjusted

Return Value

bool

JapanThreshActive

Description

Indicates if Japanese Threshold is Active

Return Value

bool

CoverKey

Return Value

bool

AuthPending

Return Value

bool

AutoSvcTurnedOff

Description

Indicates if Auto Service Charge is turned off

Return Value

bool

ClosedCheckVoid

Description

Indicates if Void Closed Check

Return Value

bool

ClosedCheckReprint

Description

Indicates if Closed Check was Reprinted

Return Value

bool

Reprocess

Return Value

bool

MergedCheckNotPrinted

Return Value

bool

CheckWasReOpened

Description

Indicates if Closed Check was Reopened

Return Value

bool

SuspendedCheck

Description

Indicates if Closed Check was Suspended

Return Value

bool

PrintedWithSrmDisabled

Return Value

bool

AutomaticDiscountsDisabled

Description

Indicates if Automatic Discounts are Disabled

Return Value

bool

ServingPeriodID

Description

ID of the active Serving Period

Return Value

int

GroupNum

Description

Table Group Number

Return Value

int

OrdTypeID

Description

OrdTypeID object of the Check Order Type. Use Value to obtain ID

Return Value

OrdTypeID

TransactionOrdTypeID

Description

OrdTypeID object of the Transaction Order Type. Use Value to obtain ID

Return Value

OrdTypeID

AddedIn

Description

Number of Checks added in

Return Value

int

SplitOut

Description

Number of Checks split out

Return Value

int

PrintCount

Description

Number of Printed Checks

Return Value

int

AlternateID

Description

Guest Check ID as entered

Return Value

string

SubTotal

Description

Sub-Total, exclunding any Service-Charges

Return Value

decimal

Tax

Description

Add-On Tax Total

Return Value

decimal

CheckInclusiveTaxTotal

Description

Check Inclusive Tax Total (not VAT)

Return Value

decimal

ItemInclusiveTaxTotal

Description

Item Inclusive Tax Total (not VAT)

Return Value

decimal

InclusiveTaxExemptTotal

Description

Check Exempted Inclusive Tax Total (not VAT)

Return Value

decimal

AutoServiceCharge

Description

Check Auto Service Charge Total

Return Value

decimal

Other

Description

Check Service Charge Total

Return Value

decimal

Payment

Description

Check Payment Total

Return Value

decimal

TotalDue

Description

Check Total Due

Return Value

decimal

LastWorkstationID

Description

Last used Workstation ID

Return Value

int

LangID

Description

Current Language ID

Return Value

int

CloseStatus

Description

Indicates if Check was Closed

Return Value

bool

RoundingTotal

Description

Check Rounding Total

Return Value

decimal

CheckInformation

Description

List of Check based Check Information

Return Value

ExtensibilityDetailArray`1

GuestInformation

Return Value

ExtensibilityDetailArray`1

TeamActive

Description

Indicates if Team Check

Return Value

bool

TeamIdentifier

Description

Team Object Number

Return Value

int

TeamName

Description

Team Name

Return Value

string

TeamMembers

Description

List of TeamMember objects

Return Value

TeamMember[]

TaxData

Description

CheckTaxData object providing Check based Tax information

Return Value

CheckTaxData

TaxDataBySalesItemizer

Return Value

CheckTaxDataBySalesItemizer

CustomerDetails

Return Value

Customer

OrderStatusID

Return Value

int

ExtensibilityDetail

Description

List of Check based ExtensibilityDetail Information

Return Value

CheckExtensibilityDetail

CheckDetailItem

AddExtensibilityData( ExtensibilityDataInfo info )

Return Value

bool

RemoveExtensibilityData( ExtensibilityDataDetail item )

Return Value

bool

CheckDetailID

Return Value

CheckDetailID

DetailIndex

Return Value

int

DetailType

Return Value

CheckDetailType

Status

Return Value

string

TaxForgivenTotal

Return Value

decimal

PrevRnd

Return Value

bool

Nlu

Return Value

bool

Return

Return Value

bool

Void

Return Value

bool

Preset

Return Value

bool

Cond2

Return Value

bool

Cond1

Return Value

bool

ItemDsc

Return Value

bool

ChrgTip

Return Value

bool

ScndryAuth

Return Value

bool

LineNumVoid

Return Value

bool

PriceOverride

Return Value

bool

SkuEntry

Return Value

bool

ManEntered

Return Value

bool

LastRnd

Return Value

bool

VoucherPrinted

Return Value

bool

OperatorManAuth

Return Value

bool

DebitFlag

Return Value

bool

TaxExempt

Return Value

bool

CurrentRndVoid

Return Value

bool

LiVoidNotAllowed

Return Value

bool

LByLCustRcpt

Return Value

bool

AuthProcessed

Return Value

bool

NaLdsItem

Return Value

bool

CaNoVoucherReqd

Return Value

bool

ThaiInvoice

Return Value

bool

ThaiAccount

Return Value

bool

PriceFromBarcode

Return Value

bool

CaAvailBalance

Return Value

bool

PriceFromNluFile

Return Value

bool

MiHold

Return Value

bool

TmedDummyCaEntry

Return Value

bool

BvgAftPrompt

Return Value

bool

Shared

Return Value

bool

FromCourseNlu

Return Value

bool

ConsolParentWCondBase

Return Value

bool

UsvcTender

Return Value

bool

UsvcAuth

Return Value

bool

UsvcIssue

Return Value

bool

UsvcActivate

Return Value

bool

UsvcReload

Return Value

bool

UsvcBatch

Return Value

bool

MiOverideParentKdsCourse

Return Value

bool

JapaneseTax

Return Value

bool

ExplicitAuth

Return Value

bool

AutoDiscount

Return Value

bool

SalesCountTrueCount

Return Value

bool

IsDiscountCoupon

Return Value

bool

IsDefault

Return Value

bool

AtDefaultSettings

Return Value

bool

IsDefaultReplacement

Return Value

bool

BarcodeEntry

Return Value

bool

ManualCondimentEntry

Return Value

bool

CountManuallyEntered

Return Value

bool

DisplayWhenInDefaultState

Return Value

bool

NotVoidable

Return Value

bool

ApprovedAtMinAmountCheck

Return Value

bool

IsParentItem

Return Value

bool

Seat

Return Value

int

RevCtrID

Return Value

int

EmployeeID

Return Value

long

Total

Return Value

decimal

Return Value

int

DetailPostingTime

Return Value

DateTime

Return Value

int

SalesCount

Return Value

int

DecimalSalesCount

Return Value

decimal

ReferenceEntries

Return Value

ExtensibilityDetailArray`1

ExtensibilityData

Return Value

ExtensibilityDetailArray`1

Parent

Return Value

CheckDetailItem

Return Value

int

Name

Return Value

string

Return Value

int

SetTaxRates( DbTaxClass taxClass )

Return Value

void

SetTaxRates( Boolean[] taxRates )

Return Value

void

SetTaxRate( int oneBasedIndex )

Return Value

void

ClearTaxRate( int oneBasedIndex )

Return Value

void

RestoreTaxRates()

Return Value

void

MiDefMasterId

Return Value

int

Return Value

long

Return Value

long

AuthEmployeeID

Return Value

long

MiObjNum

Return Value

int

Price

Return Value

decimal

OptionBits

Return Value

string

Open

Return Value

bool

Cndmnt

Return Value

bool

Negative

Return Value

bool

IncSeat

Return Value

bool

RefReqd

Return Value

bool

ValdReqd

Return Value

bool

AllowItmDsc

Return Value

bool

AllowNonPriced

Return Value

bool

OvrrdPrintGrp

Return Value

bool

MapPriceToSublvl

Return Value

bool

PostToCovers

Return Value

bool

AutoSvc

Return Value

bool

PriceOnOrdr

Return Value

bool

DisableTransDtl

Return Value

bool

WeighedItem

Return Value

bool

Name1And2OnChk

Return Value

bool

Name2OnReq

Return Value

bool

Name2OnTs

Return Value

bool

AmtEntry

Return Value

bool

CndmntQty

Return Value

bool

PrintCndmntSep

Return Value

bool

ConsolCndmntPrice

Return Value

bool

LdsItem

Return Value

bool

RepeatLastRnd

Return Value

bool

RepeatMainLvl

Return Value

bool

RepeatSubLvl

Return Value

bool

EnableMlvlPrefix

Return Value

bool

EnableSlvlPrefix

Return Value

bool

SortCndmntsByPg

Return Value

bool

PromptForSeat

Return Value

bool

BeverageItem

Return Value

bool

FixedPriceMeal

Return Value

bool

ItemShareable

Return Value

bool

DontAddToFAndB

Return Value

bool

ConsolParentWCond

Return Value

bool

ConsolIdentParents

Return Value

bool

SendInChkdtlTmsMsg

Return Value

bool

KmsUseCourse

Return Value

bool

OverideParentKdsCourse

Return Value

bool

IsAnonymousItem

Return Value

bool

NluIndex

Return Value

short

NluNumber

Return Value

long

PrintOptionBits

Return Value

string

Return Value

short

Return Value

short

DscntItmzrID

Return Value

DscntItmzrID

SvcChgItmzrID

Return Value

SvcChgItmzrID

SlsItmzrIndex

Return Value

short

PrintGroup

Return Value

short

PrivilegeLevel

Return Value

int

RecipeNameID

Return Value

int

KdsCourseNum

Return Value

int

VoidReasonID

Return Value

VoidReasonID

PrepCost

Return Value

decimal

Surcharge

Return Value

decimal

ItemWeight

Return Value

decimal

TareWeight

Return Value

decimal

PrepTime

Return Value

int

TaxRates

Return Value

Boolean[]

DefaultCount

Return Value

int

HasManualDiscount

Return Value

bool

HasAnyDiscount

Return Value

bool

Condiments

Return Value

ExtensibilityDetailArray`1

ComboSides

Return Value

ExtensibilityDetailArray`1

Fees

Return Value

ExtensibilityDetailArray`1

FamGrpObjNum

Return Value

int

MajGrpObjNum

Return Value

int

SvcChgItmzrIndex

Return Value

short

DscntItmzrIndex

Return Value

short

NonTaxable

Return Value

bool

ComboMealNumber

Return Value

short

ComboMealSideNumber

Return Value

short

ComboMealSidePrepCost

Return Value

decimal

InclusiveTax

Return Value

decimal

OrderTypeID

Return Value

OrdTypeID

TaxData

Return Value

DetailTaxData

Name2

Return Value

string

Name3

Return Value

string

LongDescriptor

Return Value

string

IsComboMealMainOrSide

Return Value

bool

ComboMealGroupNumber

Return Value

int

IsComboMealParent

Return Value

bool

ServiceChargeDetail

SvcChgDtlID

Return Value

SvcChgDtlID

SvcChgID

Return Value

int

ObjectNumber

Return Value

int

OptionBits

Return Value

string

Open

Return Value

bool

Amt

Return Value

bool

ChgTip

Return Value

bool

AddToTipSvc

Return Value

bool

RefReqd

Return Value

bool

ValdReqd

Return Value

bool

CrdtCardPosting

Return Value

bool

TaiwanPaidOut

Return Value

bool

ResetItmzr

Return Value

bool

PostToCovers

Return Value

bool

NoAddGrossRcpt

Return Value

bool

ItemShareable

Return Value

bool

CashTips

Return Value

bool

StoredValue

Return Value

bool

MaskAcctNum

Return Value

bool

EncryptRef

Return Value

bool

UseFloor

Return Value

bool

GiftCert

Return Value

bool

Truncate

Return Value

bool

InclusiveTax

Return Value

decimal

Percentage

Return Value

decimal

PrintOptionBits

Return Value

string

PrivilegeLevel

Return Value

int

VoidReasonID

Return Value

VoidReasonID

TillDetailID

Return Value

TillDetailID

TaxRates

Return Value

Boolean[]

IsSvcChgFee

Return Value

bool

GiftCardTransactionItem

Return Value

bool

TaxData

Return Value

DetailTaxData

DiscountDetail

DscntDtlID

Return Value

DscntDtlID

DscntID

Return Value

int

ObjectNumber

Return Value

int

OptionBits

Return Value

string

Open

Return Value

bool

Amt

Return Value

bool

ItmDsc

Return Value

bool

EmplMeal

Return Value

bool

RefReqd

Return Value

bool

ValdReqd

Return Value

bool

Limit

Return Value

bool

AssumeEntireAmt

Return Value

bool

SimpleItemExcl

Return Value

bool

TenderReqd

Return Value

bool

AffectAutoSvc

Return Value

bool

RefDhcChksum

Return Value

bool

TaxOnCalcAmt

Return Value

bool

NotWFilter

Return Value

bool

ProrateItmzr

Return Value

bool

Allocate

Return Value

bool

SimpleTransExcl

Return Value

bool

IsFinal

Return Value

bool

Percentage

Return Value

decimal

PrintOptionBits

Return Value

string

PrivilegeLevel

Return Value

int

TempAllocation

Return Value

string

TillDetailID

Return Value

TillDetailID

InclusiveTax

Return Value

decimal

TaxRates

Return Value

Boolean[]

TaxData

Return Value

DetailTaxData

Return Value

int

TenderMediaDetail

IsChange()

Return Value

bool

TendMedDtlID

Return Value

TendMedDtlID

TendMedID

Return Value

int

ObjectNumber

Return Value

int

CashierID

Return Value

int

ChargeTip

Return Value

decimal

CurrencyAmount

Return Value

decimal

OptionBits

Return Value

string

PrintOptionBits

Return Value

string

CurrencyID

Return Value

CurrencyID

PrivilegeLevel

Return Value

int

InterfaceIndex

Return Value

int

SignatureGuid

Return Value

string

Deposit

Return Value

decimal

ServingPeriodID

Return Value

long

TillDetailID

Return Value

TillDetailID

OpenCashDwr

Return Value

bool

HoldStatPrevItem

Return Value

bool

AmtReqd

Return Value

bool

TipPaid

Return Value

bool

AssumePaidInFull

Return Value

bool

AllowUseWCurCnv

Return Value

bool

RefReqd

Return Value

bool

ValdReqd

Return Value

bool

PrintCustRcpt

Return Value

bool

ChgTipReqd

Return Value

bool

PostGrossRcpts

Return Value

bool

PostChrgdRcpts

Return Value

bool

AutoSvcExmpt

Return Value

bool

PrintMemoChk

Return Value

bool

PrintSeatChk

Return Value

bool

TxexCoupon

Return Value

bool

IncSingleFilter

Return Value

bool

ChkExpDate

Return Value

bool

HaloEnabled

Return Value

bool

HaloAmtEntry

Return Value

bool

ReprintChk

Return Value

bool

PrintSlsItmzrs

Return Value

bool

PrintSumTtls

Return Value

bool

PrintTrailer

Return Value

bool

PrintChk

Return Value

bool

PrintVatSttl

Return Value

bool

EndorsementReqd

Return Value

bool

EmplMealTip

Return Value

bool

Mod10Chksum

Return Value

bool

TrailerForFastTrans

Return Value

bool

PmsPostZeroTtl

Return Value

bool

Pms2RefLines

Return Value

bool

Pms19RefNum

Return Value

bool

DoNotNetPmtWChng

Return Value

bool

CaedcReqd

Return Value

bool

ReqdCcAuth

Return Value

bool

TipLessThanPayment

Return Value

bool

MustPayInFull

Return Value

bool

CallIsl

Return Value

bool

ReversePmsItmzrs

Return Value

bool

SwitchOnPmsFailure

Return Value

bool

NoCaVoucher

Return Value

bool

ChkPrntOnFinalTenderOnly

Return Value

bool

PrmtToSendChkPrint

Return Value

bool

ItemShareable

Return Value

bool

PrmptForStartDate

Return Value

bool

PrmptForIssueNum

Return Value

bool

RndToNextHighestDollar

Return Value

bool

Prnt2Chks

Return Value

bool

PrmptFor2Chks

Return Value

bool

AllowWithEuro

Return Value

bool

DonotIncScvChgInProratePms

Return Value

bool

AvsOnManualEntry

Return Value

bool

AvsOnAutoSwipe

Return Value

bool

AvsIsFullAddress

Return Value

bool

CvvOnManualEntry

Return Value

bool

CvvOnAutoSwipe

Return Value

bool

StoredValue

Return Value

bool

MaskAcctNum

Return Value

bool

AllowQuickpay

Return Value

bool

SchedEmplOnly

Return Value

bool

BreakEmplOnly

Return Value

bool

ReprintOrder

Return Value

bool