IGPOS API

Reference Guide

Copyright © 2024 by Agilysys NV, LLC. All rights reserved. Neither this documentation
nor any portion of the contents of this documentation may be reproduced or transmitted Scope: Customer
in any form or by any means without the prior written permission of Agilysys NV, LLC.
This documentation may be changed at any time without notice. This documentation Document Revision Date: February 12, 2024
contains confidential information of Agilysys NV, LLC, which may not be used or further
disclosed without the prior written permission of Agilysys NV, LLC. All trademarks and
registered trademarks are the property of their respective owners.
Certified
 IGPOS API | Reference Guide

Contents
Overview ...................................................................................................................................12
Payment Types .........................................................................................................................13
Payment Flow ......................................................................................................................13
Internal Payments (With Auth) .......................................................................................13
Internal Payments (Without Auth) ..................................................................................13
External Payments ........................................................................................................13
Check Data Sample Response .................................................................................................15
Authentication .........................................................................................................................132
Login ..................................................................................................................................132
Sample Request ..........................................................................................................132
Sample Response .......................................................................................................132
Check Transaction ..................................................................................................................133
CreateCheck ......................................................................................................................133
Sample Request ..........................................................................................................133
Sample Response .......................................................................................................134
SetDeliveryInfo ...................................................................................................................134
Sample Request ..........................................................................................................134
Sample Response .......................................................................................................135
AddDonation ......................................................................................................................135
Sample Request ..........................................................................................................135
Sample Response .......................................................................................................136
CalculateOrder ...................................................................................................................136
Sample Request ..........................................................................................................136
Sample Response .......................................................................................................141
CalculateOrderwithErrors ...................................................................................................141
Sample Request ..........................................................................................................141
Sample Response .......................................................................................................146
ProcessOrder .....................................................................................................................146
Sample Request ..........................................................................................................146
Sample Response .......................................................................................................151
SaveCheck .........................................................................................................................151
Sample Request ..........................................................................................................151
Sample Response: ......................................................................................................151
VoidCheck ..........................................................................................................................151
Sample Request ..........................................................................................................151
Sample Response .......................................................................................................152
AppendCheck .....................................................................................................................152
Sample Request ..........................................................................................................152
Sample Response .......................................................................................................156
AppendOpenCheck ............................................................................................................156

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 2
 IGPOS API | Reference Guide

Sample Request ..........................................................................................................156

Sample Response .......................................................................................................160
GetFinancialBins ................................................................................................................160
Sample Request ..........................................................................................................160
Sample Response .......................................................................................................161
RecallCheck .......................................................................................................................161
Sample Request ..........................................................................................................162
Sample Response .......................................................................................................162
TryPayCheck ......................................................................................................................162
Sample Request ..........................................................................................................162
Sample Response .......................................................................................................163
ExternalTryPayCheck .........................................................................................................163
Sample Request ..........................................................................................................163
Sample Response .......................................................................................................163
ExternalAuth.......................................................................................................................164
Sample Request ..........................................................................................................164
Sample Response .......................................................................................................169
ExternalAccept ...................................................................................................................169
Sample Request ..........................................................................................................170
Sample Response .......................................................................................................170
ExternalTenderCheck .........................................................................................................170
Sample Request ..........................................................................................................170
Sample Response .......................................................................................................176
CreateScheduleOrderCheck...............................................................................................176
Sample Request ..........................................................................................................176
Sample Response .......................................................................................................177
SetSchedule .......................................................................................................................177
Sample Request ..........................................................................................................177
Sample Response .......................................................................................................178
VoidTender.........................................................................................................................178
Sample Request ..........................................................................................................178
Sample Response .......................................................................................................178
RemoveTender...................................................................................................................179
Sample Request ..........................................................................................................179
Sample Response .......................................................................................................179
AddPackage .......................................................................................................................179
Sample Request ..........................................................................................................179
Sample Response .......................................................................................................180
SetCoverCount ...................................................................................................................181
Sample Request ..........................................................................................................181
Sample Response .......................................................................................................181
ModifyGratuity ....................................................................................................................181

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 3
 IGPOS API | Reference Guide

Sample Request ..........................................................................................................181

Sample Response .......................................................................................................182
ModifyServiceCharge .........................................................................................................182
Sample Request ..........................................................................................................182
Sample Response .......................................................................................................182
ApplyDiscount ....................................................................................................................182
Sample Request ..........................................................................................................183
Sample Response .......................................................................................................183
RemoveGratuity .................................................................................................................183
Sample Request ..........................................................................................................183
Sample Response .......................................................................................................184
RemoveServiceCharge ......................................................................................................184
Sample Request ..........................................................................................................184
Sample Response .......................................................................................................184
RemoveCheckTax ..............................................................................................................184
Sample Request ..........................................................................................................185
Sample Response .......................................................................................................185
RestoreCheckTax...............................................................................................................185
Sample Request ..........................................................................................................185
Sample Response .......................................................................................................185
RestoreGratuity ..................................................................................................................186
Sample Request ..........................................................................................................186
Sample Response .......................................................................................................186
RestoreServiceCharge .......................................................................................................186
Sample Request ..........................................................................................................186
Sample Response .......................................................................................................187
CancelCheck ......................................................................................................................187
Sample Request ..........................................................................................................187
Sample Response .......................................................................................................187
RemoveTryPayCheck.........................................................................................................187
Sample Request ..........................................................................................................187
Sample Response .......................................................................................................187
VoidDiscount ......................................................................................................................188
Sample Request ..........................................................................................................188
Sample Response .......................................................................................................188
ModifyWithheldAmount.......................................................................................................188
Sample Request ..........................................................................................................188
Sample Response .......................................................................................................189
ModifyCreditTender ............................................................................................................189
Sample Request ..........................................................................................................189
Sample Response .......................................................................................................189
TipTransfer .........................................................................................................................189

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 4
 IGPOS API | Reference Guide

Sample Request ..........................................................................................................190

Sample Response .......................................................................................................190
TipPayout ...........................................................................................................................190
Sample Request ..........................................................................................................190
Sample Response .......................................................................................................191
ShiftReset...........................................................................................................................191
Sample Request ..........................................................................................................191
Sample Response .......................................................................................................192
ModifyServer ......................................................................................................................192
Sample Request ..........................................................................................................192
Sample Response .......................................................................................................192
SetTable .............................................................................................................................193
Sample Request ..........................................................................................................193
Sample Response .......................................................................................................193
ModifySeat .........................................................................................................................193
Sample Request ..........................................................................................................193
Sample Response .......................................................................................................193
RecallCheckList..................................................................................................................194
Sample Request ..........................................................................................................194
Sample Response .......................................................................................................194
AddTip ................................................................................................................................196
Sample Request ..........................................................................................................196
Sample Response .......................................................................................................196
ModifyTip............................................................................................................................197
Sample Request ..........................................................................................................197
Sample Response .......................................................................................................197
AddGuest ...........................................................................................................................197
Sample Request ..........................................................................................................197
Sample Response .......................................................................................................198
VoidGuest ..........................................................................................................................198
Sample Request ..........................................................................................................198
Sample Response .......................................................................................................198
VoidTip ...............................................................................................................................198
Sample Request ..........................................................................................................199
Sample Response .......................................................................................................199
HoldCheck..........................................................................................................................199
Sample Request ..........................................................................................................199
Sample Response .......................................................................................................200
ModifyCheckType...............................................................................................................200
Sample Request ..........................................................................................................200
Sample Response .......................................................................................................200
TransferCheck ....................................................................................................................200

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 5
 IGPOS API | Reference Guide

Sample Request ..........................................................................................................200

Sample Response .......................................................................................................201
SetSplitAmount...................................................................................................................201
Sample Request ..........................................................................................................201
Sample Response .......................................................................................................202
HoldOrFireItems .................................................................................................................202
Sample Request ..........................................................................................................202
Sample Response .......................................................................................................202
SetHoldOrFire ....................................................................................................................202
Sample Request ..........................................................................................................203
Sample Response .......................................................................................................203
GetGuestTierDiscounts ......................................................................................................203
Sample Request ..........................................................................................................203
Sample Response .......................................................................................................203
CloseOrder .........................................................................................................................203
Sample Request ..........................................................................................................203
Sample Response .......................................................................................................204
Item Transaction .....................................................................................................................205
Process86 ..........................................................................................................................205
Sample Request ..........................................................................................................205
Sample Response .......................................................................................................205
VoidItem .............................................................................................................................205
Sample Request ..........................................................................................................205
Sample Response .......................................................................................................206
ReturnItem .........................................................................................................................206
Sample Request ..........................................................................................................206
Sample Response .......................................................................................................206
AddItem ..............................................................................................................................207
Sample Request ..........................................................................................................207
Sample Response .......................................................................................................208
ModifyItemQuantity ............................................................................................................209
Sample Request ..........................................................................................................209
Sample Response .......................................................................................................209
RemoveItemTax .................................................................................................................209
Sample Request ..........................................................................................................209
Sample Response .......................................................................................................210
RestoreItemTax ..................................................................................................................210
Sample Request ..........................................................................................................210
Sample Response .......................................................................................................210
ReorderItem .......................................................................................................................211
Sample Request ..........................................................................................................211
Sample Response .......................................................................................................211

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 6
 IGPOS API | Reference Guide

ModifyItemDiscount ............................................................................................................211
Sample Request ..........................................................................................................211
Sample Response .......................................................................................................212
AddItemByItemNumber ......................................................................................................212
Sample Request ..........................................................................................................212
Sample Response .......................................................................................................213
AddSpecialInstruction .........................................................................................................213
Sample Request ..........................................................................................................213
Sample Response .......................................................................................................214
VoidSpecialInstruction ........................................................................................................214
Sample Request ..........................................................................................................214
Sample Response .......................................................................................................215
ItemPriceOverride ..............................................................................................................215
Sample Request ..........................................................................................................215
Sample Response .......................................................................................................215
AddModifier ........................................................................................................................215
Sample Request ..........................................................................................................216
Sample Response .......................................................................................................217
VoidModifier .......................................................................................................................217
Sample Request ..........................................................................................................217
Sample Response .......................................................................................................217
Full Service .............................................................................................................................218
Login ..................................................................................................................................218
CalculateOrder ...................................................................................................................218
CalculateOrderWithErrors ..................................................................................................218
AppendCheck .....................................................................................................................218
Sample Request ..........................................................................................................219
Sample Response .......................................................................................................219
GetOpenCheckInfo.............................................................................................................219
Sample Request ..........................................................................................................219
Sample Response .......................................................................................................219
Payments ................................................................................................................................220
GetHandles ........................................................................................................................220
Sample Request ..........................................................................................................220
Sample Response .......................................................................................................221
GetAllHandles ....................................................................................................................224
Sample Request ..........................................................................................................225
Sample Response .......................................................................................................226
Sale ....................................................................................................................................229
Sample Request ..........................................................................................................229
Sample Response .......................................................................................................230
Auth....................................................................................................................................230

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 7
 IGPOS API | Reference Guide

Sample Request ..........................................................................................................230

Sample Response .......................................................................................................231
Accept ................................................................................................................................231
Sample Request ..........................................................................................................231
Sample Response .......................................................................................................232
Configuration ..........................................................................................................................233
GetPromoItems ..................................................................................................................233
Sample Request ..........................................................................................................233
Sample Response .......................................................................................................233
GetCheckTypes..................................................................................................................234
Sample Request ..........................................................................................................234
Sample Response .......................................................................................................234
GetAllCommonInfo .............................................................................................................235
Sample Request ..........................................................................................................235
Sample Response .......................................................................................................236
GetEmployees ....................................................................................................................237
Sample Request ..........................................................................................................237
Sample Response .......................................................................................................237
GetCheckInfo .....................................................................................................................238
Sample Request ..........................................................................................................238
Sample Response .......................................................................................................239
GetClosedCheckInfoDispatcher .........................................................................................239
Sample Request ..........................................................................................................239
Sample Response .......................................................................................................239
GetCheckTypeConfiguration ..............................................................................................239
Sample Request ..........................................................................................................240
Sample Response .......................................................................................................240
GetMenuItemsBySkuId.......................................................................................................243
Sample Request ..........................................................................................................243
Sample Response .......................................................................................................243
GetAspenDiscounts ............................................................................................................244
Sample Request ..........................................................................................................244
Sample Response .......................................................................................................244
GetModifiers .......................................................................................................................245
Sample Request ..........................................................................................................245
Sample Response .......................................................................................................245
GetMembershipInfo ............................................................................................................246
Sample Request ..........................................................................................................246
Sample Response .......................................................................................................246
GetEmployeeInfobyId .........................................................................................................247
Sample Request ..........................................................................................................247
Sample Response .......................................................................................................247

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 8
 IGPOS API | Reference Guide

GetCommonInfo .................................................................................................................248
Sample Request ..........................................................................................................248
Sample Response .......................................................................................................248
GetCustomerInfo ................................................................................................................250
Sample Request ..........................................................................................................250
Sample Response .......................................................................................................250
GetCoupons .......................................................................................................................252
Sample Request ..........................................................................................................252
Sample Response .......................................................................................................252
GetMenuItems ....................................................................................................................253
Sample Request ..........................................................................................................253
Sample Response .......................................................................................................254
GetPackages ......................................................................................................................258
Sample Request ..........................................................................................................258
Sample Response .......................................................................................................258
GetProfitCenterInfo ............................................................................................................259
Sample Request ..........................................................................................................259
Sample Response .......................................................................................................259
GetTableDetails..................................................................................................................262
Sample Request ..........................................................................................................262
Sample Response .......................................................................................................262
GetTableDetailsForProfitCenters ........................................................................................263
Sample Request ..........................................................................................................263
Sample Response .......................................................................................................264
GetRevenueCategoryDetails ..............................................................................................264
Sample Request ..........................................................................................................264
Sample Response .......................................................................................................265
GetTerminalGroup..............................................................................................................265
Sample Request ..........................................................................................................266
Sample Response .......................................................................................................266
GetTerminalInfo..................................................................................................................268
Sample Request ..........................................................................................................268
Sample Response .......................................................................................................268
GetTerminalOptions ...........................................................................................................269
Sample Request ..........................................................................................................269
Sample Response .......................................................................................................269
GetLanguageDetails ...........................................................................................................269
Sample Request ..........................................................................................................269
Sample Response .......................................................................................................270
GetClosedCheckInfo ..........................................................................................................270
Sample Request ..........................................................................................................270
Sample Response .......................................................................................................270

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 9
 IGPOS API | Reference Guide

GetClosedCheckReceipt ....................................................................................................270
Sample Request ..........................................................................................................270
Sample Response .......................................................................................................271
GetOpenChecks .................................................................................................................271
Sample Request ..........................................................................................................271
Sample Response .......................................................................................................271
GetOpenChecksByTable ....................................................................................................272
Sample Request ..........................................................................................................273
Sample Response .......................................................................................................273
GetTenderDetails ...............................................................................................................274
Sample Request ..........................................................................................................274
Sample Response .......................................................................................................274
GetDiscountDetails .............................................................................................................281
Sample Request ..........................................................................................................281
Sample Response .......................................................................................................281
GetTaxDetails ....................................................................................................................284
Sample Request ..........................................................................................................284
Sample Response .......................................................................................................284
GetGratuityServiceCharge .................................................................................................285
Sample Request ..........................................................................................................285
Sample Response .......................................................................................................286
GetItemPriceByPriceLevel ..................................................................................................288
Sample Request ..........................................................................................................288
Sample Response .......................................................................................................288
GetModifierPriceByPriceLevel ............................................................................................289
Sample Request ..........................................................................................................289
Sample Response .......................................................................................................289
GetChoiceGroup ................................................................................................................290
Sample Request ..........................................................................................................290
Sample Response .......................................................................................................290
GetVoidReason ..................................................................................................................291
Sample Request ..........................................................................................................291
Sample Response .......................................................................................................291
GetProfitCenters.................................................................................................................292
Sample Request ..........................................................................................................292
Sample Response .......................................................................................................292
GetQuickTenderDetails ......................................................................................................293
Sample Request ..........................................................................................................294
Sample Response .......................................................................................................294
GetMealPeriod ...................................................................................................................294
Sample Request ..........................................................................................................294
Sample Response .......................................................................................................294

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 10
 IGPOS API | Reference Guide

GetEmployeeInfo................................................................................................................296
Sample Request ..........................................................................................................296
Sample Response .......................................................................................................296
GetTerminalState ...............................................................................................................297
Sample Request ..........................................................................................................298
Sample Response .......................................................................................................298
GetSelectionGroup .............................................................................................................299
Sample Request ..........................................................................................................299
Sample Response .......................................................................................................299
GetSpecialInstructions........................................................................................................299
Sample Request ..........................................................................................................300
Sample Response .......................................................................................................300
VoidMultipleDiscounts ........................................................................................................301
Sample Request ..........................................................................................................301
Sample Response .......................................................................................................301
GetTierDiscounts................................................................................................................301
Sample Request ..........................................................................................................302
Sample Response .......................................................................................................302
Store .......................................................................................................................................303
OpenStore ..........................................................................................................................303
Sample Request ..........................................................................................................303
Sample Response .......................................................................................................303
CloseStore .........................................................................................................................303
Sample Request ..........................................................................................................304
Sample Response .......................................................................................................304

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 11
 IGPOS API | Reference Guide

Overview
This document lists the InfoGenesis POS API methods. It is strongly recommended that a
working understanding of the Agilysys InfoGenesis POS system be obtained before developing
applications that import data into the back office. In addition, expertise with XML or JSON,
HTTP, and REST based services is also recommended. This document also provides examples
of how to use various API endpoints.
POS API is categorized into the following sections:
▪ Authentication
▪ Check Transaction
▪ Item Transaction
▪ Full Service
▪ Payments
▪ Configuration
▪ Store

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 12
 IGPOS API | Reference Guide

Payment Types
This section provides a detailed insight into the APIs to be called and the order in which they’re
to be called for payment operations, based on the type of payment. The following are the
available payment types:
▪ Internal Payments (With/Without Authorization) - Internal payments are the type of
payments where InfoGenesis is responsible for collecting the payments. This includes
payments made using Casino, PMS, and Campus Card tenders.
▪ External Payments - External payments are the type of payments where the third-party
client is responsible for handling the actual payment, and InfoGenesis will just record them
against that vendor name with the configured tender. This includes payments made using
Cash, Credit Cards, and Wallet Payments.

Payment Flow
The following sections explain the payment flow based on internal and external payment types:

Internal Payments (With Auth)

The following APIs must be called in the exact order specified here for these payments:
1. Login
2. Create Check
3. AppendOpenCheck
4. Get Handles
5. Auth
6. Try PayCheck (Tender index should be passed)
7. Accept
8. Close Order (if tip amount is added to the check)

Internal Payments (Without Auth)

The following APIs must be called in the exact order specified here for these payments:
1. Login
2. Create Check
3. AppendOpenCheck
4. Get Handles
5. Try PayCheck
6. Sale
7. Close Order (if tip amount is added to the check)

External Payments
The following APIs must be called in the exact order specified here for these payments:
1. Login

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 13
 IGPOS API | Reference Guide

2. Create Check
3. AppendOpenCheck
4. External Try Pay Check
5. External Tender Check
6. Close Order (if tip amount is added to the check)

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 14
 IGPOS API | Reference Guide

Check Data Sample Response

This section consists of the sample response and field description table for check and item
transaction APIs.
{
"employeeLastLoginDateTime": "string",
"orderReceiptNumber": "string",
"isoCountryCode": "string",
"isoCurrencyCode": "string",
"checkOpenSourceType": "int",
"checkClosedSourceType": "int",
"terminal": {
"id": "int",
"terminalDimId": "long",
"tenderedTermId": "int",
"tenderedTerminalDimId": "long",
"profitCenter": "sting",
"profitCenterDimId": "long",
"printTermId": "string",
"ipAddress": "string",
"terminalModes": "int",
"mealPeriodDimId": "long",
"openedProfitCenterDimId": "long",
"openedProfitCenterId": "long"
},
"context": {
"CustomerId": "string",
"EnterpriseId": "string",
"DivisionId": "string",
"StoreId": "string",
"TerminalId": "string",
"PropertyDTTM": "string",
"CurrencyCulture": "string",
"TimeZone": "string",
"ProfileId": "string"
},
"financialBins": [
{
"Type": "short",
"Id": "int",
"Amount": "int",
"Quantity": "int"
}
],
"checkType": "string",
"checkTypeDimId": "long",
"checkPassCount": "int",
"gratuityState": "int",
"serviceChargeState": "int",
"isRefund": "bool",
"isRestrictAlcoholItems": "bool",
"isRestrictTobaccoItems": "bool",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 15
 IGPOS API | Reference Guide

"isClosedRefund": "bool",
"isTaxRemoved": "bool",
"checkHandle": {
"checkNumber": "string",
"guid": "Guid",
"longCheckNumber": "string",
"orderCodeNumber": "string"
},
"associatedCheckNumber": "string",
"associatedLongCheckNumber": "string",
"mealPeriod": "int",
"isLiveEntertainmentTax": "bool",
"isGDPR": "bool",
"isCompTenderRemoveTax": "bool",
"isSaveCasionPlayerDetails": "bool",
"mealPeriodDimId": "long",
"voidReasonDimId": "long",
"priceLevel": "string",
"voidInfo": {
"id": "string",
"time": "DateTime",
"timeTicks": "long",
"reason": "string",
"voidedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"overrideApprovedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"dimId": "long"
},
"isConsumed": "bool",
"tableNumber": "string",
"orderNumber": "string",
"isCheckLabel": "bool",
"evenSplitCount": "int",
"splitIdx": "int",
"isRestrictedTOGratAndTip": "bool",
"isRestrictedTOServiceCharge": "bool",
"evenSplitAmount": "decimal",
"defaultItemKitchenStatus": "int",
"evenSplitFinalAmount": "string",
"dataTag": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 16
 IGPOS API | Reference Guide

"dataTagType": "int",
"checkSearchType": "int",
"taggedAccountId": "string",
"recalledCheckLastQSRIndex": "int",
"overrideApprovedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"previouslyAddedItemIndex": "int",
"checkStatus": "int",
"isSplitted": "bool",
"isSplitParentCheck": "bool",
"splitSeatId": "int",
"splitAllItemsCount": "int",
"isOfflineCheck": "bool",
"guestInfo": {
"Id": "string",
"Name": "string",
"AccountType": "string",
"Tier": "string",
"Pin": "string",
"RewardPoints": "string",
"MerchantId": "string",
"MemberUId": "string",
"StoreNumber": "string",
"RegisterNumber": "string",
"TransactionNumber": "string"
},
"customerCentricDiscountData": [
{
"DiscountId": "int",
"Percentage": "int"
}
],
"splitAmount": "decimal",
"splitAmountMax": "int",
"splitAmountMaxThreshold": "decimal",
"roundAmount": "decimal",
"checkTotal": "decimal",
"checkTotalWithoutRound": "decimal",
"grossAmount": "decimal",
"amount": "decimal",
"charityAmount": "decimal",
"charityRoundAmount": "decimal",
"discountAmount": "decimal",
"tax": "decimal",
"inclusiveTax": "decimal",
"serviceChargeValue": "decimal",
"groupedServiceChargeValue": "decimal",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 17
 IGPOS API | Reference Guide

"gratuityValue": "decimal",
"groupedGratuityValue": "decimal",
"withheldValue": "decimal",
"tipValue": "decimal",
"restrictedAmount": "decimal",
"unRestrictedItemTaxAmount": "decimal",
"restrictedCheckItemAmount": "decimal",
"unRestrictedItemAmount": "decimal",
"balanceAmountAfterAutoRemovalTax": "decimal",
"restrictedTenderAmount": "decimal",
"restrictedTenderedTipAmount": "decimal",
"hyattGoldPassFlag": "bool",
"creditTender": "decimal",
"openGratuityPercent": "decimal",
"openServiceChargePercent": "decimal",
"openGratuityAmount": "decimal",
"openServiceChargeAmount": "decimal",
"balanceAmount": "decimal",
"authorizedAmount": "decimal",
"UnUsedTip": "decimal",
"UnUsedTip2": "decimal",
"currentTenderId": "int",
"currentTenderTipAmount": "decimal",
"currentTenderAmount": "decimal",
"tenderAmountAfterTaxRemoval": "decimal",
"tenderDiscountAmount": "decimal",
"applicableRestrictedTenderAmount": "decimal",
"isCurrentTnderRestricted": "bool",
"isCurrentTenderAutoRemoveTax": "bool",
"selectionGroupMaxCheckTotalValidationFailed": "bool",
"payAtTableCheckId": "string",
"teamId": "int",
"teamName": "string",
"teamMembers": [
{
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
}
],
"inclusiveGratuity": "decimal",
"inclusiveServiceCharge": "decimal",
"isInclusiveGratuityModeEnabled": "bool",
"purchaseCode": "string",
"kitchenSchedule": {
"ScheduledTime": "int",
"KPJobId": "int",
"KVJobId": "int"
},
"checkLoyaltyInfo": {

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 18
 IGPOS API | Reference Guide

"OriginalBalance": "int",
"NewBalance": "int",
"RedemptionPoints": "int",
"AccruedPoints": "int",
"EligibleEarnAmount": "int",
"EligibleRedeemAmount": "int",
"AccrualState": "int",
"AccrualStatusCode": "int"
},
"dataInteger": [
"int[9]"
],
"engageAccuralTransactionId": "int",
"balanceAmountWithoutRounding": "decimal",
"isAlcoholEligible": "bool",
"isTobaccoEligible": "bool",
"isAgeManuallyVerified": "bool",
"barCodeVerificationStatus": "int",
"offerNumber": "string",
"referenceNumber": "string",
"isEntDecimalFlag": "bool",
"isCMPPIIEncrypt": "bool",
"maxDiscountLimitPerCheck": "decimal",
"isEncrypted": "bool",
"changeAmount": "decimal",
"isIRSEnabled": "bool",
"hasAnyHoldItems": "bool",
"isGiftCardUnMask": "bool",
"syncId": "Guid",
"breakageAmount": "decimal",
"discountMultiModeFlag": "bool",
"openTime": "DateTime",
"openTimeTicks": "long",
"openedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"closeTime": "DateTime",
"closeTimeTicks": "long",
"closedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"checkCoverCount": "int",
"checkItems": [

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 19
 IGPOS API | Reference Guide

{
"objectIndex": "int",
"packageId": "int",
"itemCoverCount": "int",
"quantity": "int",
"quantityFraction": "int",
"seatNumber": "string",
"courseId": "int",
"index": "int",
"isSaved": "bool",
"isVoided": "bool",
"voidReasonId": "int",
"voidReasonDimId": "long",
"isTaxRemoved": "bool",
"isPriceOverride": "bool",
"isReturnItem": "bool",
"isRestricted": "bool",
"overrideApprovedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"orderItemType": "int",
"cost": "decimal",
"discountAmount": "decimal",
"totalTaxAmount": "decimal",
"fixedExclusiveTaxAmount": "decimal",
"isConsumed": "bool",
"name": "string",
"orderItems": [
{
"kpStatus": "int",
"KvStatus": "int",
"isOpenItem": "bool",
"kitchenDepartmentId": "int",
"isSoldByWeight": "bool",
"isMaxItemPrice": "bool",
"replacedItemDimId": "long",
"replacedItemId": "int",
"maxItemPrice": "decimal",
"isTaxInclusive": "bool",
"isStockItem": "bool",
"weight": "decimal",
"productClassId": "int",
"boxCarCost": "decimal",
"taxAmount": "decimal",
"discountAmount": "decimal",
"inclusiveTaxAmount": "decimal",
"revenueCategory": {
"id": "int",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 20
 IGPOS API | Reference Guide

"revCatDimId": "long",
"groupId": "string",
"irsFlag": "bool",
"salesAmount": "decimal",
"discountAmount": "decimal",
"exclusiveTaxAmount": "decimal",
"noTaxNetSales": "decimal",
"salesAmountTaxInclusive": "decimal",
"taxIclusiveItemDiscountAmount": "decimal",
"inclusiveTaxAmount": "decimal",
"taxCode": "string",
"isTenderRestricted": "bool"
},
"openItem": {
"id": "int",
"name": "string",
"kitchenItemIndex": "int"
},
"index": "int",
"id": "int",
"menuItemDimId": "long",
"menuItemQuantityCategoryDimID": "long",
"kitchenItemIndex": "int",
"itemCheckNumber": "int",
"roundId": "int",
"displayRoundId": "int",
"cost": "decimal",
"revenueCost": "decimal",
"openItemInitialPrice": "decimal",
"unitPrice": "decimal",
"selectionGroupId": "int",
"isModifier": "bool",
"isSaved": "bool",
"isVoided": "bool",
"isManualWeight": "bool",
"isItemLockout": "bool",
"isGiftItem": "bool",
"displayCost": "decimal",
"modifierCost": "decimal",
"primaryDiscountId": "int",
"profitCenter": "string",
"checkType": "string",
"mealPeriod": "string",
"isSplitted": "bool",
"numOfSplits": "int",
"auxSplitFlag": "bool",
"isInclusiveGratuity": "bool",
"isRestricted": "bool",
"skuCode": "string",
"name": "string",
"modifiers": [
{
"Index": "int",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 21
 IGPOS API | Reference Guide

"Id": "int",
"ModifierDimId": "long",
"Cost": "decimal",
"IsModifier": "bool",
"ModifierProductMixId": "int",
"ModifierProductMixDimId": "long",
"IsSaved": "bool",
"IsVoided": "bool",
"DisplayCost": "decimal",
"ModifierCost": "decimal",
"ChoiceGroupId": "int",
"ChildItemIndex": "int",
"VoidReasonId": "int",
"VoidReasonDimId": "long",
"IsPrintOnCheck": "bool",
"KitchenItemIndex": "int",
"ItemCheckNumber": "int",
"IsPriceOverriden": "bool",
"Name": "string",
"ChoiceGroupFlag": "bool",
"choiceGroupData": {
"parent_node_id": "int",
"type": "char"
},
"Modifiers": [
{
"Index": "int",
"Id": "int",
"ModifierDimId": "long",
"Cost": "decimal",
"IsModifier": "bool",
"ModifierProductMixId": "int",
"ModifierProductMixDimId": "long",
"IsSaved": "bool",
"IsVoided": "bool",
"DisplayCost": "decimal",
"ModifierCost": "decimal",
"ChoiceGroupId": "int",
"ChildItemIndex": "int",
"VoidReasonId": "int",
"VoidReasonDimId": "long",
"IsPrintOnCheck": "bool",
"KitchenItemIndex": "int",
"ItemCheckNumber": "int",
"IsPriceOverriden": "bool",
"Name": "string",
"ChoiceGroupFlag": "bool",
"choiceGroupData": {
"parent_node_id": "int",
"type": "char"
},
"Modifiers": [],
"SpecialInstructions": [

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 22
 IGPOS API | Reference Guide

{
"Id": "int",
"Text": "string",
"Index": "int",
"IsVoid": "bool",
"VoidReasonId": "int",
"VoidReasonDimId": "long",
"IsSaved": "bool",
"kpStatus": "int",
"KvStatus": "int",
"ChildItemIndex": "int",
"KitchenItemIndex": "int",
"ItemCheckNumber": "int"
}
],
"kpStatus": "int",
"KvStatus": "int",
"AuxSplitFlag": "bool",
"IsSplitted": "bool",
"IsConsumed": "bool",
"ProductMixName": "string",
"IsReturnItem": "bool",
"Quantity": "int",
"QuantityCategoryId": "int",
"QCQuantityMultiplier": "decimal",
"BaseCalories": "string",
"MaxCalories": "string",
"DisplayName": "string",
"UnitPrice": "decimal"
}
],
"SpecialInstructions": [
{
"Id": "int",
"Text": "string",
"Index": "int",
"IsVoid": "bool",
"VoidReasonId": "int",
"VoidReasonDimId": "long",
"IsSaved": "bool",
"kpStatus": "int",
"KvStatus": "int",
"ChildItemIndex": "int",
"KitchenItemIndex": "int",
"ItemCheckNumber": "int"
}
],
"kpStatus": "int",
"KvStatus": "int",
"AuxSplitFlag": "bool",
"IsSplitted": "bool",
"IsConsumed": "bool",
"ProductMixName": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 23
 IGPOS API | Reference Guide

"IsReturnItem": "bool",
"Quantity": "int",
"QuantityCategoryId": "int",
"QCQuantityMultiplier": "decimal",
"BaseCalories": "string",
"MaxCalories": "string",
"DisplayName": "string",
"UnitPrice": "decimal"
}
],
"specialInstructions": [
{
"Id": "int",
"Text": "string",
"Index": "int",
"IsVoid": "bool",
"VoidReasonId": "int",
"VoidReasonDimId": "long",
"IsSaved": "bool",
"kpStatus": "int",
"KVStatus": "int",
"ChildItemIndex": "int",
"KitchenItemIndex": "int",
"ItemCheckNumber": "int"
}
],
"discounts": [
{
"ObjectIndex": "int",
"Index": "int",
"Amount": "decimal",
"Id": "int",
"DiscountDimId": "long",
"Level": "int",
"IsPercentage": "bool",
"Value": "decimal",
"IsNoTax": "bool",
"IsOpenDiscount": "bool",
"ItemCount": "int",
"SKUCode": "string",
"ExtraData": "string",
"DiscountedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"NotFormatted": "bool",
"OpenDiscountDecimalFactor": "int",
"DiscSource": "int",
"DiscountRule": {

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 24
 IGPOS API | Reference Guide

"RuleId": "int",
"RuleDimId": "long",
"RuleDateFrom": "string",
"RuleDateTo": "string",
"RuleStartTimeMinutes": "int",
"RuleEndTimeMinutes": "int",
"RuleRecurrenceType": "int",
"RuleDayofweekMask": "int",
"RuleDayofmonth": "int",
"RuleOrdinalDay": "int",
"RuleMonthofyear": "int",
"RuleRevenueGroup": "int",
"IsItemCriteriaEnabled": "bool",
"MinItemQuantity": "int",
"ItemPriceDiscount": "int",
"RuleConstraintJoin": [
{
"RuleConstraintId": "string",
"RelevantIds": [
{
"Id": "int",
"ItemFlag": "int"
}
]
}
]
},
"Tier": {
"TierId": "int",
"TierName": "string",
"CMSId": "int",
"MaxLimit": "decimal",
"RewardValue": "string",
"TierDesc": "string"
},
"ModifierId": "int",
"ModIndex": "int",
"OpenDiscountPercent": "int",
"splitDiscFlag": "bool",
"IsAffectGratuity": "bool",
"IsAffectServiceCharge": "bool",
"IsTenderReducesDisc": "bool",
"CardNumber": "string",
"StarbucksDiscountInfo": {
"MerchantId": "string",
"TransactionNumber": "string",
"IsSaved": "bool",
"IsVoided": "bool",
"StoreNumber": "int",
"RegisterNumber": "int",
"Sequence": "int",
"RedemptionSequence": "int",
"ItemId": "long",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 25
 IGPOS API | Reference Guide

"DiscountId": "int",
"RewardCode": "int",
"IsCouponDisc": "bool",
"ModifierId": "int"
},
"RCCLDiscountInfo": {
"PromotionID": "string",
"PromoName": "string",
"Points": "int",
"MenuItemId": "int",
"Quantity": "int",
"UnitPrice": "decimal"
},
"ACESDiscountInfo": {
"PromotionID": "int",
"PromoName": "string",
"PrizeID": "int",
"PackageID": "int",
"Amount": "decimal",
"PrizeType": "int",
"PromoProductClassName": "List<int>",
"DiscExtraText": "string",
"AppliedItemIndex":
"List<KeyValuePair<int, decimal>>",
"ToVoidDiscIdx": "List<int>",
"PackageItemIndex": "Dictionary<int,
Tuple<List<int>, decimal>>",
"IsTaxable": "bool",
"IsTaxOnOldPrice": "bool"
},
"PromoCode": "string",
"PromoType": "int",
"IsPMSAccountDiscount": "bool",
"PMSAccountDiscountMaxCap": "decimal"
}
],
"taxes": {
"exclusiveCost": "decimal",
"inclusiveCost": "decimal",
"count": "int",
"details": [
{
"c_TaxAmount": {
"value": "decimal"
},
"c_InclusiveTaxAmount": {
"value": "decimal"
},
"c_Amount": {
"value": "decimal"
},
"c_InclusiveCost": {
"value": "decimal"

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 26
 IGPOS API | Reference Guide

},
"c_ExclusiveCost": {
"value": "decimal"
},
"c_FixedInclusiveCost": {
"value": "decimal"
},
"c_FixedExclusiveCost": {
"value": "decimal"
},
"c_RemovedTaxPercent": {
"value": "decimal"
},
"ExclusiveCost": "decimal",
"updatedTaxRate": "decimal",
"id": "int",
"taxDimId": "long",
"taxValue": "decimal",
"taxCost": "decimal",
"isTaxByPercent": "bool",
"isExclusive": "bool",
"isTaxRemoved": "bool",
"canRemoveAtTerminal": "bool",
"categoryId": "int",
"isEarnEligible": "bool",
"isRedeemEligible": "bool",
"roundingConfiguration": {
"roundType": "int",
"roundBasis": "int"
},
"inclusiveTaxAmount": "decimal",
"amount": "decimal",
"inclusiveCost": "decimal",
"_": "decimal",
"fixedInclusiveCost": "decimal",
"fixedExclusiveCost": "decimal",
"removedTaxPercent": "decimal"
}
]
},
"modifierDiscounts": [
{
"ModifierIndex": "int",
"DiscountIndex": [
"Int[]"
]
}
],
"giftCardInfo": {
"GiftCardTenderId": "int",
"CardNumber": "string",
"EncryptionSeed": "int",
"Track1": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 27
 IGPOS API | Reference Guide

"Track2": "string",
"InvoiceId": "string",
"CurrencyCode": "string",
"SaleAmount": "decimal",
"ServiceType": "int",
"RechargeFlag": "bool",
"CashOutFlag": "bool",
"ReturnFlag": "bool",
"AccountId": "string",
"CardExpiration": "string",
"EntryMode": "string",
"SalesFlag": "bool",
"BalanceAmount": "decimal"
},
"addOnCharges": [
{
"Id": "int",
"ExclusiveTaxCost": "decimal",
"ExclusiveAmount": "decimal",
"Amount": "decimal",
"IsRemoved": "bool",
"ChargeType": "int",
"Taxes": {
"Details": [
{
"Amount": "decimal",
"Id": "int",
"RoundingConfiguration": {
"roundType": "int",
"roundBasis": "int"
}
}
]
}
}
],
"isPackagePmixFlag": "bool",
"sequence": "int",
"packagePmixAmount": "decimal",
"iUniqueSelGrpId": "int",
"voidReasonId": "int",
"voidReasonDimId": "long",
"isReturnItem": "bool",
"isPrintOnCheck": "bool",
"quantity": "int",
"quantityFraction": "int",
"addedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 28
 IGPOS API | Reference Guide

},
"voidedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"inclusiveGratuityAmount": "decimal",
"inclusiveServiceChargeAmount": "decimal",
"auxKitchenData": [
{
"AuxKPId": "int",
"ReplaceKPId": "int"
}
],
"profitCenterDimId": "long",
"originProfitCenterDimId": "long",
"mealPeriodDimId": "long",
"checkTypeDimId": "long",
"configItemIndex": "int",
"addedTime": "DateTime",
"addedTimeTicks": "long",
"baseCalories": "string",
"maxCalories": "string",
"cardImage": "Dictionary<string, string>",
"displayName": "string",
"quantityCategoryId": "int",
"qcQuantityMultiplier": "decimal",
"costBeforePackaging": "decimal",
"isToDisplaySelGrpName": "bool"
}
],
"addedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"specialInstructions": [
{
"Id": "int",
"Text": "string",
"Index": "int",
"IsVoid": "bool",
"VoidReasonId": "int",
"VoidReasonDimId": "long",
"IsSaved": "bool",
"kpStatus": "int",
"KVStatus": "int",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 29
 IGPOS API | Reference Guide

"ChildItemIndex": "int",
"KitchenItemIndex": "int",
"ItemCheckNumber": "int"
}
],
"voidedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"kitchenItemIndex": "int",
"itemCheckNumber": "int",
"displayCost": "decimal",
"splitAllItemsMethod": "int",
"isBarGunItem": "bool",
"cardImage": "Dictionary<string, string>"
}
],
"taxSummary": [
{
"Id": "int",
"InclusiveTaxAmount": "decimal",
"ExclusiveTaxAmount": "decimal",
"SalesAmount": "decimal",
"SalesAmountTaxInclusive": "decimal",
"GratuityAmount": "decimal",
"ServiceAmount": "decimal",
"DiscountAmount": "decimal",
"CompoundAmount": "decimal",
"SalesBasis": "decimal",
"GratuityBasis": "decimal",
"CategoryId": "int",
"Description": "string",
"TaxDimId": "long"
}
],
"vatSummary": {
"Vat": {
"VatType": [
{
"Id": "int",
"TaxId": "int",
"TaxDimId": "long",
"TaxAmount": "decimal",
"SalesAmount": "decimal",
"DiscountAmount": "decimal",
"GratuityAmount": "decimal",
"ServiceChargeFlag": "bool",
"RoundingConfiguration": {
"roundType": "int",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 30
 IGPOS API | Reference Guide

"roundBasis": "int"
},
"TaxRate": "double",
"RevenueCategoryId": "int"
}
]
}
},
"addOnSummary": [
{
"Id": "int",
"DimId": "long",
"AddOnType": "int",
"Amount": "decimal",
"SalesAmount": "decimal",
"DiscountAmount": "decimal",
"AllocateType": "int",
"AllocatedId": "int",
"PayoutAtTerminal": "bool",
"IncludeIRSReporting": "bool",
"gratuityInfo": {
"GratuityDetails": {
"Id": "int",
"Name": "string",
"DimId": "long",
"GratuityCategory": {
"Id": "int",
"GratuityType": "int",
"IsEarnEligible": "bool",
"IsRedeemEligible": "bool",
"GratuityCategoryName": "string"
},
"Recipient": "int",
"EmployeeId": "int",
"CanPayoutAtTerminal": "bool",
"CanRemovalAtTerminal": "bool",
"Amount": {
"AmountPerCheck": "decimal",
"AmountPerCover": "decimal",
"CoverThresholdMin": "int",
"CoverThresholdMax": "int"
},
"Percentage": {
"AppliedOn": "int",
"Percent": "decimal",
"RoundingConfiguration": {
"roundType": "int",
"roundBasis": "int"
},
"IsInclusive": "bool"
},
"CoverThresholdMin": "int",
"CoverThresholdMax": "int",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 31
 IGPOS API | Reference Guide

"IncludeIRSReporting": "bool",
"AddonGroup": {
"AddonGroupId": "int",
"AddonGroupName": "string",
"ReportRev": "bool",
"IsGratuity": "bool",
"RevCatId": "int",
"AddonGroupDimId": "long"
},
"IsTenderGrat": "bool"
},
"GratuityTaxDetails": {
"Id": "int",
"DimId": "long",
"CategoryId": "int",
"RoundingConfiguration": {
"roundType": "int",
"roundBasis": "int"
},
"IsAmount": "bool",
"Value": "decimal",
"ThresholdAmount": "decimal",
"CanRemoveAtTerminal": "bool",
"LimitToMealPeriodReporting": "bool",
"IsEarnEligible": "bool",
"IsRedeemEligible": "bool",
"PrimaryTaxCode": "string",
"ReceiptCode": "string"
},
"GratuityRevenueCategories": [
"int"
]
},
"AddonGroup": {
"AddonGroupId": "int",
"AddonGroupName": "string",
"ReportRev": "bool",
"IsGratuity": "bool",
"RevCatId": "int",
"AddonGroupDimId": "long"
},
"IsGroupedAddon": "bool",
"IsReportAsRevenue": "bool",
"GroupName": "string"
}
],
"groupedAddonSummary": [
{
"Id": "int",
"DimId": "long",
"AddOnType": "int",
"Amount": "decimal",
"AddonGroupName": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 32
 IGPOS API | Reference Guide

"IsReportAsRevenue": "bool",
"RevCatId": "int"
}
],
"discounts": [
{
"ObjectIndex": "int",
"Index": "int",
"Amount": "decimal",
"Id": "int",
"DiscountDimId": "long",
"Level": "int",
"IsPercentage": "bool",
"Value": "decimal",
"IsNoTax": "bool",
"IsOpenDiscount": "bool",
"ItemCount": "int",
"SKUCode": "string",
"ExtraData": "string",
"DiscountedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"NotFormatted": "bool",
"OpenDiscountDecimalFactor": "int",
"DiscSource": "int",
"DiscountRule": {
"RuleId": "int",
"RuleDimId": "long",
"RuleDateFrom": "string",
"RuleDateTo": "string",
"RuleStartTimeMinutes": "int",
"RuleEndTimeMinutes": "int",
"RuleRecurrenceType": "int",
"RuleDayofweekMask": "int",
"RuleDayofmonth": "int",
"RuleOrdinalDay": "int",
"RuleMonthofyear": "int",
"RuleRevenueGroup": "int",
"IsItemCriteriaEnabled": "bool",
"MinItemQuantity": "int",
"ItemPriceDiscount": "int",
"RuleConstraintJoin": [
{
"RuleConstraintId": "string",
"RelevantIds": [
{
"Id": "int",
"ItemFlag": "int"

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 33
 IGPOS API | Reference Guide

}
]
}
]
},
"Tier": {
"TierId": "int",
"TierName": "string",
"CMSId": "int",
"MaxLimit": "decimal",
"RewardValue": "string",
"TierDesc": "string"
},
"ModifierId": "int",
"ModIndex": "int",
"OpenDiscountPercent": "int",
"splitDiscFlag": "bool",
"IsAffectGratuity": "bool",
"IsAffectServiceCharge": "bool",
"IsTenderReducesDisc": "bool",
"CardNumber": "string",
"StarbucksDiscountInfo": {
"MerchantId": "string",
"TransactionNumber": "string",
"IsSaved": "bool",
"IsVoided": "bool",
"StoreNumber": "int",
"RegisterNumber": "int",
"Sequence": "int",
"RedemptionSequence": "int",
"ItemId": "long",
"DiscountId": "int",
"RewardCode": "int",
"IsCouponDisc": "bool",
"ModifierId": "int"
},
"RCCLDiscountInfo": {
"PromotionID": "string",
"PromoName": "string",
"Points": "int",
"MenuItemId": "int",
"Quantity": "int",
"UnitPrice": "decimal"
},
"ACESDiscountInfo": {
"PromotionID": "int",
"PromoName": "string",
"PrizeID": "int",
"PackageID": "int",
"Amount": "decimal",
"PrizeType": "int",
"PromoProductClassName": "List<int>",
"DiscExtraText": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 34
 IGPOS API | Reference Guide

"AppliedItemIndex": "List<KeyValuePair<int,
decimal>>",
"ToVoidDiscIdx": "List<int>",
"PackageItemIndex": "Dictionary<int, Tuple<List<int>,
decimal>>",
"IsTaxable": "bool",
"IsTaxOnOldPrice": "bool"
},
"PromoCode": "string",
"PromoType": "int",
"IsPMSAccountDiscount": "bool",
"PMSAccountDiscountMaxCap": "decimal"
}
],
"statusCode": "string",
"errorMessage": "string",
"tenders": [
{
"last_amt_authed": "int",
"pms_auth_flag": "byte",
"emv_flag": "bool",
"future_bits": "byte",
"payment_ordinal": "byte",
"cc_auth_flag": "byte",
"transactionId": "string",
"id": "string",
"tenderDimId": "long",
"tenderQty": "int",
"tenderName": "string",
"adaptorName": "string",
"amount": "decimal",
"discountId": "int",
"taxAmount": "decimal",
"isSaved": "bool",
"isRestricted": "bool",
"isExclusive": "bool",
"voucherID": "string",
"promoName": "string",
"promoCode": "string",
"voucherName": "string",
"voucherDescription": "string",
"accountInfo": {
"Name": "string",
"Number": "string"
},
"IsPinPrompt": "bool",
"isTipAvailableInAuthorization": "bool",
"tenderAdditionalInfo": {
"tenderInfo": "string",
"hostInfo": "string",
"folioNumber": "string"
},
"giftCardInfo": {

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 35
 IGPOS API | Reference Guide

"GiftCardTenderId": "int",
"CardNumber": "string",
"EncryptionSeed": "int",
"Track1": "string",
"Track2": "string",
"InvoiceId": "string",
"CurrencyCode": "string",
"SaleAmount": "decimal",
"ServiceType": "int",
"RechargeFlag": "bool",
"CashOutFlag": "bool",
"ReturnFlag": "bool",
"AccountId": "string",
"CardExpiration": "string",
"EntryMode": "string",
"SalesFlag": "bool",
"BalanceAmount": "decimal"
},
"genericAuthInfo": {
"Type": "int",
"AuthAccount": "string",
"PostAccount": "string",
"Name": "string",
"BalanceAmount": "decimal",
"ChargedAmount": "decimal",
"PaymentAmount": "decimal",
"PriceLevelID": "iny",
"DiscountID": "int",
"FrankingText1": "string",
"FrankingText2": "string",
"GaAccountDimId": "long",
"GaTypeDimId": "long",
"IsCharity": "bool"
},
"couponInfo": {
"Id": "int",
"CouponDimId": "long",
"Quantity": "int",
"AccountNumber": "string",
"Description": "string",
"PaymentAmount": "decimal",
"CouponSKUCode": "string"
},
"foreignCurrencyInfo": {
"CurrencyDescription": "string",
"CurrencyCode": "decimal",
"CurrencyAmount": "decimal"
},
"dccResponseInfo": {
"CurrencyDescription": "string",
"CurrencyCode": "string",
"CurrencyAmount": "decimal",
"Margin": "decimal",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 36
 IGPOS API | Reference Guide

"ExchangeRate": "decimal"
},
"resortCardInfo": {
"CardNumber": "string",
"Track1": "string",
"Track2": "string",
"CustomerName": "string",
"CustomerId": "string",
"TransactionId": "string",
"BalanceAmount": "decimal",
"HasTrackData": "bool"
},
"allowDuplicateReceipts": "bool",
"cashTenderRoundAmount": "decimal",
"isTenderReducesDiscount": "bool",
"isEarnEligible": "bool",
"isRedeemEligible": "bool",
"cardCode": "string",
"rewardId": "string",
"overrideApprovedBy": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"type": "int",
"adaptorType": "int",
"walletType": "string",
"addOnCharge": {
"addOnAmount": "decimal",
"addOnModifiedVatAmt": "decimal",
"TaxCollection": {
"_dictionayTaxById": {
"c_ExclusiveCost": {
"value": "decimal"
},
"ExclusiveCost": "decimal"
},
"c_InclusiveCost": {
"value": "decimal"
},
"c_ExclusiveCost": {
"value": "decimal"
},
"c_FixedInclusiveCost": {
"value": "decimal"
},
"c_FixedExclusiveCost": {
"value": "decimal"
},
"c_RemovedTaxPercent": {

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 37
 IGPOS API | Reference Guide

"value": "decimal"
},
"ExclusiveCost": "decimal",
"InclusiveCost": "decimal",
"FixedInclusiveCost": "decimal",
"FixedExclusiveCost": "decimal",
"RemovedTaxPercent": "decimal"
},
"Taxes": {
"Details": [
{
"Amount": "decimal",
"Id": "int",
"RoundingConfiguration": {
"roundType": "int",
"roundBasis": "int"
}
}
]
},
"Level": "int",
"Id": "int",
"DimId": "long",
"AddOnCalculationType": "int",
"RoundingConfiguration": {
"roundType": "int",
"roundBasis": "int"
},
"Percentage": "decimal",
"FixedCheckAmount": "decimal",
"FixedCoverAmount": "decimal",
"MinCover": "int",
"MaxCover": "int",
"CanRemovalAtTerminal": "bool",
"CanPayoutAtTerminal": "bool",
"IsAddOnExclusive": "bool",
"IsRemoved": "bool",
"Recipient": "int",
"Employee": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"SalesType": "int",
"AssociatedRevenueCategories": [
"int"
],
"IsAddOnTaxApplicable": "bool",
"UseModifiedVat": "bool",
"RedeemEligible": "bool",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 38
 IGPOS API | Reference Guide

"EarnEligible": "bool",
"IncludeIRSReporting": "bool",
"IsTaxInclusiveItem": "bool",
"AddonGroup": {
"AddonGroupId": "int",
"AddonGroupName": "string",
"ReportRev": "bool",
"IsGratuity": "bool",
"RevCatId": "int",
"AddonGroupDimId": "long"
},
"IsGroupedAddon": "bool",
"IsTenderGrat": "bool",
"TenderDetails": [
" List<Tuple<decimal, bool, decimal>>"
],
"Amount": "decimal",
"ModifiedVatAmount": "decimal",
"ExclusiveAmount": "decimal",
"ExclusiveTaxCost": "decimal"
},
"isPost": "bool",
"additionalCharge": "decimal",
"isCruisetender": "bool",
"index": "int",
"payIndex": "int",
"tenderIndex": "int",
"verificationCodeId": "byte",
"verifyStatus": "int",
"tenderGuid": "Guid",
"changeId": "int",
"cardSource": "int",
"allocatedRevenueAmount": "int",
"associatedTenderGuid": "Guid",
"tipAmount": "decimal",
"changeAmount": "decimal",
"breakageAmount": "decimal",
"currencyAmount": "decimal",
"currencyDecimalPrecision": "int",
"currencyExchangeFactor": "decimal",
"currencyExchangeScale": "int",
"isAuthBenefit": "bool",
"IsAccountsReceivable": "bool",
"IsTaxInvoice": "bool",
"IsOrderReceipt": "bool",
"IsSplitTaxRemoved": "bool",
"IsIRSAllocable": "bool",
"IsAutoRemoveTax": "bool",
"IsAuthBenefit": "bool",
"IsCompTender": "bool",
"IsCreditTender": "bool",
"objectIndex": "int",
"tenderInfo": {

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 39
 IGPOS API | Reference Guide

"roomNumber": "string",
"orderAccountAuthorization": "string",
"orderPostAuthorization": "string",
"orderNameAuthorization": "string",
"orderTenderAdditionalInfo": "string",
"pmsType": "int",
"pmsSubType": "int",
"isSecondarySystem": "bool",
"isLookupOnly": "bool",
"terminalOptionIds": [
"int"
],
"securityToken": "string",
"vendorTransactionId": "string",
"invoiceId": "string",
"ccText": "string",
"p2PEData": "string",
"mechantId": "string",
"authCode": "string",
"auxillaryAuthCode": "string",
"cardNumber": "string",
"accountName": "string",
"cardHolderName": "string",
"cvv": "string",
"expirationDate": "string",
"tenderId": "string",
"tenderDimId": "long",
"settleCode": "string",
"auxillarySettleCode": "string",
"authTime": "int",
"authStatus": "string",
"encryptedCardData": "string",
"encryptionSeed": "unit",
"startDate": "string",
"issueNumber": "string",
"rfidFlag": "bool",
"isRestricted": "bool",
"isAutoRemoveTax": "bool",
"encryptionMode": "int",
"verificationMode": "int",
"entryMode": "int",
"postalCode": "string",
"authSettleData": "string",
"totalAmount": "decimal",
"transactionFollowOnData": "string",
"isFallBack": "bool",
"mode": "string",
"authMode": "string",
"applicationIndentifier": "string",
"applicationLabel": "string",
"issuerApplicationData": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 40
 IGPOS API | Reference Guide

"authorizationResponseCode": "string",
"pinVerificationMode": "string",
"customerReceiptText": "string",
"merchantReceiptText": "string",
"cryptogram": "string",
"reconciliationId": "string",
"correlationId": "string",
"authMethod": "string",
"transactionState": "string",
"isEngageOfflineTender": "bool",
"transactionType": "string",
"cardNumberConverted": "string"
},
"extraInfo": "string",
"extraInfoIndex": "int",
"customerName": "string",
"postingAccount": "string",
"balanceAmount": "decimal",
"destinationProperty": "string",
"sourceProperty": "string",
"pmsSiteId": "int",
"isPostToPms": "bool",
"isPmsAuth": "bool",
"pmsPostSystem1": "bool",
"pmsPostSystem2": "bool",
"pmsPostSystem3": "bool",
"pmsPostSystem4": "bool",
"pmsPostSystem5": "bool",
"pmsPostSystem6": "bool",
"pmsPostSystem7": "bool",
"pmsPostSystem8": "bool",
"signature": [
"byte"
],
"campusCardInfo": {
"TenderId": "int",
"CardNumber": "string",
"EncryptionSeed": "int",
"Track1": "string",
"Track2": "string",
"InvoiceId": "string",
"CurrencyCode": "string",
"SaleAmount": "decimal",
"BalanceAmount": "decimal",
"CampusCardItemCount": "int",
"BalancePoints": "int",
"CardCode": "string"
},
"fsLoyaltyCardInfo": {
"TenderId": "int",
"CardNumber": "string",
"Track1": "string",
"Track2": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 41
 IGPOS API | Reference Guide

"InvoiceId": "string",
"CurrencyCode": "string",
"SaleAmount": "decimal",
"BalanceAmount": "decimal",
"BalancePoints": "int",
"LoyaltyRewardPointsName": "string",
"AvailableLabel": "string",
"AccountName": "string"
},
"smSettleFlag": "int",
"patPaymentId": "string",
"isPatAcknowledge": "bool",
"customerProfileUUId": "string",
"availableBalances": {
"PlayerBalanceType": "string",
"PlayerBalanceAmount": "decimal"
},
"pmsZoominkey": "string",
"loyaltyTenderData": {
"Points": "int",
"PromoCode": "string",
"PromoName": "string",
"PromoType": "int",
"MenuId": "int",
"MenuQty": "int",
"MenuUnitPrice": "decimal",
"ExtraInfo": "string"
},
"authMode": "string",
"isPatAuth": "bool",
"receiptsToPrint": "int",
"isDeposit": "bool",
"realTimePostSiteId": "short",
"isAuth": "bool",
"tenderClassId": "byte",
"accountType": "byte",
"splitCheckId": "byte",
"amountMaxAuth": "decimal",
"authFlags": "byte",
"authOnlyFlag": "bool",
"voidFlag": "bool",
"amt_auto_adjusted": "bool",
"hostCapture_flag": "bool",
"pms_fidelio_flag": "bool",
"amt_tpg_auth": "int",
"emvMobileFlag": "bool",
"isSendRequestToPmsHost": "bool"
}
],
"isVATModeEnabled": "bool",
"isLimitedReopenFlag": "bool",
"isIGTerminal": "bool",
"receiptText": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 42
 IGPOS API | Reference Guide

"auxReceiptText": "string",
"receiptPrintCount": "int",
"noOfDecimals": "int",
"revenuecategories": {
"Id": "int",
"RevCatDimId": "long",
"GroupId": "string",
"IRSFlag": "bool",
"SalesAmount": "decimal",
"DiscountAmount": "decimal",
"ExclusiveTaxAmount": "decimal",
"NoTaxNetSales": "decimal",
"SalesAmountTaxInclusive": "decimal",
"TaxIclusiveItemDiscountAmount": "decimal",
"InclusiveTaxAmount": "decimal",
"TaxCode": "string",
"IsTenderRestricted": "bool"
},
"giftCardCreditInfo": {
"Status": {
"Code": "string",
"Message": "string",
"DebugMessage": "string"
},
"CardData": {
"CardNumber": "string",
"CardClassifier": "object",
"CVV2": "object",
"PinNumber": "object",
"CardExpiration": "DateTime",
"CardTrackOne": "object",
"CardTrackTwo": "object",
"AddressVerification": "object",
"SecurityToken": "object",
"CardDataSource": "string"
},
"AvailableBalance": {
"Amount": "",
"Currency": ""
},
"InvoiceID": "string",
"HandleData": "string",
"TenderID": "string",
"IsSale": "bool"
},
"giftCardBalance": "decimal",
"campusCardBalance": "decimal",
"isReopen": "bool",
"modifiedVatDifferenceAmt": "decimal",
"preAuthTaxAmount": "decimal",
"isModifiedVatToServiceCharge": "bool",
"currentCourseId": "int",
"vipSeat": [

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 43
 IGPOS API | Reference Guide

"bool"
],
"seatTotal": [
"decimal"
],
"fiscalInfo": "string",
"fiscalText": "string",
"fiscalTaxSummary": "string",
"taxInvoiceNumber": "string",
"quebecCheckDate": "string",
"guestAccountNumber": "string",
"inventoryUpdateList": {},
"matchContext": {
"MatchPackageId": "int",
"MatchPackages": {
"int": [
{
"Index": "int",
"Items": [
{
"MatchList": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{}
]
}
]
}
],
"ChildMatchItems": [
{

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 44
 IGPOS API | Reference Guide

"MatchList": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{
"ComboType":
"int",
"ItemType": "int",
"Id": "int",
"PackageId":
"int",

"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex":
"int",
"Amount":
"decimal",
"IsSaved": "bool",
"ChildItems": [
{}
]
}
]
}
],
"ChildMatchItems": [
{}
],
"QuantityNeeded": "int"
}
],
"QuantityNeeded": "int"
}
],
"MatchedPackages": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 45
 IGPOS API | Reference Guide

"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{}
]
}
]
}
],
"BackupMatches": [
{
"MatchList": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{}
]
}

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 46
 IGPOS API | Reference Guide

]
}
],
"ChildMatchItems": [
{
"MatchList": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{
"ComboType":
"int",
"ItemType": "int",
"Id": "int",
"PackageId":
"int",

"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex":
"int",
"Amount":
"decimal",
"IsSaved": "bool",
"ChildItems": [
{}
]
}
]
}
],
"ChildMatchItems": [
{}
],
"QuantityNeeded": "int"
}
],
"QuantityNeeded": "int"
}
],
"BackupMatchesList": [
{
"ComboType": "int",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 47
 IGPOS API | Reference Guide

"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{}
]
}
]
}
],
"BackupMatchPackages": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 48
 IGPOS API | Reference Guide

{}
]
}
]
}
],
"Package": {
"Id": "int",
"AutoPackage": "int",
"Priority": "int",
"PackageItems": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{
"ComboType": "int",
"ItemType": "int",
"Id": "int",
"PackageId": "int",
"SelectionGroupId": "int",
"Quantity": "int",
"Sequence": "int",
"CheckIndex": "int",
"Amount": "decimal",
"IsSaved": "bool",
"ChildItems": [
{}
]
}
]
}
],
"TotalPrice": "decimal",
"Quantity": "int"
}
}
]
},
"RejectedPackages": {},
"IsAutoPackaged": "bool",
"IsFullScan": "bool",
"LastIndexScanned": "int"
},
"rejectedPackages": {},

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 49
 IGPOS API | Reference Guide

"fiscalLotteryCode": "string",
"additionalInfo": {
"string": "string"
},
"colombiaCustomInfo": {
"string": "string"
},
"indiaGuestInfo": {
"GuestId": "int",
"GSTIN": "string",
"StateCode": "string",
"FirstName": "string",
"LastName": "string",
"AddressField1": "string",
"AddressField2": "string",
"AddressField3": "string",
"AddressField4": "string"
},
"irnNumber": "string",
"banquetDataInfo": [
"string"
],
"orNumber": "string",
"arNumber": "string",
"refundSeqNumber": "string",
"voidSeqNumber": "string",
"dataString": [
"string"
],
"starbucks": {
"TransactionNumber": "string",
"SourceTransactionNumber": "string",
"UtcOffset": "string",
"RetryIndicator": "bool",
"MerchantId": "string",
"Store": {
"StoreNumber": "string",
"SourceStoreNumber": "string",
"RegisterNumber": "string"
},
"LoyaltyMember": {
"MemberUId": "string",
"CardNumber": "string",
"Name": {
"FirstName": "string",
"LastName": "string"
},
"Program": {
"Name": "string"
},
"TierSummary": {
"Id": "int"
},

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 50
 IGPOS API | Reference Guide

"PointSummary": {
"TierPoints": "decimal",
"RewardPoints": "decimal",
"RewardPointsRedeemed": "string",
"RewardPointsAvailable": "string"
},
"RewardSummary": {
"Coupons": {
"Id": "Guid",
"Name": {
"ShortName": "string",
"LongName": "string"
},
"RewardCode": "int",
"ExpiryDate": "DateTime",
"RedemptionDetail": {
"AllowedCount": "int",
"RedeemedCount": "int"
},
"ItemId": "int",
"OrderIndex": "int",
"ModifierId": "int",
"ModifierIndex": "int",
"IsEligible": "bool",
"Quantity": "int",
"Discount": {
"Id": "int",
"DimId": "long",
"Level": "int",
"DiscountSKUCode": "string",
"SecurityId": "int",
"ProfitCenterGroupId": "int",
"IsFixed": "bool",
"IsPercentage": "bool",
"IsExclusive": "bool",
"AffectTax": "bool",
"Value": "decimal",
"MaxValue": "decimal",
"PromptExtraCode": "int",
"PromptOpen": "bool",
"AllowedRevenueGroup": [
"int"
],
"DiscountRule": {
"RuleId": "int",
"RuleDimId": "long",
"RuleDateFrom": "string",
"RuleDateTo": "string",
"RuleStartTimeMinutes": "int",
"RuleEndTimeMinutes": "int",
"RuleRecurrenceType": "int",
"RuleDayofweekMask": "int",
"RuleDayofmonth": "int",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 51
 IGPOS API | Reference Guide

"RuleOrdinalDay": "int",
"RuleMonthofyear": "int",
"RuleRevenueGroup": "int",
"IsItemCriteriaEnabled": "bool",
"MinItemQuantity": "int",
"ItemPriceDiscount": "int",
"RuleConstraintJoin": [
{
"RuleConstraintId": "string",
"RelevantIds": [
{
"Id": "int",
"ItemFlag": "int"
}
]
}
]
},
"Tier": {
"TierId": "int",
"TierName": "string",
"CMSId": "int",
"MaxLimit": "decimal",
"RewardValue": "string",
"TierDesc": "string"
},
"ExtraData": "string",
"IsTenderReducesDisc": "bool",
"splitDiscFlag": "bool",
"IsAffectGratuity": "bool",
"IsAffectServiceCharge": "bool",
"IsStarbucksDiscount": "bool",
"StarbucksDiscountInfo": {
"MerchantId": "string",
"TransactionNumber": "string",
"IsSaved": "bool",
"IsVoided": "bool",
"StoreNumber": "int",
"RegisterNumber": "int",
"Sequence": "int",
"RedemptionSequence": "int",
"ItemId": "long",
"DiscountId": "int",
"RewardCode": "int",
"IsCouponDisc": "bool",
"ModifierId": "int"
},
"IsRCCLDiscount": "bool",
"RCCLDiscountInfo": {
"PromotionID": "string",
"PromoName": "string",
"Points": "int",
"MenuItemId": "int",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 52
 IGPOS API | Reference Guide

"Quantity": "int",
"UnitPrice": "decimal"
},
"ACESDiscountInfo": {
"PromotionID": "int",
"PromoName": "string",
"PrizeID": "int",
"PackageID": "int",
"Amount": "decimal",
"PrizeType": "int",
"PromoProductClassName": [
"string"
],
"DiscExtraText": "string",
"AppliedItemIndex": [
{
"int": [
{
"int": "decimal"
}
]
}
],
"PackageItemIndex": "",
"IsTaxable": "bool",
"IsTaxOnOldPrice": "bool"
},
"MinCartAmount": "",
"PMSAccountDiscountMaxCap": "",
"IsPMSAccountDiscount": ""
}
}
}
},
"RewardCode": "int",
"PointSummary": {
"TierPoints": "decimal",
"RewardPoints": "decimal",
"RewardPointsRedeemed": "string",
"RewardPointsAvailable": "string"
},
"StarbucksDiscountInfo": {
"MerchantId": "string",
"TransactionNumber": "string",
"IsSaved": "bool",
"IsVoided": "bool",
"StoreNumber": "int",
"RegisterNumber": "int",
"Sequence": "int",
"RedemptionSequence": "int",
"ItemId": "long",
"DiscountId": "int",
"RewardCode": "int",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 53
 IGPOS API | Reference Guide

"IsCouponDisc": "bool",
"ModifierId": "int"
}
},
"loyaltyCredit": {
"LoyaltyCreditIndexId": "int",
"CreditAmount": "decimal"
},
"loyaltyTenderData": {
"Points": "int",
"PromoCode": "string",
"PromoName": "string",
"PromoType": "int",
"MenuId": "int",
"MenuQty": "int",
"MenuUnitPrice": "decimal",
"ExtraInfo": "string"
},
"empTipGratScData": [
{
"EmpId": "int",
"TipAmt": "decimal",
"GratAmt": "decimal",
"SvcChgAmt": "decimal"
}
],
"bonusCodeData": {
"BonusIndex": "int",
"BonusCode": "string"
},
"splitPaymentByTypeDetail": {
"SplitSelectionType": "int",
"NoOfSplits": "string",
"SplitPaymentDetails": [
{
"SplitPercentage": "string",
"SplitAmount": "string",
"SplitAmountMaxThreshold": "string"
}
]
},
"isCasinoEnabled": "bool",
"isFoodServiceLoyaltyEnabled": "bool",
"istO185Enabled": "bool",
"isBrunswickInterfaceEnabled": "bool",
"isCompleteTender": "bool",
"closedChecks": {
"string": "string"
},
"openTimeInMilliSeconds": "long",
"closeTimeInMilliSeconds": "long",
"deliveryInfo": {
"CustomerName": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 54
 IGPOS API | Reference Guide

"Address": "string",
"PostalCode": "string",
"Phone": "string",
"PickUpTime": "string",
"Cutlery": "string",
"Type": "string",
"Email": "string"
},
"checkObjectType": "int",
"subCheckAddons": "decimal",
"uniqueKeyNumber": "long",
"isScheduledCheckFinalPayment": "bool",
"associatedCheckList": [
"string"
],
"kssEventType": "int",
"addOnCharges": [
{
"addOnAmount": "decimal",
"addOnModifiedVatAmt": "decimal",
"TaxCollection": {
"_dictionayTaxById": {
"c_ExclusiveCost": {
"value": "decimal"
},
"ExclusiveCost": "decimal"
},
"c_InclusiveCost": {
"value": "decimal"
},
"c_ExclusiveCost": {
"value": "decimal"
},
"c_FixedInclusiveCost": {
"value": "decimal"
},
"c_FixedExclusiveCost": {
"value": "decimal"
},
"c_RemovedTaxPercent": {
"value": "decimal"
},
"ExclusiveCost": "decimal",
"InclusiveCost": "decimal",
"FixedInclusiveCost": "decimal",
"FixedExclusiveCost": "decimal",
"RemovedTaxPercent": "decimal"
},
"Taxes": {
"Details": [
{
"Amount": "decimal",
"Id": "int",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 55
 IGPOS API | Reference Guide

"RoundingConfiguration": {
"roundType": "int",
"roundBasis": "int"
}
}
]
},
"Level": "int",
"ChargeType": "int",
"Id": "int",
"DimId": "long",
"AddOnCalculationType": "int",
"RoundingConfiguration": {
"roundType": "int",
"roundBasis": "int"
},
"Percentage": "decimal",
"FixedCheckAmount": "decimal",
"FixedCoverAmount": "decimal",
"MinCover": "int",
"MaxCover": "int",
"CanRemovalAtTerminal": "bool",
"CanPayoutAtTerminal": "bool",
"IsAddOnExclusive": "bool",
"IsRemoved": "bool",
"Recipient": "int",
"Employee": {
"Id": "string",
"EmployeeDimId": "long",
"EmpShiftId": "long",
"EmpJobCode": "string",
"Name": "string",
"Percentage": "decimal"
},
"SalesType": "int",
"AssociatedRevenueCategories": [
"int"
],
"IsAddOnTaxApplicable": "bool",
"UseModifiedVat": "bool",
"RedeemEligible": "bool",
"EarnEligible": "bool",
"IncludeIRSReporting": "bool",
"IsTaxInclusiveItem": "bool",
"AddonGroup": {
"AddonGroupId": "int",
"AddonGroupName": "string",
"ReportRev": "bool",
"IsGratuity": "bool",
"RevCatId": "int",
"AddonGroupDimId": "long"
},
"IsGroupedAddon": "bool",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 56
 IGPOS API | Reference Guide

"IsTenderGrat": "bool",
"TenderDetails": [
" List<Tuple<decimal, bool, decimal>>"
],
"Amount": "decimal",
"ModifiedVatAmount": "decimal",
"ExclusiveAmount": "decimal",
"ExclusiveTaxCost": "decimal"
}
]
}

□ Refer to the following table for the descriptions.

Field Description
employeeLastLoginDateTime Indicates the last login date and time of the employee.
orderReceiptNumber Indicates the check number.
isoCountryCode The country code configured in the Enterprise form of the
Universal Desktop.
isoCurrencyCode The currency code configured in the Enterprise form of the
Universal Desktop.
checkOpenSourceType Identifies the source from where the check is opened. The
following are the available source types:
▪ 0 - Name unknown
▪ 1 - POS Terminal Application
▪ 2 - PMS Log Writer
▪ 3 - ATPG
▪ 4 - Order Web API
▪ 5 - Tender Check Web API
▪ 6 - POSAPI
checkClosedSourceType Identifies the source from where the check is opened. The
following are the available source types:
▪ 0 - Name unknown
▪ 1 - POS Terminal Application
▪ 2 - PMS Log Writer
▪ 3 - ATPG
▪ 4 - Order Web API
▪ 5 - Tender Check Web API
▪ 6 - POSAPI
terminal
id A numerical value within a range of [1-9999] that gives a
unique identity to the POS terminal.
terminalDimId For internal purpose.
tenderedTermId The terminal ID where the check has been tendered.
tenderedTerminalDimId For internal purpose.
profitCenter A string supporting up to 30 characters denotes the name of
the Profit Center.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 57
 IGPOS API | Reference Guide

Field Description
profitCenterDimId For internal purpose.
printTermId This ID is used to identify the terminal whose printer is used for
printing the receipt.
ipAddress Denotes the IP Address of the terminal.
terminalModes Indicates modes of Financials Calculation for a Terminal. The
following are the available modes:
▪ Normal - 0
▪ VAT - 1
▪ GratuityInclusive - 2
▪ ModifiedVAT - 3
mealPeriodDimId For internal purpose.
openedProfitCenterDimId For internal purpose.
openedProfitCenterId A unique and modifiable value within a range of [1-999] that
identifies the profit center. Some of the Property Management
Systems (PMS) interfaces allow only up to the range of [1-99].
context
CustomerId Customer ID using POS API.
EnterpriseId Enterprise ID of the client using POS API.
DivisionId Division ID of the client using POS API.
StoreId Store ID of the client using POS API.
TerminalId A numerical value within a range of [1-9999] that gives a
unique identity to the POS terminal.
PropertyDTTM Indicates the current date and time.
CurrencyCulture The name of the currency culture mapped to the store.
Example: en-us.
TimeZone Indicates the time zone in which the schedule runs. By default,
the system takes the server time zone. It must be set to local
time zone.
ProfileId Profile ID associated with the client.
financialBins
Type Indicates the type of Financial Bin:
▪ Revenue: 1
▪ Discount: 2
▪ Tax: 3
▪ Gratuity: 4
▪ Service Charge: 5
▪ Tip: 6
▪ Round: 7
▪ Part Bins: 8
▪ Inclusive Tax: 9
▪ Exclusive Tax: 10
▪ Grat Tax: 11

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 58
 IGPOS API | Reference Guide

Field Description
▪ Service Charge Tax: 12
Id A unique value identifying the financial class.
Amount Denotes the monetary amount for the financial bin.
Quantity The quantity of Financial Bin of the same type that has been
applied.
checkType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.
checkTypeDimId For internal purpose.
checkPassCount The count indicating the passes that the check has been
through. Every time a check is opened/recalled and saved is
considered as one pass
gratuityState The state of the gratuity applied in the check. It includes:
▪ Normal - Gratuity applied as per check calculations.
▪ Removed - Gratuity removed.
▪ Modified - Gratuity has been modified manually.
serviceChargeState The state of the service charge applied in the check. It
includes:
▪ Normal - Service charge applied as per check calculations.
▪ Removed - Service charge removed.
▪ Modified - Service charge has been modified manually.
isRefund ▪ True - Refunds the current check by creating a negative
value check. This is to balance out the original check.
▪ False - Check is not refunded.
isRestrictAlcoholItems ▪ True - The sale of alcohol items is restricted to guests.
▪ False - The sale of alcohol items is not restricted to guests.
isRestrictTobaccoItems ▪ True - The sale of tobacco items is restricted to guests.
▪ False - The sale of tobacco items is not restricted to
guests.
isClosedRefund ▪ True - Recalls a closed check and allows refund of the
check.
▪ False - Closed check remains closed and not refunded.
isTaxRemoved ▪ True - POS operators can remove the tax associated with
the item.
▪ False - POS operators cannot remove the tax associated
with the item.
checkHandle
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 59
 IGPOS API | Reference Guide

Field Description
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
longCheckNumber A check number to uniquely identify across the system. The
long check number is the combination of current date, time,
and the counter.
orderCodeNumber It is a number that is displayed in IG KDS instead of check
number. This number is generated using OrderCode
configured in Terminal and checknumber.
associatedCheckNumber Indicates the parent check number. For example, when the
check is a refund check, the associated check number is the
check number of the original transaction that is subjected to
refund.
associatedLongCheckNumber Indicates the parent long check number. For example, when
the check is a refund check, the associated long check number
is the long check number of the original transaction that is
subjected to refund.
mealPeriod A particular period in a day to categorize specific items, price
levels, and others. Also, Meal Period is used to generate
reports, such as sales performance report, product mix report,
etc., for that particular period of the day.
isLiveEntertainmentTax ▪ True - Activates the use of live entertainment tax support
for an enterprise.
▪ False - The live entertainment tax is not supported for the
enterprise.
isGDPR ▪ True - The guest names are not stored in the InfoGenesis
database as it is compliant with the EU General Data
Protection Regulation.
▪ False - The guest names are stored in the InfoGenesis
database.
isCompTenderRemoveTax ▪ True - This enterprise-level setting removes taxes prior to
determining the percentage of the check amount that is a
comp. This is an enterprise-level setting.
▪ False - The taxes are not removed prior to determining the
percentage of the check amount.
isSaveCasinoPlayerDetails ▪ True - The patron’s name and ID, along with the voucher
name and ID are saved in the InfoGenesis database.
▪ False - The patron’s name and ID are not saved in the
InfoGenesis database.
mealPeriodDimId For internal purpose.
voidReasonDimId For internal purpose.
PriceLevel Denotes the configured price level for items.
VoidInfo
id A unique value identifying the void.
time Indicates the time of the void.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 60
 IGPOS API | Reference Guide

Field Description
timeTicks For internal purpose.
reason A short reason to support the void.
voidedBy
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
overrideApprovedBy
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
dimId For internal purpose.
isConsumed ▪ True - The item is consumed, and no quantities of that item
remain available either at the selected profit center or
inventory.
▪ False - The item is not consumed and is still available for
sale.
tableNumber A unique number labelled for a table.
orderNumber It is a sequential number that is printed on the guest’s receipt,
and it is different from the check number.
isCheckLabel ▪ True - A label is assigned to the check with a maximum of
20 alphanumeric characters.
▪ False - No label is assigned to the check.
evenSplitCount The number of ways in which a check can be evenly split.
splitIdx Index of the partial payments performed in a check.
isRestrictedTOGratAndTip ▪ True - The restricted tenders are allowed to pay gratuities
and tips.
▪ False - The restricted tenders are not allowed to pay
gratuities and tips.
NOTE - The Terminal Option 492 (Allow restricted tenders to
apply to gratuities and tips) and Terminal Option 490
(Automatically split check when using restricted tenders) are
the related terminal options.
isRestrictedTOServiceCharge ▪ True - The restricted tenders are allowed to pay service
charges.
▪ False - The restricted tenders are not allowed to pay
service charges.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 61
 IGPOS API | Reference Guide

Field Description
NOTE - The Terminal Option 491 (Allow restricted tenders to
apply to service charges) and Terminal Option 490
(Automatically split check when using restricted tenders) are
the related terminal options.
evenSplitAmount Indicates the check amount that must be evenly split in the
required number of ways.
defaultItemKitchenStatus Indicates the kitchen status for the item. The following are the
two status indicators:
▪ 0 - The item is fired to kitchen.
▪ 1 - The item is on hold. It is yet to be fired.
evenSplitFinalAmount Indicates the final amount after splitting the check evenly in the
required number of ways.
dataTag The name of the guest whose account has been tagged to the
check
dataTagType The type of the account that the guest has used. The following
are the available account types:
▪ 0 - None
▪ 1 - GA
▪ 2 - InteractiveAccount
▪ 3 - Loyalty
▪ 4 - Member
▪ 5 - Folio
▪ 6 - Banquet
▪ 7 - CampusCard
checkSearchType Identifies the value that is used to search the check. The
following are the different check search types:
▪ 0 - Normal
▪ 1 - Label
▪ 2 - Table
▪ 3 - Room Number
▪ 4 - Master check
taggedAccountId The account ID of the guest that has been tagged to the check.
recalledCheckLastQSRIndex The index of the last saved check in QSR.
overrideApprovedBy
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
previouslyAddedItemIndex The index of the item that was last added to the check.
checkStatus Indicates the order status.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 62
 IGPOS API | Reference Guide

Field Description
▪ Success - Represents the order is sent to the kitchen
printer of kitchen video.
▪ Pending - Represents the check is created and it is yet to
be sent to the kitchen printer or kitchen video. When the
terminal goes offline and terminal option 1202 is enabled,
the status changes to Failed.
▪ Failed - When the terminal goes offline and the terminal
option 1202 is disabled, the status changes to Failed.
▪ Expired - When the order does not reach the kitchen
printer or kitchen video even after many attempts, the
status of the check turns into Expired.
▪ Cancelled - When an order is cancelled, this status
appears.
isSplitted ▪ True - The check is a split check.
▪ False - The check is not a split check.
isSplitParentCheck ▪ True - The check is the base check from which the splits
were created.
▪ False - The check is not the base check.
splitSeatId A unique value identifying the seat of a split check. When a
check is split, all the items in the check can be divided into
separate checks and assigned to a particular seat.
splitAllItemsCount The total number in which a check is split, particularly in large
group dining. It is possible to split a single check among 2-250
members, and each check can have its own check number with
the required portion of the meal.
isOfflineCheck ▪ True - Denotes that a check is saved or tendered while the
terminal is offline or in LSS mode. The status of the check
appears as pending as it is not updated in the database.
▪ False - Denotes that it is not an offline check. The check is
created when the terminal is online and gets uploaded to
database immediately.
guestInfo
Id A unique identity value assigned to the guest.
Name A string value that indicates the name of the guest.
AccountType Denotes the type of account that the guest holds.
Tier Indicates the guest’s tier level.
Pin Indicates the guest’s pin.
RewardPoints The total reward points earned by the guest.
MerchantId A unique merchant identifier that lies within a range of 1-16
characters. This value is used to identify check transactions.
MemberUId A unique identifier of an active loyalty member. This is not
applicable for country codes that support MSR 2.0.
StoreNumber A unique number allocated to the store.
RegisterNumber Indicates the guest’s register number.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 63
 IGPOS API | Reference Guide

Field Description
TransactionNumber A unique reference number identifying a transaction. When the
transaction number is not available, check number is used.
customerCentricDiscountData
DiscountId ID of the discount.
Percentage The percentage of the discount.
splitAmount The final amount after splitting the original check into possible
number of ways.
splitAmountMax For internal purpose.
splitAmountMaxThreshold Indicates the maximum split amount for a given check.
roundAmount Indicates the rounded amount from the actual price of a check.
It can be rounded up or down to the nearest unit, depending on
the requirements.
checkTotal The total amount of the check that has to be tendered.
checkTotalWithoutRound The actual price of the check without rounding its value to the
nearest unit.
grossAmount The amount on the check minus the returns and refunds prior
to discounts, tax, tip, gratuity, and service charges calculated. If
an item is tax inclusive, the tax is not considered while
calculating the gross amount.
amount The actual total price of items without tax, gratuity, and service
charge.
charityAmount The amount that is credited to GA account.
charityRoundAmount The balance amount that is required to round the check total.
discountAmount The discounted amount from the total value of the check.
tax Indicates the tax amount that gets added to the check.
inclusiveTax ▪ True - The tax gets added to the check for the list of all
items included.
▪ False - No tax gets included in the check.
serviceChargeValue A fixed charge paid to the service provider for availing their
service.
groupedServiceChargeValue The sum of service charges for the configured add-ons in the
service charge. This applicable for 12.x sever only.
gratuityValue Indicates the gratuity value associated with the check.
groupedGratuityValue The sum of gratuities for the configured add-ons in the gratuity.
This applicable for 12.x sever only.
withheldValue The amount calculated for withheld add-on type.
tipValue Indicates the tip amount.
restrictedAmount The total amount that is associated with restricted items in the
check.
unRestrictedItemTaxAmount The tax amount applicable to unrestricted items added to the
check.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 64
 IGPOS API | Reference Guide

Field Description
restrictedCheckItemAmount Indicates the total price of a restricted check. A restricted check
is a type of check that contains an item from the restricted
product class.
unRestrictedItemAmount The total value of the unrestricted items added to the check.
balanceAmountAfterAutoRemo The check balance after the tax has been removed
valTax automatically on applying a check type or tender.
restrictedTenderAmount The amount in check that has been paid using a restricted
tender.
restrictedTenderedTipAmount The proportional tip amount in check that has been paid using
a restricted tender
hyattGoldPassFlag ▪ True - The Hyatt Gold Pass configuration is enabled.
▪ False - The Hyatt Gold Pass configuration is disabled.
creditTender The amount that is credited to the GA account as donations.
openGratuityPercent Denotes the gratuity on a percentage basis. Unlike a fixed
percentage, this percentage can be varied.
openServiceChargePercent Denotes the service charge on a percentage basis. Unlike a
fixed percentage, this percentage can be varied.
openGratuityAmount Denotes the gratuity on an amount basis. Unlike a fixed
amount, this amount can be varied.
openServiceChargeAmount Denotes the service charge on an amount basis. Unlike a fixed
amount, this amount can be varied.
balanceAmount The amount balance due in the check.
authorizedAmount Indicates the acknowledged or verified amount of the check. If
the check value exceeds above the authorized amount, then
user require authorization to tender the check.
UnUsedTip The amount of unpaid tip in a check.
UnUsedTip2 The amount of unpaid tip in a check. The tip is accumulated
here only when the Terminal Option 1299 (Allow tip addition
into check financial without any restrictions) is enabled.
currentTenderId A unique value identifying the tender in a selected or active
check.
currentTenderTipAmount The tip amount that is paid using the current tender.
currentTenderAmount The total amount of the selected check that has to be tendered.
tenderAmountAfterTaxRemova The total amount of the check that has to be tendered after
l removing the tax.
tenderDiscountAmount The value of discount applied as a result of applying a tender.
applicableRestrictedTenderAm The remaining amount in check that can be paid using a
ount restricted tender
isCurrentTenderRestricted ▪ True - A selected or active tender is restricted when it
includes items belonging to a restricted revenue category.
▪ False - A selected or active tender is not restricted on any
basis.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 65
 IGPOS API | Reference Guide

Field Description
isCurrentTenderAutoRemoveT ▪ True - Removes tax automatically for the value of the
ax tender applied to the check.
▪ False - Tax gets included for the value of the tender
applied to the check.
selectionGroupMaxCheckTotal ▪ True - The item selected has exceeded the maximum
ValidationFailed check total.
▪ False - The item selected has not exceeded the maximum
check total.
payAtTableCheckId A unique value identifying the pay at table checks.
teamId Team serving ID.
teamName The name of the team.
teamMembers
Id The ID of the employee in the team.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
inclusiveGratuity The price of the item including the tip.
inclusiveServiceCharge The price of the item including the service charge.
isInclusiveGratuityModeEnable ▪ True - The tip is added in the price of the item, and do not
d appear separately on the receipts.
▪ False - The gratuity appears separately on the receipts.
purchaseCode This code refers to the purchase sequence when HardRock
loyalty is enabled.
kitchenSchedule
ScheduledTime The scheduled time of the order.
KPJobId A unique value to identify the scheduled kitchen printer job.
KVJobId A unique value to identify the scheduled kitchen video job.
checkLoyaltyInfo
OriginalBalance The balance amount before redeeming the accrued points.
NewBalance The balance amount after redeeming the accrued points.
RedemptionPoints The total number of redeemed points.
AccruedPoints The total accrued points that can be redeemed.
EligibleEarnAmount The minimum amount to earn accruals.
EligibleRedeemAmount The minimum amount to redeem the earned accruals.
AccrualState For internal purpose.
AccrualStatusCode For internal purpose.
dataInteger For internal purpose.
engageAccuralTransactionId Transaction ID associated with the Engage accrual.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 66
 IGPOS API | Reference Guide

Field Description
balanceAmountWithoutRoundi The remaining balance amount (without rounding) after the
ng redeem.
isAlcoholEligible ▪ True - The alcohol items can be sold to guests.
▪ False - The alcohol items cannot be sold to guests.
isTobaccoEligible ▪ True - The tobacco items can be sold to guests.
▪ False - The tobacco items cannot be sold to guests.
isAgeManuallyVerified ▪ True - The age is verified manually.
▪ False - The age is verified automatically.
barCodeVerificationStatus Indicates the status of verification.
▪ 0 - No Verification
▪ 1 - Automatic Verification
▪ 2 - Manual Verification
offerNumber For internal purpose.
referenceNumber For internal purpose.
isEntDecimalFlag ▪ True - The decimal format configured in the Enterprise
form is considered for the entire check transaction.
▪ False - The configured decimal format is not considered for
the check calculation.
isCMPPIIEncrypt ▪ True - The casino guest information is encrypted.
▪ False - The casino guest information is not encrypted.
maxDiscountLimitPerCheck The maximum discount limit for a check.
isEncrypted ▪ True - The guest information is encrypted.
▪ False - The guest information is not encrypted.
changeAmount The amount that is to be returned to guest after the sale.
isIRSEnabled For internal purpose.
hasAnyHoldItems ▪ True - The items in the check are in hold status.
▪ False - The items in the check are fired to kitchen.
isGiftCardUnMask ▪ True - The giftcard account details are not masked.
▪ False - The giftcard account details are masked.
syncId For internal purpose.
breakageAmount The balance from an over tender which is not returned to the
guest or used as a tip.
Example: If a $10 voucher is used for $6 check, the $4 is
considered as the breakage amount.
discountMultiModeFlag ▪ True - Multiple discounts can be applied to the check/item.
▪ False - Multiple discounts are not supported.
openTime The timestamp of when the check was opened.
Example: 2023-12-19T10:24:27
openTimeTicks The time at which the check was opened. It follows the epoch-
time format.
openedBy
Id A unique number [1 to 999,999,999] assigned to an employee.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 67
 IGPOS API | Reference Guide

Field Description
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
CloseTime The timestamp of when the check was closed.
Example: 2023-12-19T10:24:27
closeTimeTicks The time at which the check was closed. It follows the epoch-
time format.
closedBy
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
checkCoverCount Indicates the number of covers per check.
checkItems
objectIndex For internal purpose.
packageId A unique value identifying the package.
itemCoverCount Indicates the number of covers per item.
quantity The quantity of financial bin of the same type that has been
applied.
quantityFraction The quantity fraction after an item is split. For example if 3
quantity of item is split into 5 parts, the quantity fraction would
be 3/5.
seatNumber Indicates the seat number for which the items are intended.
courseId A unique value to identify the course.
index The index of items in a check.
isSaved ▪ True - The check gets saved to the terminal and it can be
recalled, voided, refunded, or closed depending on the
requirements.
▪ False - The check is not saved to the terminal.
isVoided ▪ True - The item in the check is voided with appropriate
security levels.
▪ False - The item in the check is not voided.
voidReasonId A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 68
 IGPOS API | Reference Guide

Field Description
▪ Void Reason 255 = Reopen Check
voidReasonDimId For internal purpose.
isTaxRemoved ▪ True - POS operators can remove the tax associated with
the item.
▪ False - POS operators cannot remove the tax associated
with the item.
isPriceOverride ▪ True - Overrides the scanned price of a retail item.
▪ False - Does not override the scanned price of a retail
item.
isReturnItem ▪ True - Allows return/exchange on an item.
▪ False - Does not allow return/exchange on an item.
isRestricted ▪ True - A tender is restricted when it includes items
belonging to a restricted revenue category.
▪ False - A tender is not restricted on any basis.
overrideApprovedBy
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
orderItemType Defines the order item type. It can be normal items or
modifiers, or packages.
cost Indicates the price of every item in the check with the currency
symbol and the language that is selected on the Enterprise
form.
discountAmount Represents the discounted price from the total value of the
check.
totalTaxAmount Represents the total tax levied for all the items added to the
check.
fixedExclusiveTaxAmount For internal purpose.
isConsumed ▪ True - The item is consumed, and no quantities of that item
remain available either at the selected profit center or
inventory.
▪ False - The item is not consumed and is still available for
sale.
name The name of the item.
orderitems
kpStatus Kitchen printing status.
KvStatus Kitchen video status.
isOpenItem ▪ True - The item is an open item.
▪ False - The item is not an open item.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 69
 IGPOS API | Reference Guide

Field Description
kitchenDepartmentId A system generated or manually entered unique number in the
range of [1-999] identifying the specific kitchen workstations.
isSoldByWeight ▪ True - The function activates the Tare Weight field as the
item’s base price is the price per unit of weight (Pound,
Kilogram, gram, etc.,)
▪ False - Denotes the item is not sold on a weight basis.
isMaxItemPrice ▪ True - It is the maximum price of the item. Employee
cannot override the item price during the transaction.
▪ False - It is not the maximum price of the item. Employee
can override the item price.
replacedItemDimId For internal purpose.
replacedItemId For internal purpose.
maxItemPrice The maximum price of the item.
isTaxInclusive ▪ True - Tax is included for the listed items in the check.
▪ False - Tax is not included for the listed items in the check.
isStockItem ▪ True - The item is a stock item.
▪ False - The item is not a stock item.
weight If the item is sold by its weight, this field denotes the weight of
the item listed in the check.
productClassId A system generated or manually entered unique value in the
range of [1-9999] to identify the product class.
boxCarCost The check total amount without taxes that were included to the
item prices.
taxAmount Indicates the tax levied for items listed on a check.
discountAmount Indicates the discounted price from the total price of the check.
inclusiveTaxAmount The amount of inclusive tax calculated.
revenueCategory
id A system generated or manually entered unique value in the
range of [1-99] to identify the revenue category.
revCatDimId For internal purpose.
groupId A unique value identifying the revenue group category.
irsFlag For internal purpose.
salesAmount The amount for which sale is being made.
discountAmount The discount amount associated with the check.
exclusiveTaxAmount The non-inclusive tax amount.
noTaxNetSales The cost of the item without discount amount, inclusive gratuity,
and inclusive service charge.
salesAmountTaxInclusive The tax amount associated with the sale price.
taxInclusiveItemDiscountAmou The tax amount associated with the total item discount price.
nt
inclusiveTaxAmount The amount of inclusive tax calculated.
taxCode A unique string identifying the tax category.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 70
 IGPOS API | Reference Guide

Field Description
isTenderRestricted ▪ True - The specified item is tender restricted item.
▪ False - The specified item is not a tender restricted item.
openItem
id Item ID.
name The name of the item.
kitchenItemIndex The index of the item in the kitchen chit.
index The item index in the current order.
id Item ID.
menuItemDimId For internal purpose.
menuItemQuantityCategoryDi For internal purpose.
mID
kitchenItemIndex The index of the item in the kitchen chit.
itemCheckNumber The check number where the item is added.
roundId The ID of the round of order. If the same item is ordered using
Another Round function, the ID for that entry would be
incremented to 2.
displayRoundId For internal purpose.
cost The base price of the item.
revenueCost Refers to the cost of the item.
openItemInitialPrice The price of an open item when it was ordered, before any
overrides were done.
unitPrice The base price for one unit of the item.
selectionGroupId A unique number that identifies a selection group.
isModifier ▪ True - The ordered entity is a modifier.
▪ False - The ordered entity is not a modifier.
isSaved ▪ True - The entity in the check is saved.
▪ False - The entity in the check is not saved.
isVoided ▪ True - The item in the check is voided with appropriate
security levels.
▪ False - The item in the check is not voided.
isManualWeight ▪ True - Prints a Manual Weight entry on the receipt as the
user will type the weight of the items (in required units)
manually.
▪ False - Manual Weight entry is not printed on the receipt.
isItemLockout ▪ True - The item is a lockout item. The items remain locked
for the specified time.
▪ False - The item is not a lockout item. No restrictions for
apply for the item.
isGiftItem ▪ True - The item is a gift card sale item.
▪ False - The item is not a gift card sale item.
displayCost The total price of an item including the modifier price if
applicable.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 71
 IGPOS API | Reference Guide

Field Description
modifierCost The price of the modifier.
primaryDiscountId ID of the first discount applied to the check.
profitCenter A text string supporting up to 30 characters denotes the name
of the Profit Center.
checkType An alpha numeric value with a maximum limit of 16 characters
representing the type of the check.
mealPeriod A particular period in a day to categorize specific items, price
levels, and others. Also, Meal Period is used to generate
reports, such as sales performance report, product mix report,
etc., for that particular period of the day.
isSplitted ▪ True - A single check is divided among a group, where all
the items in the check can be split into separate checks.
▪ False - It is not a split check.
numOfSplits Displays the total count of splitting a single check.
auxSplitFlag ▪ True - Indicates the check is a split check and provides the
split count (the number of splits).
▪ False - The check is not a split check.N
isInclusiveGratuity ▪ True - The gratuities get included in the price of the items.
So, gratuities and service charges do not appear on the
receipt.
▪ False - The gratuities are not included in the price of items
and appear separately on the receipt.
isRestricted ▪ True - A tender is restricted when it includes items
belonging to a restricted revenue category.
▪ False - A tender is not restricted on any basis.
skuCode The alphanumeric code assigned to the item that can be swiftly
scanned by a barcode reader during the purchase.
name The name of the item
modifiers
Index The index of the modifiers added for an item in the check.
Id Modifiers ID.
ModifierDimId For internal purpose.
Cost The price of the modifier.
IsModifier ▪ True - The ordered entity is a modifier.
▪ False - The ordered entity is not a modifier.
ModifierProductMixId Indicates the default item ID that is mapped to the modifier.
ModifierProductMixDimId For internal purpose.
IsSaved ▪ True - The entity in the check is saved.
▪ False - The entity in the check is not saved.
IsVoided ▪ True - The modifier in the check is voided with appropriate
security levels.
▪ False - The modifier in the check is not voided.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 72
 IGPOS API | Reference Guide

Field Description
DisplayCost The total price of an item including the modifier price if
applicable.
ModifierCost The price of the modifier.
ChoiceGroupId A unique numerical value within a range of [1-99999] to identify
a choice group.
ChildItemIndex The index of items in a check other than Pmix items.
VoidReasonId A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check
VoidReasonDimId For internal purpose.
IsPrintOnCheck ▪ True - Prints all items and modifiers, even zero-priced
items on the check.
▪ False - Zero-Priced items and modifiers are not printed in
the check.
KitchenItemIndex The index of the modifiers in the kitchen chit.
ItemCheckNumber The check number where the item is added.
IsPriceOverriden ▪ True - Users can override the price of an item.
▪ False - Users cannot override the price of an item.
Name The name of the modifier.
ChoiceGroupFlag ▪ True - Choice group items are distinguished from
modifiers.
▪ False - Choice group items are not distinguished from
modifiers.
choiceGroupData
parent_node_id Indicates the parent modifier ID.
type Indicates the type of choice group. The following are the
different choice group types:
▪ Root
▪ Child
▪ Individual
Modifiers
Index The index of the modifiers added for an item in the check.
Id Modifiers ID.
ModifierDimId For internal purpose.
Cost The price of the modifier.
IsModifier ▪ True - The ordered entity is a modifier.
▪ False - The ordered entity is not a modifier.
ModifierProductMixId Indicates the default item ID that is mapped to the modifier.
ModifierProductMixDimId For internal purpose.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 73
 IGPOS API | Reference Guide

Field Description
IsSaved ▪ True - The entity in the check is saved.
▪ False - The entity in the check is not saved.
IsVoided ▪ True - The modifier in the check is voided with appropriate
security levels.
▪ False - The modifier in the check is not voided.
DisplayCost The total price of an item including the modifier price if
applicable.
ModifierCost The price of the modifier.
ChoiceGroupId A unique numerical value within a range of [1-99999] to identify
a choice group.
ChildItemIndex The index of items in a check other than Pmix items.
VoidReasonId A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check
VoidReasonDimId For internal purpose.
IsPrintOnCheck ▪ True - Prints all items and modifiers, even zero-priced
items on the check.
▪ False - Zero-Priced items and modifiers are not printed in
the check.
KitchenItemIndex The index of the modifiers in the kitchen chit.
ItemCheckNumber The check number where the item is added.
IsPriceOverriden ▪ True - Users can override the price of an item.
▪ False - Users cannot override the price of an item.
Name The name of the modifier.
ChoiceGroupFlag ▪ True - Choice group items are distinguished from
modifiers.
▪ False - Choice group items are not distinguished from
modifiers.
choiceGroupData
parent_node_id Indicates the parent modifier ID.
type Indicates the type of choice group. The following are the
different choice group types:
▪ Root
▪ Child
▪ Individual
Modifiers
SpecialInstructions
Id A unique numerical value within a range of [1-9999] to identify
the special instruction.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 74
 IGPOS API | Reference Guide

Field Description
Text Represents the name of the special instruction with a maximum
of 20 characters.
Index The index of special instructions added to items/modifiers in
the check.
IsVoid ▪ True - The special instruction is voided with appropriate
security levels.
▪ False - The special instruction is not voided.
VoidReasonId A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check
VoidReasonDimId For internal purpose.
IsSaved ▪ True - The entity in the check is saved.
▪ False - The entity in the check is not saved.
kpStatus Kitchen printer status.
KvStatus Kitchen video status.
ChildItemIndex The index of items in a check for which special instructions are
added.
KitchenItemIndex The index of special instructions for the item/modifier in the
kitchen chit.
ItemCheckNumber The check number where the item is added.
kpStatus Kitchen printer status.
KvStatus Kitchen video status.
AuxSplitFlag For internal purpose.
IsSplitted ▪ True - A single check is divided among a group, where all
the items in the check can be split into separate checks.
▪ False - It is not a split check.
IsConsumed ▪ True - The item is consumed. The item is not returned or
voided.
▪ False - The item is not consumed. The item is returned or
voided.
ProductMixName Indicates the name of the Pmix item that is mapped to the
modifier.
IsReturnItem ▪ True - Return/exchange on an item is allowed.
▪ False - Return/exchange on an item is not allowed.
Quantity Indicates the total count of an item.
QuantityCategoryId A unique value to identify the quantity category.
QCQuantityMultiplier The price multiple value configured in the Quantity Category
form.
BaseCalories For internal purpose.
MaxCalories For internal purpose.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 75
 IGPOS API | Reference Guide

Field Description
DisplayName The display name of the item.
UnitPrice The price of the item.
SpecialInstructions
Id A unique numerical value within a range of [1-9999] to identify
the special instruction.
Text Represents the name of the special instruction with a maximum
of 20 characters.
Index The index of special instructions added to items/modifiers in
the check.
IsVoid ▪ True - The special instruction is voided with appropriate
security levels.
▪ False - The special instruction is not voided.
VoidReasonId A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check
VoidReasonDimId For internal purpose.
IsSaved ▪ True - The entity in the check is saved.
▪ False - The entity in the check is not saved.
kpStatus Kitchen printer status.
KvStatus Kitchen video status.
ChildItemIndex The index of items in the check for which special instructions
are added.
KitchenItemIndex The index of special instructions for the item/modifier in the
kitchen chit.
ItemCheckNumber The check number where the item is added.
kpStatus Kitchen printer status.
KvStatus Kitchen video status.
AuxSplitFlag For internal purpose.
IsSplitted ▪ True - A single check is divided among a group, where all
the items in the check can be split into separate checks.
▪ False - It is not a split check.
IsConsumed ▪ True - The item is consumed. The item is not returned or
voided.
▪ False - The item is not consumed. The item is returned or
voided.
ProductMixName Indicates the name of the Pmix item that is mapped to the
modifier.
IsReturnItem ▪ True - Return/exchange on an item is allowed.
▪ False - Return/exchange on an item is not allowed.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 76
 IGPOS API | Reference Guide

Field Description
Quantity Indicates the total count of an item.
QuantityCategoryId A unique value to identify the quantity category.
QCQuantityMultiplier The price multiple value configured in the Quantity Category
form.
BaseCalories For internal purpose.
MaxCalories For internal purpose.
DisplayName The display name of the item.
UnitPrice The price of the item.
SpecialInstructions
Id A unique numerical value within a range of [1-9999] to identify
the special instruction.
Text Represents the name of the special instruction with a maximum
of 20 characters.
Index The index of special instructions added to items/modifiers in
the check.
IsVoid ▪ True - The special instruction is voided with appropriate
security levels.
▪ False - The special instruction is not voided.
VoidReasonId A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check
VoidReasonDimId For internal purpose.
IsSaved ▪ True - The entity in the check is saved.
▪ False - The entity in the check is not saved.
kpStatus Kitchen printer status.
KVStatus Kitchen video status.
ChildItemIndex The index of items in the check for which special instructions
are added.
KitchenItemIndex The index of special instructions for the item/modifier in the
kitchen chit.
ItemCheckNumber The check number where the item is added.
discounts
ObjectIndex For internal purpose.
Index The index of the discounts applied in the check.
Amount The amount of discount applied.
Id A system generated or user typed unique number in the range
of [1-9999] to identify the discount at the POS terminal.
DiscountDimId For internal purpose.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 77
 IGPOS API | Reference Guide

Field Description
Level Denotes whether it is an item level discount or a check level
discount.
IsPercentage ▪ True - Calculates discount on a percent basis.
▪ False - Calculates discount on an amount basis.
Value The actual value of the discount.
IsNoTax ▪ True - The discount does not affect the tax basis.
▪ False - The discount affects the tax basis.
IsOpenDiscount ▪ True - Allows the cashier to override the default amount of
the discount.
▪ False - Does not allow the cashier to override the default
amount of the discount. The value remains fixed.
ItemCount The total number of items that are listed on the check.
SKUCode An alphanumeric discount code (printed on receipts) with a
maximum of 30 characters that enables users to apply a
discount to the check by scanning the barcode.
ExtraData A prompt to provide additional information for a chosen
discount.
DiscountedBy
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
NotFormatted ▪ True - The discount is formatted based on the configured
decimal factor.
▪ False - The discount is not formatted based on the
configured decimal factor.
OpenDiscountDecimalFactor ▪ True - The open discount percentage from the server is
formatted with 2 or 3 decimals.
▪ False - The open discount percentage from the server is
not formatted.
DiscSource Indicates the source of the discount. For example, PMS
Discount, Auto Discount from Tender, and others)
DiscountRule
RuleId A system generated or manually entered number for the
coupon or discount.
RuleDimId For internal purpose.
RuleDateFrom Indicates the start day (in DD/MM/YY format) from which the
discount will be applied.
RuleDateTo Indicates the last day (in DD/MM/YY format) to which the
discount will be applied.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 78
 IGPOS API | Reference Guide

Field Description
RuleStartTimeMinutes Indicates the discount start time in minutes.
RuleEndTimeMinutes Indicates the discount end time in minutes.
RuleRecurrenceType Indicates the frequency of the same discount to come into
effective. Eg: Daily, Weekly, Monthly, and Yearly.
RuleDayofweekMask Discount rule recurrence setting to indicate the day of the week
when the rule can be applied.
RuleDayofmonth Discount rule recurrence setting to indicate the day of the
month when the rule can be applied.
RuleOrdinalDay Discount rule recurrence setting to indicate the ordinal day in a
month/year when the rule can be applied.
RuleMonthofyear Discount rule recurrence setting to indicate the month of the
year when the rule can be applied.
RuleRevenueGroup Indicates the discount on the selected revenue group - Product
Classes, Items, Store Items, Check Types, and Package. By
default, all the four categories in the revenue groups are
selected.
IsItemCriteriaEnabled ▪ True - The minimum item quantity is checked before
applying the item level discount.
▪ False - The minimum item quantity is not checked before
applying the item level discount.
MinItemQuantity The minimum quantity of item to apply item level discount.
ItemPriceDiscount The item level discount price that is decided based on the price
of the item. When Highest is configured, the maximum unit
price among the items will be considered as the discount value.
RuleConstraintJoin
RuleConstraintId For internal purpose.
RelevantIds
Id Indicates the division or store modifier ID that is eligible for
discount.
ItemFlag ▪ True - Indicates it is an item.
▪ False - Indicates it is not an item.
Tier
TierId It is a unique system generated value that falls within a range
of [1-999].
TierName An alphanumeric value with a maximum limit of 50 characters
indicates the player’s tier level.
CMSId Denotes the Casino Management System ID.
MaxLimit The maximum discount limit applicable for a tier.
RewardValue The value of the tier rewards applicable to the guest.
TierDesc The description about the tier level.
ModifierId A unique value identifying the modifier.
ModIndex Modifier index.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 79
 IGPOS API | Reference Guide

Field Description
OpenDiscountPercent Indicates the percentage in which the discount varies.
splitDiscFlag For internal purpose.
IsAffectGratuity ▪ True - The discount does not impact the gratuity.
▪ False - The gratuity gets adjusted based on the applied
discount.
IsAffectServiceCharge ▪ True - The discount does not impact the service charge.
▪ False - The service charge gets adjusted based on the
applied discount.
IsTenderReducesDisc ▪ True - The discount gets re-calculated in proportion to the
tender, thereby enabling users to apply discounts even in a
partially tendered check.
▪ False - The discount does not get re-calculated.
CardNumber The barcode number to apply the appropriate discount.
StarbucksDiscountInfo
MerchantId A unique merchant identifier that lies within a range of 1-16
characters. This ID is used for Starbucks card operations.
TransactionNumber A unique reference number identifying a transaction. When the
transaction number is not available, the check number is used.
IsSaved ▪ True - The check is saved.
▪ False - The check is not saved.
IsVoided ▪ True - The items in the check are voided.
▪ False - The items in the check are not voided.
StoreNumber The zero-padded 6-digit Starbucks store number where the
transaction is completed.
RegisterNumber A 2–6-digit unique Starbuck register number where the
transaction is completed.
Sequence The sequence of the items in the check.
RedemptionSequence A container of information regarding the redemption status of
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
DiscountId A system generated or manually entered value within the range
[1-9999] that identifies the discount.
RewardCode A unique code that is used to redeem the coupon.
IsCouponDisc ▪ True - It is a coupon discount.
▪ False - It is not a coupon discount.
ModifierId A unique value identifying the modifier.
RCCLDiscountInfo
PromotionID A unique string identifying the promo to avail RCCLDiscount.
PromoName The name of the promo.
Points The reward points available for RCCLDiscount.
MenuItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 80
 IGPOS API | Reference Guide

Field Description
Quantity The item quantity.
UnitPrice The cost of item.
ACESDiscountInfo
PromotionID A unique string identifying the promo to avail ACESDiscount.
PromoName The name of the promo.
PrizeID A unique value identifying the available prizes in the
ACESDiscount.
PackageID A unique value identifying the package.
Amount The discount amount.
PrizeType Indicates one of the following price types:
▪ Free
▪ Discount
▪ Flat Discount
▪ Flat Price
PromoProductClassName For internal purpose.
DiscExtraText Indicates additional text details provided for ACES discounts.
AppliedItemIndex The index of items for which the ACES discounts are applied.
ToVoidDiscIdx ▪ True - The discount index is voided.
▪ False - The discount index is not voided.
PackageItemIndex The index of package items.
IsTaxable ▪ True - The tax is applicable for the order.
▪ False - The tax is not applicable for the order.
IsTaxOnOldPrice ▪ True - The tax is added to the old price.
▪ False - The tax is not added to the old price.
PromoCode A unique value identifying the promo code.
PromoType Specifies the promo type of the discounts. For example -
IG_Discount, PMS_VisuaOne, PMS_RPOS, CASINO_IGT,
CASINO_SGACSC, CASINO_CMP, and others.
IsPMSAccountDiscount ▪ True - The discount is a PMS account-based discount.
▪ False - The discount is not a PMS account-based discount.
PMSAccountDiscountMaxCap The maximum discount value to be considered for PMS
account-based discount.
taxes
exclusiveCost Indicates the price of the check by excluding the tax.
inclusiveCost Indicates the price of the check by including the tax.
count For internal purpose.
details
c_TaxAmount
value For internal purpose.
c_InclusiveTaxAmount

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 81
 IGPOS API | Reference Guide

Field Description
value For internal purpose.
c_Amount
value For internal purpose.
c_InclusiveCost
value For internal purpose.
c_ExclusiveCost
value For internal purpose.
c_FixedInclusiveCost
value For internal purpose.
c_FixedExclusiveCost
value For internal purpose.
c_RemovedTaxPercent
value For internal purpose.
ExclusiveCost The total amount of exclusive tax calculated.
updatedTaxRate Indicates the updated tax rate value.
id A system generated or manually typed unique number within
the range of [1-255] to identify the tax.
taxDimId For internal purpose.
taxValue Specifies the tax value.
taxCost For internal purpose.
isTaxByPercent ▪ True - Calculates tax on a Percent basis.
▪ False - Calculates tax on an Amount basis.
isExclusive ▪ True - The tax is not applied to the check.
▪ False - The tax is applied to the check.
isTaxRemoved ▪ True - POS operators can remove the tax associated with
the item.
▪ False - POS operators cannot remove the tax associated
with the item.
canRemoveAtTerminal ▪ True - Tax can be removed from the check at the POS
terminal.
▪ False - Tax cannot be removed from the check at the POS
terminal.
categoryId A numerical value to denote the preferred tax category.
isEarnEligible ▪ True - Customers earn loyalty points as rewards when the
system is integrated with Casinos or others.
▪ False - No loyalty points are rewarded to the customers.
isRedeemEligible ▪ True - Customers can redeem their loyalty points.
▪ False - Loyalty points cannot be redeemed.
roundingConfiguration
roundType To round off the value of the check to the nearest unit.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 82
 IGPOS API | Reference Guide

Field Description
roundBasis A desired value in the range of [1-50000] to round the check.
For example, in the US, typing 50000 rounds to $500.00.
inclusiveTaxAmount The amount of inclusive tax calculated.
amount The total amount calculated for tax.
inclusiveCost The cost of the item which is tax inclusive.
fixedInclusiveCost A fixed inclusive cost amount.
fixedExclusiveCost A fixed exclusive cost amount.
removedTaxPercent The percentage of removed tax.
modifierDiscounts
ModifierIndex The index of the modifiers in the check.
DiscountIndex The index of the discounts applied in the check.
GiftCardInfo
GiftCardTenderId Tender ID of the gift card tender.
CardNumber Indicates the gift card number.
EncryptionSeed For internal purpose.
Track1 Indicates the track 1 data of the MSR card that is swiped as
input.
Track2 Indicates the track 2 data of the MSR card that is swiped as
input.
InvoiceId A unique value identifying the invoice. It is similar to the Check
ID.
CurrencyCode The currency code of the enterprise as configured in the
Universal Desktop.
SaleAmount The amount for which the sale is being made.
ServiceType For internal purpose.
RechargeFlag ▪ True - Indicates it is a gift card recharge.
▪ False - Indicates it is not a gift card recharge.
CashOutFlag ▪ True - The guest can cash out their gift card.
▪ False - The guest cannot cash out their gift card.
ReturnFlag ▪ True - It is a gift card return.
▪ False - It is not a gift card return.
AccountId Account ID to which the gift card is mapped.
CardExpiration Expiration date of the gift card
EntryMode Mode of entry for the gift card details. Specifies if it is manual
or swipe
SalesFlag ▪ True - The gift card transaction is sale.
▪ False - The gift card transaction is recharge.
BalanceAmount The balance on the gift card used.
AddOnCharges
Id Add-On transaction ID.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 83
 IGPOS API | Reference Guide

Field Description
ExclusiveTaxCost The total amount of exclusive tax calculated.
ExclusiveAmount Amount on check excluding tax.
Amount Check amount.
IsRemoved ▪ True - The add-on tax is removed.
▪ False - The add-on tax is not removed.
ChargeType Indicates the type of add-on charge.
▪ Gratuity = 1
▪ ServiceCharge = 2
▪ Tip = 3
▪ Withheld = 4
▪ CreditTender = 5
Taxes
Details
Amount The total tax amount associated with the tender.
Id A unique value identifying the tax.
RoundingConfiguration
roundType To round off the value of the check to the nearest unit.
roundBasis A desired value in the range of [1-50000] to round the check.
For example, in the US, typing 50000 rounds to $500.00.
IsPackagePmixFlag ▪ True - Indicates it is a package item.
▪ False - Indicates it is not a package item.
Sequence Sequence of the item within the package.
PackagePmixAmount Item amount as configured in the package.
IUniqueSelGrpId The ID of the selection group when the item is a part of a
selection group within the package.
VoidReasonId A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check
voidReasonDimId For internal purpose.
IsReturnItem ▪ True - Allows return/exchange on an item.
▪ False - Does not allow return/exchange on an item.
IsPrintOnCheck ▪ True - Prints all items, even zero-priced items on the
check.
▪ False - Zero-Priced items are not printed in the check.
Quantity The quantity of financial bin of the same type that has been
applied.
QuantityFraction The quantity fraction after an item is split. For example, if 3
quantity of item is split into 5 parts, the quantity fraction would
be 3/5.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 84
 IGPOS API | Reference Guide

Field Description
AddedBy
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
voidedBy
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose.
inclusiveGratuityAmount For internal purpose.
inclusiveServiceChargeAmoun For internal purpose.
t
auxKitchenData
AuxKPId For internal purpose.
ReplaceKPId For internal purpose.
profitCenterDimId For internal purpose.
originProfitCenterDimId For internal purpose.
mealPeriodDimId For internal purpose.
checkTypeDimId For internal purpose.
configItemIndex For internal purpose.
addedTime The time at which the item is added.
addedTimeTicks The epoch time at which the item is added.
baseCalories For internal purpose.
maxCalories For internal purpose.
cardImage For internal purpose.
displayName The display name of the item.
quantityCategoryId A unique value to identify the quantity category.
qcQuantityMultiplier The count of quantity category that is used for calculation.
costBeforePackaging The cost before the item forms a package.
isToDisplaySelGrpName ▪ True - The selection group name is displayed.
▪ False - The selection group name is not displayed.
addedBy
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 85
 IGPOS API | Reference Guide

Field Description
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
specialInstructions
Id A unique numerical value within a range of [1-9999] to identify
the special instruction.
Text Represents the name of the special instruction with a maximum
of 20 characters.
Index The index of the special instructions in the check.
IsVoid ▪ True - The special instruction is voided with appropriate
security levels.
▪ False - The special instruction is not voided.
VoidReasonId A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check
VoidReasonDimId For internal purpose.
IsSaved ▪ True - The entity in the check is saved.
▪ False - The entity in the check is not saved.
kpStatus Kitchen printing status.
KVStatus Kitchen video status.
ChildItemIndex The index of items in the check for which special instructions
are added.
KitchenItemIndex The index of the item in the kitchen chit.
ItemCheckNumber The check number on which the item is added.
voidedBy
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
kitchenItemIndex The index of the item in the kitchen chit.
itemCheckNumber The check number where the item is added.
displayCost The total price of an item including the modifier price if
applicable.
splitAllItemsMethod Indicates the type of split - By seat, by course, and other ways,
when a Split All Items is applied.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 86
 IGPOS API | Reference Guide

Field Description
isBarGunItem ▪ True - The item is a bargun item.
▪ False - The item is not a bargun item.
cardImage For internal purpose.
taxSummary
Id A unique number within a range of [1-255] to identify the tax
levied on the check.
InclusiveTaxAmount The amount of inclusive tax calculated.
ExclusiveTaxAmount The non-inclusive tax amount.
SalesAmount The amount for which the sale is made.
SalesAmountTaxInclusive The tax amount associated with the sale price.
GratuityAmount The amount of gratuity applied in the check.
ServiceAmount The amount of service charge applied in the check.
DiscountAmount The discount amount applied to the check.
CompoundAmount For internal purpose.
SalesBasis The minimum amount taken from the sale basis amount either
after discount or after removing the tax.
GratuityBasis Basis of gratuity calculation as per the configured gratuity
applied to check.
CategoryId ID of the tax category.
Description Description for the tax to be applied.
TaxDimId For internal purpose.
VatSummary
Vat
VatType
Id Vat ID.
TaxId Tax ID mapped to the check type.
TaxDimId For internal purpose.
TaxAmount Indicates the tax levied for items listed on a check.
SalesAmount The amount of sale based on which the vat is calculated.
DiscountAmount The discount amount applied to the check.
GratuityAmount The amount of gratuity applied in the check.
ServiceChargeFlag ▪ True - The add-on type is service charge.
▪ False - The add-on type is not a service charge.
RoundingConfiguration
roundType To round off the value of the check to the nearest unit.
roundBasis A desired value in the range of [1-50000] to round the check.
For example, in the US, typing 50000 rounds to $500.00.
TaxRate Indicates the percentage of applied tax amount in the check.
This applicable only when the applied tax is a percentage tax.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 87
 IGPOS API | Reference Guide

Field Description
RevenueCategoryId A system generated or manually entered unique value in the
range of [1-99] to identify the revenue category.
AddOnSummary
Id ID of the add-on charge applied to check.
DimId For internal purpose.
AddOnType Specifies the type of the add-on. The following are the
available add-on types:
▪ Gratuity
▪ Service Charge
▪ Tip
▪ Withheld
▪ Credit Tender
Amount Add-on amount.
SalesAmount The amount of sale based on which the add-on is calculated.
DiscountAmount The amount of discount applied to the add-on.
AllocateType Type of Allocation - percentage or amount.
AllocatedId ID of the tax/gratuity or service charge applied.
PayoutAtTerminal ▪ True - Tips, gratuities, and service charges can be carried
forward to the next shift, if the job code of the employee
has the Carry Over Tips and Gratuities flag enabled.
▪ False - Tips, gratuities, and service charges cannot be
paid at the terminal.
IncludeIRSReporting ▪ True - The sales from the appropriate tender are included
in IRS Tip and IRS Tip by profit center reports.
▪ False - The sales from the appropriate tender are not
included in IRS Tip and IRS Tip by profit center reports.
gratuityInfo
GratuityDetails
Id A unique numerical value identifying the gratuity.
Name The name of the gratuity.
DimId For internal purpose.
GratuityCategory
Id A system generated or manually entered unique value within
the range [1-255] identifies the gratuity category. This value is
unique at the enterprise level.
GratuityType Denotes the type. User can select Gratuity or Service Charge
depending on their requirements.
IsEarnEligible ▪ True - Customers earn loyalty points as rewards when the
system is integrated with Casinos or others.
▪ False - No loyalty points are rewarded to the customers.
IsRedeemEligible ▪ True - Customers can redeem their loyalty points.
▪ False - Loyalty points cannot be redeemed.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 88
 IGPOS API | Reference Guide

Field Description
GratuityCategoryName A string value with a maximum of 20 characters indicate the
name of the gratuity category.
Recipient Indicates a server, cashier, or specific employee. The gratuity
or service charge may be given to the server, cashier, or to a
designated employee. The designated employee can be an
individual (maître d’) or a group of employees (bus persons,
valet, and so on.)
EmployeeId If the recipient is an employee, this unique value indicates the
ID of that particular employee who claims the gratuity or
service charge. At times, the employee can also be a business
entity such as a casino, hotel, or other profit centers and it can
be configured in the Employee Main Form.
CanPayoutAtTerminal ▪ True - Gratuity or service charge accumulates along with
other tips to be paid out in cash at the terminal. A tip
payout can be performed at the terminal via the terminal’s
Shift Reset report (activate terminal option 210 to
automatically prompt for tip payout) or by selecting the Tip
Payout button. Running the Shift Reset report also updates
the Server Shift Sales, Tips and Gratuities report, the
Server Shift Sales, Tips, and the Grats Summary report.
▪ False - When user selects not to pay out this gratuity at the
terminal, it is still reported on back-office reports, so the
gratuity is paid by alternative means (i.e., payroll).
CanRemovalAtTerminal ▪ True - The gratuity or service charge gets removed from
the check. This option is accessible only by employees
with higher job security levels. They can remove or restore
a gratuity (job code function 191) or a service charge (job
code function 225).
▪ False - The employees cannot remove the gratuities or
service charge from the check.
Amount
AmountPerCheck Indicates the amount per check and supports decimal points
with up to 2 places. The maximum digits that the field can
accommodate is 7 (i.e., up to 9,999,999).
AmountPerCover Indicates the amount per cover and supports decimal points
with up to 2 places. The maximum digits that the field can
accommodate is 7 (i.e., up to 9,999,999).
CoverThresholdMin Indicates the minimum number of covers needed for a cover-
based service charge or gratuity that must be applied to the
check (0-30,000). The POS terminal automatically applies this
gratuity when the cover count is equal to or greater than the
minimum.
For example, if a service charge is based only on a $2 charge
per cover, the least service charge fees can be set to $4 for a
minimum of 2 for the cover threshold.
CoverThresholdMax Indicates the maximum number of covers needed for a cover-
based service charge or gratuity that must be applied to the

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 89
 IGPOS API | Reference Guide

Field Description
check (0-30,000). The POS terminal automatically applies this
gratuity when the cover count is equal to or lesser than the
maximum.
For example, if a service charge is based only on a $2 charge
per cover, the service charge fees can be limited to $20 for a
maximum of 10 for the cover threshold.
Percentage
AppliedOn Indicates whether the gratuity is fixed or applied on a
percentage basis.
Percent Indicates the percentage of gratuity applied on the check.
RoundingConfiguration
roundType Round off the value of the check to the nearest unit.
roundBasis A desired value in the range of [1-50000] to round the check.
For example, in the US, typing 50000 rounds to $500.00.
IsInclusive ▪ True - The gratuities get included in the price of the items.
So, gratuities and service charges do not appear on the
receipt.
▪ False - The gratuities are not included in the price of items
and appear separately on the receipt.
CoverThresholdMin Indicates the minimum number of covers needed for a cover-
based service charge or gratuity that must be applied to the
check (0-30,000). The POS terminal automatically applies this
gratuity when the cover count is equal to or greater than the
minimum.
For example, if a service charge is based only on a $2 charge
per cover, the least service charge fees can be set to $4 for a
minimum of 2 for the cover threshold.
CoverThresholdMax Indicates the maximum number of covers needed for a cover-
based service charge or gratuity that must be applied to the
check (0-30,000). The POS terminal automatically applies this
gratuity when the cover count is equal to or lesser than the
maximum.
For example, if a service charge is based only on a $2 charge
per cover, the service charge fees can be limited to $20 for a
maximum of 10 for the cover threshold.
IncludeIRSReporting ▪ True - The sales from the appropriate tender are included
in IRS Tip and IRS Tip by profit center reports.
▪ False - The sales from the appropriate tender are not
included in IRS Tip and IRS Tip by profit center reports.
AddonGroup
AddonGroupId ID of the add-on group.
AddonGroupName The name of the add-on group.
ReportRev ▪ True - A report is generated for the revenue.
▪ False - No report is generated for the revenue.
IsGratuity ▪ True - The add-on is a gratuity.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 90
 IGPOS API | Reference Guide

Field Description
▪ False - The add-on is not a gratuity.
RevCatId A unique value identifying the revenue category.
AddonGroupDimId For internal purpose.
IsTenderGrat ▪ True - The gratuity charge is applied to the tender.
▪ False - The gratuity charge is not applied to the tender.
GratuityTaxDetails
Id A unique value identifying the gratuity.
DimId For internal purpose.
CategoryId A unique value identifying the gratuity category.
RoundingConfiguration
roundType Round off the value of the check to the nearest unit.
roundBasis A desired value in the range of [1-50000] to round the check.
For example, in the US, typing 50000 rounds to $500.00.
IsAmount ▪ True - The tax is based on amount.
▪ False - The tax is based on percentage.
Value The gratuity tax value.
ThresholdAmount The maximum amount of tax that can be applied.
CanRemoveAtTerminal ▪ True - Tax can be removed from the check at the POS
terminal.
▪ False - Tax cannot be removed from the check at the POS
terminal.
LimitToMealPeriodReporting For internal purpose.
IsEarnEligible ▪ True - Customers earn loyalty points as rewards when the
system is integrated with Casinos or others.
▪ False - No loyalty points are rewarded to the customers.
IsRedeemEligible ▪ True - Customers can redeem their loyalty points.
▪ False - Loyalty points cannot be redeemed.
PrimaryTaxCode For internal purpose.
ReceiptCode For internal purpose.
GratuityRevenueCategories Revenue categories that are mapped to gratuity.
AddonGroup
AddonGroupId ID of the add-on group.
AddonGroupName The name of the add-on group.
ReportRev ▪ True - A report is generated for the revenue.
▪ False - No report is generated for the revenue.
IsGratuity ▪ True - The add-on is a gratuity.
▪ False - The add-on is not a gratuity.
RevCatId A unique value identifying the revenue category.
AddonGroupDimId For internal purpose.
IsGroupedAddon ▪ True - The add-on is grouped.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 91
 IGPOS API | Reference Guide

Field Description
▪ False - The add-on is not grouped.
IsReportAsRevenue ▪ True - A report is generated for the revenue.
▪ False - No report is generated for the revenue.
GroupName For internal purpose.
groupedAddonSummary
Id A unique value identifying the add-on summary group.
DimId For internal purpose.
AddOnType Specifies the type of the add-on. The following are the
available add-on types:
▪ Gratuity
▪ Service Charge
▪ Tip
▪ Withheld
▪ Credit Tender
Amount The amount calculated for add-on summary.
AddonGroupName The name of the add-on group.
IsReportAsRevenue ▪ True - A report is generated for the revenue.
▪ False - No report is generated for the revenue.
RevCatId A unique value identifying the revenue category.
Discounts
ObjectIndex For internal purpose.
Index The index of the discounts applied in the check.
Amount The discount amount.
Id A system generated or user typed unique number in the range
of [1-9999] to identify the discount at the POS terminal.
DiscountDimId For internal purpose.
Level Denotes whether it is an item level discount or a check level
discount.
IsPercentage ▪ True - Calculates discount on a percent basis.
▪ False - Calculates discount on an amount basis.
Value The actual value of the discount.
IsNoTax ▪ True - The discount does not affect the tax basis.
▪ False - The discount affects the tax basis.
IsOpenDiscount ▪ True - Allows the cashier to override the default amount of
the discount.
▪ False - Does not allow the cashier to override the default
amount of the discount. The value remains fixed.
ItemCount The total number of items that are listed on the check.
SKUCode An alphanumeric discount code (printed on receipts) with a
maximum of 30 characters that enables users to apply a
discount to the check by scanning the barcode.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 92
 IGPOS API | Reference Guide

Field Description
ExtraData A prompt to provide additional information for a chosen
discount. User can enter the text manually using the on-screen
keyboard or by using the card swipe.
DiscountedBy
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
NotFormatted ▪ True - The discount is formatted based on the configured
decimal factor.
▪ False - The discount is not formatted based on the
configured decimal factor.
OpenDiscountDecimalFactor ▪ True - The open discount percentage from the server is
formatted with 2 or 3 decimals.
▪ False - The open discount percentage from the server is
not formatted.
DiscSource Indicates the source of the discount. For example, PMS
Discount, Auto Discount from Tender, and others)
DiscountRule
RuleId A system generated or manually entered number for the
coupon or discount.
RuleDimId For internal purpose.
RuleDateFrom Indicates the start day (in DD/MM/YY format) from which the
discount will be applied.
RuleDateTo Indicates the last day (in DD/MM/YY format) to which the
discount will be applied.
RuleStartTimeMinutes Indicates the discount start time in minutes.
RuleEndTimeMinutes Indicates the discount end time in minutes.
RuleRecurrenceType Indicates the frequency of the same discount to come into
effective. Eg: Daily, Weekly, Monthly, and Yearly.
RuleDayofweekMask Discount rule recurrence setting to indicate the day of the week
when the rule can be applied.
RuleDayofmonth Discount rule recurrence setting to indicate the day of the
month when the rule can be applied.
RuleOrdinalDay Discount rule recurrence setting to indicate the ordinal day in a
month/year when the rule can be applied.
RuleMonthofyear Discount rule recurrence setting to indicate the month of the
year when the rule can be applied.
RuleRevenueGroup Based on the selected revenue group, Product Classes, Items,
Store Items, Check Types, and Packages are populated. By
default, all four categories in the revenue groups are selected.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 93
 IGPOS API | Reference Guide

Field Description
IsItemCriteriaEnabled ▪ True - The minimum item quantity is checked before
applying the item level discount.
▪ False - The minimum item quantity is not checked before
applying the item level discount.
MinItemQuantity The minimum quantity of item to apply item level discount.
ItemPriceDiscount The item level discount price that is decided based on the price
of the item. When Highest is configured, the maximum unit
price among the items will be considered as the discount value.
RuleConstraintJoin
RuleConstraintId For internal purpose.
RelevantIds
Id Indicates the division or store modifier ID that is eligible for
discount.
ItemFlag ▪ True - Indicates it is an item.
▪ False - Indicates it is not an item.
Tier
TierId It is a unique system generated value that falls within a range
of [1-999].
TierName An alphanumeric value with a maximum limit of 50 characters
indicates the player’s tier level.
CMSId Denotes the Casino Management System ID.
MaxLimit The maximum discount limit applicable for a tier.
RewardValue The value of the tier rewards applicable to the guest.
TierDesc The description about the tier level.
ModifierId Represents a unique numeric value for the modifier.
ModIndex The index of modifiers in the check.
OpenDiscountPercent Indicates the percentage in which the discount varies.
splitDiscFlag For internal purpose.
IsAffectGratuity ▪ True - The discount does not impact the gratuity.
▪ False - The gratuity gets adjusted based on the applied
discount.
IsAffectServiceCharge ▪ True - The discount does not impact the service charge.
▪ False - The service charge gets adjusted based on the
applied discount.
IsTenderReducesDisc ▪ True - The discount gets re-calculated in proportion to the
tender, thereby enabling users to apply discounts even in a
partially tendered check.
▪ False - The discount does not get re-calculated.
CardNumber
StarbucksDiscountInfo
MerchantId A unique merchant identifier that lies within a range of 1-16
characters. This ID is used for Starbucks card operations.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 94
 IGPOS API | Reference Guide

Field Description
TransactionNumber A unique reference number identifying a transaction. When the
transaction number is not available, the check number is used.
IsSaved ▪ True - The check is saved.
▪ False - The check is not saved.
IsVoided ▪ True - The items in the check are voided.
▪ False - The items in the check are not voided.
StoreNumber The zero-padded 6-digit Starbucks store number where the
transaction is completed.
RegisterNumber A 2-6-digit unique Starbuck register number where the
transaction is completed.
Sequence The sequence of the items in the check.
RedemptionSequence A container of information regarding the redemption status of
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
DiscountId A system generated or manually entered value within the range
[1-9999] that identifies the discount.
RewardCode A unique code that is used to redeem the coupon.
IsCouponDisc ▪ True - It is a coupon discount.
▪ False - It is not a coupon discount.
ModifierId A unique value identifying the modifier.
RCCLDiscountInfo
PromotionID A unique string identifying the promo to avail RCCLDiscount.
PromoName The name of the promo.
Points The reward points available for RCCLDiscount.
MenuItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
Quantity The item quantity.
UnitPrice The cost of item.
ACESDiscountInfo
PromotionID A unique string identifying the promo to avail ACESDiscount.
PromoName The name of the promo.
PrizeID A unique value identifying the available prizes in the
ACESDiscount.
PackageID A unique value identifying the package.
Amount The discount amount.
PrizeType Indicates one of the following price types:
▪ Free
▪ Discount
▪ Flat Discount
▪ Flat Price
PromoProductClassName For internal purpose.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 95
 IGPOS API | Reference Guide

Field Description
DiscExtraText Indicates additional text details provided for ACES discounts.
AppliedItemIndex The index of items for which the ACES discounts are applied.
ToVoidDiscIdx ▪ True - The discount index is voided.
▪ False - The discount index is not voided.
PackageItemIndex The index of package items.
IsTaxable ▪ True - The tax is applicable for the order.
▪ False - The tax is not applicable for the order.
IsTaxOnOldPrice ▪ True - The tax is added to the old price.
▪ False - The tax is not added to the old price.
PromoCode A unique value identifying the promo code.
PromoType Specifies the promo type of the discounts. For example -
IG_Discount, PMS_VisuaOne, PMS_RPOS, CASINO_IGT,
CASINO_SGACSC, CASINO_CMP, and others.
IsPMSAccountDiscount ▪ True - The discount is a PMS account-based discount.
▪ False - The discount is not a PMS account-based discount.
PMSAccountDiscountMaxCap The maximum discount value to be considered for PMS
account-based discount.
statusCode A unique code identifying the error messages.
errorMessage The message that is displayed for errors during the check
transaction.
tenders
last_amt_authed The amount that was authorized lastly.
pms_auth_flag Supports authorization for PMS tenders.
emv_flag For internal purpose.
future_bits For internal purpose.
payment_ordinal For internal purpose.
cc_auth_flag For internal purpose.
transactionId A unique value to identify a transaction.
Id A system-generated or manually entered unique value within a
range of [1-255] to identify the tender.
tenderDimId For internal purpose.
tenderQty For internal purpose.
tenderName The name of the tender.
adaptorName The adaptor that is associated with the tender type used.
amount Indicates the total amount of the tender.
discountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
taxAmount The total tax amount that must be tendered.
isSaved For internal purpose.
isRestricted ▪ True - A tender is restricted when it includes items
belonging to a restricted revenue category.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 96
 IGPOS API | Reference Guide

Field Description
▪ False - A tender is not restricted on any basis.
isExclusive ▪ True - Prevents additional tenders from being used once
the tender is applied to a check.
▪ False - Becomes a non-exclusive tender where, the tender
can be used to partially pay the check. Two or more
tenders can be applied to the check to complete the
payment.
voucherID A unique value identifying the casino voucher.
promoName The casino promo name.
promoCode The casino promo code.
voucherName The name of the voucher.
voucherDescription The description of the casino voucher.
accountInfo
name The account name that is used for the tender.
number The account number that is used for the tender.
isPinPrompt For internal purpose.
isTipAvailableInAuthorization ▪ True - The tip can be added during authorization. The
terminal option 1299 (Allow tip addition into check
financial without any restrictions) must be enabled.
▪ False - The tip cannot be added during authorization.
tenderAdditionalInfo
tenderInfo Additional details about the tender applied in the check.
hostInfo For internal purpose.
folioNumber For internal purpose.
giftCardInfo
GiftCardTenderId Tender ID of the gift card tender.
CardNumber Indicates the gift card number.
EncryptionSeed For internal purpose.
Track1 Indicates the track 1 data of the MSR card that is swiped as
input.
Track2 Indicates the track 2 data of the MSR card that is swiped as
input.
InvoiceId A unique value identifying the invoice. It is similar to the Check
ID.
CurrencyCode The currency code of the enterprise as configured in the
Universal Desktop.
SaleAmount The amount for which the sale is being made.
ServiceType For internal purpose.
RechargeFlag ▪ True - Indicates it is a gift card recharge.
▪ False - Indicates it is not a gift card recharge.
CashOutFlag ▪ True - The guest can cash out their gift card.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 97
 IGPOS API | Reference Guide

Field Description
▪ False - The guest cannot cash out their gift card.
ReturnFlag ▪ True - It is a gift card return.
▪ False - It is not a gift card return.
AccountId Account ID to which the gift card is mapped.
CardExpiration Expiration Date of the Gift Card
EntryMode Mode of entry for the gift card details. Specifies if it is manual
or swipe.
SalesFlag ▪ True - The gift card transaction is sale.
▪ False - The gift card transaction is recharge.
BalanceAmount The balance on the gift card used.
genericAuthInfo
Type Represents 1/9 Generic Authorization (GA) types that are used
to track an assorted range of internal charge payment types.
AuthAccount The GA account to which the authorization is made.
PostAccount The GA account to which the tender details shall be posted
after the transaction.
Name An alphanumeric value with a maximum 20 characters
denoting the name of the GA account. This name gets
displayed on the POS terminal and printed on the receipts.
BalanceAmount The balance amount in the GA account.
ChargedAmount The request amount or sale amount that must be tendered.
PaymentAmount The amount to be paid.
PriceLevelID A unique value that identifies the assigned price level.
DiscountID A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
FrankingText1 A text field that displays the account holder name.
FrankingText2 A text field that displays the account balance.
GaAccountDimId For internal purpose.
GaTypeDimId For internal purpose.
IsCharity ▪ True - The GA account is credited with donations.
▪ False - No donations are credited to the GA account.
couponInfo
Id Coupon ID is identical to Discount ID as both values share the
same ID pool. It is a unique number within a range of [1-9999].
CouponDimId For internal purpose.
Quantity The coupon quantity
AccountNumber For internal purpose.
Description A description for the coupon applied in the check.
PaymentAmount The total payable amount using the coupon.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 98
 IGPOS API | Reference Guide

Field Description
CouponSKUCode An alphanumeric coupon code (printed on receipts) with a
maximum of 30 characters that enables users to apply a
discount to the check by scanning the barcode.
foreignCurrencyInfo
CurrencyDescription Specifies the name of the tender.
CurrencyCode The currency code of the enterprise as configured in the
Universal Desktop.
CurrencyAmount The currency amount that is converted to the foreign currency.
dccResponseInfo
CurrencyDescription For internal purpose.
CurrencyCode The currency code of the enterprise as configured in the
Universal Desktop.
CurrencyAmount For internal purpose.
Margin For internal purpose.
ExchangeRate Denotes the rate for converting the currency. This field gets
activated only if the verification code ID is between 41 and 49.
For example, for converting Japanese Yen to Dollar, the
currency rate is 0.00733; for converting the UK Pounds to
Dollar, the rate is 1.24.
resortCardInfo
CardNumber Indicates the resort card number.
Track1 Indicates the track 1 data of the MSR card that is swiped as
input.
Track2 Indicates the track 2 data of the MSR card that is swiped as
input.
CustomerName The name of the customer.
CustomerId The ID of the customer.
TransactionId A unique value identifying a transaction.
BalanceAmount The balance amount in the resort card.
HasTrackData For internal purpose.
allowDuplicateReceipts ▪ True - Allows an employee to print a duplicate copy of the
check by touching the Print Last Receipt.
▪ False - Does not allow an employee to print a duplicate
copy of the check.
cashTenderRoundAmount For internal purpose.
isTenderReducesDiscount ▪ True - The discount gets re-calculated in proportion to the
tender, thereby enabling users to apply discounts even in a
partially tendered check.
▪ False - The discount does not get re-calculated.
isEarnEligible ▪ True - Customers earn loyalty points as rewards when the
system is integrated with Casinos or others.
▪ False - No loyalty points are rewarded to the customers.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 99
 IGPOS API | Reference Guide

Field Description
isRedeemEligible ▪ True - Customers can redeem their loyalty points.
▪ False - Loyalty points cannot be redeemed.
cardCode Refers to the cardcode that is mapped in the Tender form.
rewardId A unique value identifying the loyalty reward.
overrideApprovedBy
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
Type Tender type.
adaptorType Indicates the type of adapter.
Example: Property Management System.
walletType Indicates the type of wallet.
Example: Amazon, Citcon.
addOnCharge
addOnAmount The amount for add-on charges.
addOnModifiedVatAmt The amount calculated for add-on charges when Use Modified
VAT is set to True.
TaxCollection
_dictionayTaxById
c_ExclusiveCost
value For internal purpose.
ExclusiveCost For internal purpose.
c_InclusiveCost
value For internal purpose.
c_ExclusiveCost
value For internal purpose.
c_FixedInclusiveCost
value For internal purpose.
c_FixedExclusiveCost
value For internal purpose.
c_RemovedTaxPercent
value For internal purpose.
ExclusiveCost The total amount of exclusive tax calculated.
InclusiveCost The cost of the item which is tax inclusive.
FixedInclusiveCost A fixed inclusive cost amount.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 100
 IGPOS API | Reference Guide

Field Description
FixedExclusiveCost A fixed exclusive cost amount.
RemovedTaxPercent The percentage of removed tax.
Taxes
Details
Amount The total tax amount associated with the tender.
Id A unique value identifying the tax.
RoundingConfiguration
roundType Round off the value of the check to the nearest unit.
roundBasis A desired value in the range of [1-50000] to round the check.
For example, in the US, typing 50000 rounds to $500.00.
Level Specifies add-on charges level. It can be either check level or
item level.
ChargeType Indicates the type of add-on charge.
▪ Gratuity = 1
▪ ServiceCharge = 2
▪ Tip = 3
▪ Withheld = 4
▪ CreditTender = 5
Id A unique value identifying the add-on charge.
DimId For internal purpose.
AddOnCalculationType Specifies the add-on calculation type. The types include
Percentage, FixedAmount, or both.
RoundingConfiguration
roundType Round off the value of the check to the nearest unit.
roundBasis A desired value in the range of [1-50000] to round the check.
For example, in the US, typing 50000 rounds to $500.00.
Percentage The percentage of add-on charge applied.
FixedCheckAmount The fixed amount calculated for add-ons applied in the check.
FixedCoverAmount Indicates the cover count for a check.
MinCover The minimum cover count per check.
MaxCover The maximum cover count per check.
CanRemovalAtTerminal ▪ True - The gratuity or service charge gets removed from
the check. This option is accessible only by employees
with higher job security levels. They can remove or restore
a gratuity (job code function 191) or a service charge (job
code function 225).
▪ False - The employees cannot remove the gratuities or
service charge from the check.
CanPayoutAtTerminal ▪ True - Gratuity or service charge accumulates along with
other tips to be paid out in cash at the terminal. A tip
payout can be performed at the terminal via the terminal’s
Shift Reset report (activate terminal option 210 to

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 101
 IGPOS API | Reference Guide

Field Description
automatically prompt for tip payout) or by selecting the Tip
Payout button. Running the Shift Reset report also updates
the Server Shift Sales, Tips and Gratuities report, the
Server Shift Sales, Tips, and the Grats Summary report.
▪ False - When user selects not to pay out this gratuity at the
terminal, it is still reported on back-office reports, so the
gratuity is paid by alternative means (i.e., payroll).
IsAddOnExclusive ▪ True - The add-on charge is exclusive. The gratuity and
service charges are on a fixed amount basis.
▪ False - The add-on charge is non-exclusive. The gratuity
and service charge are on a percentage basis.
IsRemoved ▪ True - The add-on charge is removed from the check.
▪ False - The add-on charge is not removed from the check.
Recipient The appropriate add-on recipients. It can Cashier, Employee,
and Server.
Employee
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
SalesType Specifies the add-on sales type. It can be gross sales or net
sales.
AssociatedRevenueCategories Refers to the associated revenue categories of the add-on
charge.
IsAddOnTaxApplicable ▪ True - The tax is applicable for the add-ons applied in the
check.
▪ False - The tax is not applicable for the add-ons applied in
the check.
UseModifiedVat ▪ True - The VAT is modified, and the modified VAT amount
is used.
▪ False - The modified VAT amount is not used.
RedeemEligible Customers earn loyalty points as rewards when the system is
integrated with Casinos or others.
EarnEligible Customers can redeem their loyalty points.
IncludeIRSReporting ▪ True - The sales from the appropriate tender are included
in IRS Tip and IRS Tip by profit center reports.
▪ False - The sales from the appropriate tender are not
included in IRS Tip and IRS Tip by profit center reports.
IsTaxInclusiveItem ▪ True - The tax is included for the items added in the check.
▪ False - The tax is excluded for the items added in the
check.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 102
 IGPOS API | Reference Guide

Field Description
AddonGroup
AddonGroupId A unique value identifying the add-on group.
AddonGroupName The name of the add-on group.
ReportRev ▪ True - A report is generated for the revenue.
▪ False - No report is generated for the revenue.
IsGratuity ▪ True - The add-on is a gratuity.
▪ False - The add-on is not a gratuity.
RevCatId A unique value identifying the revenue category.
AddonGroupDimId For internal purpose.
IsGroupedAddon ▪ True - The add-on is grouped.
▪ False - The add-on is not grouped.
IsTenderGrat ▪ True - The gratuity charge is applied to the tender.
▪ False - The gratuity charge is not applied to the tender.
TenderDetails A tuple which holds the values of TenderBasis, IsPost, and
Add-On amount.
Amount The total add-on amount.
ModifiedVatAmount The modified vat amount for the add-on applied in the check.
ExclusiveAmount Indicates the add-on amount. The appropriate amount is
assigned only when AddOnExclusive is set to True.
ExclusiveTaxCost The exclusive amount calculated as tax for the add-on applied
in the check.
isPost ▪ True - The tender gets posted.
▪ False - The tender does not get posted.
additionalCharge The amount calculated for gratuity that is mapped to the
appropriate Tender form.
isCruisetender ▪ True - The tender is a cruise tender. It is a type of tender
used in Fidelio Cruise system which utilizes guest’s folio
number and the PAX account.
▪ False - The tender is not a cruise tender.
index The overall index in the check.
payIndex For internal purpose.
tenderIndex The index of tenders applied in the check.
verificationCodeId The tender verification codes of the appropriate tender. For
example, when the tender verification code is between 221 and
229, then it represents GA credit tender.
verifyStatus For internal purpose.
tenderGuid A unique GUID generated to identify each tender.
changeId For internal purpose.
cardSource Indicates the sources of the card. It can be Manual, MSR,
RFID, ICC, and unknown.
allocatedRevenueAmount For internal purpose.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 103
 IGPOS API | Reference Guide

Field Description
associatedTenderGuid Tender GUID that is assigned during refund closed check
operation.
tipAmount Indicates the tipped amount received by the employees.
changeAmount The amount that is to be returned to guest after the sale.
breakageAmount The balance from an over tender which is not returned to the
guest or used as a tip.
Example: If a $10 voucher is used for $6 check, the $4 is
considered as the breakage amount.
currencyAmount Indicates the foreign currency amount.
currencyDecimalPrecision Configures the number of decimal places for the accepted
currencies.
currencyExchangeFactor Refers to the foreign currency code.
currencyExchangeScale For internal purpose.
isAuthBenefit ▪ True - The auth tender has some benefits, such as tender
discount, auto tax removal or pricelevel.
▪ False - The auth tender does not have any benefits.
isAccountsReceivable ▪ True - The Account Receivable Number is returned when
the Additional Check Type ID of the tender is configured
as 1.
▪ False - No Account Receivable Number is returned. The
Additional Check Type ID of the tender is configured with
other values.
isTaxInvoice ▪ True - The Tax Invoice Number is returned when the
Additional Check Type ID of the tender is configured as
2.
▪ False - No Tax Invoice Number is returned. The
Additional Check Type ID of the tender is configured with
other values.
isOrderReceipt ▪ True - The Order Receipt Number is returned when the
Additional Check Type ID of the tender is configured as
3.
▪ False - No Order Receipt Number is returned. The
Additional Check Type ID of the tender is configured with
other values.
isSplitTaxRemoved ▪ True - The split tax gets removed from the check.
▪ False - The split tax is applicable for the check.
isIRSAllocable ▪ True - The sales using this tender is included in the IRS
Tip and IRS Tip by Profit Center reports.
▪ False - The sales using this tender is not included in the
IRS Tip and IRS Tip by Profit Center reports.
isAutoRemoveTax ▪ True - Removes tax automatically for the value of the
tender applied to the check.
▪ False - Tax gets included for the value of the tender
applied to the check.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 104
 IGPOS API | Reference Guide

Field Description
isAuthBenefit ▪ True - The auth tender has some benefits, such as tender
discount, auto tax removal or pricelevel.
▪ False - The auth tender does not have any benefits.
isCompTender ▪ True - Allows the user to use the tender with comp items,
and the tender gets included on the Entertainment Tax
reports.
▪ False - User cannot use the tender with comp items.
isCreditTender ▪ True - Indicates the tender is a credit.
▪ False - Indicates the tender is not a credit.
objectIndex For internal purpose.
tenderInfo
roomNumber An alphanumeric value with 8 characters support denotes the
designated identity for the room.
orderAccountAuthorization The account number for which the authorization is made.
orderPostAuthorization The account number to which the tender details are posted
after the transaction.
orderNameAuthorization The account name for which the authorization is made.
orderTenderAdditionalInfo Specifies the additional information of the appropriate tenders.
pmsType Indicates the PMS post site ID based on the mappings
configured in the Tender form.
pmsSubType Indicates the PMS host type based on the mappings configured
in the Tender form.
isSecondarySystem For internal purpose.
isLookupOnly For internal purpose.
terminalOptionIds For internal purpose.
securityToken The token that is returned during the auth transactions.
vendorTransactionId A unique value identifying the transaction in the loyalty
payment.
invoiceId A unique value identifying the invoice. It is similar to the Check
ID.
ccText Refers to the credit card text.
p2PEData For internal purpose.
mechantId It represents the identity number given by the payment
gateway for the merchants.
authCode An authentication code for the store to which the terminal
belongs.
auxillaryAuthCode For internal purpose.
cardNumber Indicates the card number.
accountName Indicates the account name.
cardHolderName Indicates the card holder name.
cvv For internal purpose.
expirationDate The expiry date of the card.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 105
 IGPOS API | Reference Guide

Field Description
tenderId A unique and modifiable value within a range of [1-255]. Some
of the PMS interfaces will not permit users to use the check
types whose ID is greater than nine [9] when Tender ID
number is higher than ninety-nine [99].
tenderDimId For internal purpose.
settleCode For internal purpose.
auxillarySettleCode For internal purpose.
authTime For internal purpose.
authStatus Indicates the status of authorization which is returned for
transaction details from the payment proxy.
encryptedCardData For internal purpose.
encryptionSeed For internal purpose.
startDate For internal purpose.
issueNumber For internal purpose.
rfidFlag For internal purpose.
isRestricted ▪ True - A tender is restricted when it includes items
belonging to a restricted revenue category.
▪ False - A tender is not restricted on any basis.
isAutoRemoveTax ▪ True - Removes tax automatically for the value of the
tender applied to the check.
▪ False - Tax gets included for the value of the tender
applied to the check.
encryptionMode For internal purpose.
verificationMode Indicates the mode of verification.
▪ 1 - PIN Verification
▪ 2 - Signature Verification
entryMode For internal purpose.
postalCode For internal purpose.
authSettleData For internal purpose.
totalAmount The total sale amount of the check.
transactionFollowOnData The data that is received from the third-party is used to perform
actions, such as void tenders or sale reversal transactions.
isFallBack ▪ True - Guests are allowed to change the payment method
when swiping or taping the card is failed.
▪ False - Guests are not allowed to change the payment
method.
mode Refers to one of the following modes:
▪ Chip
▪ Swipe
▪ Contactless
▪ Key
authMode Indicates the mode used to authorize the transaction.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 106
 IGPOS API | Reference Guide

Field Description
applicationIndentifier The application identifier number.
applicationLabel It is a response from the third-party. Mnemonic associated with
the AID according to ISO/IEC 7816-5 - EMV Tag 50
issuerApplicationData A third-party response containing proprietary application data
for transmission to the issuer in an online transaction - EMV
Tag 9F10.
terminalVerificationResults A third-party response indicating the status of the multiple
functions/tests as seen from the terminal. These indicators
from the terminal influences the decision of offline and online
processing for an EMV transaction - EMV Tag 95.
transactionStatusInformation Indicates the functions performed in a transaction - EMV Tag
9B.
authorizationResponseCode A sting consisting of the response code returned from the EMV
transaction.
pinVerificationMode For internal purpose.
customerReceiptText It is a two-column receipt where first column displays text in
primary language and the second column displays the
translated text in the secondary language.
merchantReceiptText The receipt text that is sent by the appropriate endpoint.
cryptogram The cryptogram that is returned by the ICC in response to the
Generate AC command. This is used to verify the request
invoked from the card - EMV Tag 9F26.
reconciliationId A unique value identifying the payment used in PAT Capture.
correlationId A universal ID to retrieve existing payment details from rGuest
Platform for a particular tender.
authMethod Refers to the CC Auth method.
transactionState Indicates the transaction state of the payment. It includes
Authorized, Settled, Sale, VoidSale, Refund, Rejected,
Success, VoidTransaction, Issue, Balance, and others.
isEngageOfflineTender ▪ True - Indicates that the Engage tender is offline.
▪ False - Indicates that the Engage tender is online.
transactionType Indicates the type of transaction. It includes:
▪ Swipe
▪ Tap
▪ Cash
cardNumberConverted For internal purpose.
extraInfo It is a choice for the printer to print extra information, such as
the primary printer number, seat number, course number, etc.,
on the right side of the kitchen chit.
extraInfoIndex For internal purpose.
customerName Indicates the name of the customer.
postingAccount Indicates the posting account number.
balanceAmount Indicates the unpaid amount in the tender.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 107
 IGPOS API | Reference Guide

Field Description
destinationProperty The property that receives the cross-property charge.
sourceProperty The source property that sends the cross-property charge.
pmsSiteId Enterprises with multiple properties labels an identifying Post
Site ID# (0-99) for the tender to post to. The Post Site ID# is
included with the PMS posting information.
isPostToPms ▪ True - The tender transaction data gets posted to the
Property Management System (PMS).
▪ False - The tender transaction data does not get posted to
the Property Management System (PMS).
isPmsAuth ▪ True - Indicates it is a PMS Authorization.
▪ False - Indicates it is not a PMS Authorization.
pmsPostSystem1 Used to select a system to post to other than the standard
PMS.
pmsPostSystem2 Used to select a system to post to other than the standard
PMS.
pmsPostSystem3 Used to select a system to post to other than the standard
PMS.
pmsPostSystem4 Used to select a system to post to other than the standard
PMS.
pmsPostSystem5 Used to select a system to post to other than the standard
PMS.
pmsPostSystem6 Used to select a system to post to other than the standard
PMS.
pmsPostSystem7 Used to select a system to post to other than the standard
PMS.
pmsPostSystem8 Used to select a system to post to other than the standard
PMS.
signature Guest’s signature.
CampusCardInfo
TenderId Tender ID of the campus card tender.
CardNumber Indicates the campus card number.
EncryptionSeed For internal purpose.
Track1 Indicates the track 1 data of the MSR card that is swiped as
input.
Track2 Indicates the track 2 data of the MSR card that is swiped as
input.
InvoiceId A unique value identifying the invoice. It is similar to the Check
ID.
CurrencyCode The currency code of the enterprise as configured in the
Universal Desktop.
SaleAmount The amount for which the sale is being made.
BalanceAmount The balance amount in the campus card.
CampusCardItemCount The supported item count for the campus card tender.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 108
 IGPOS API | Reference Guide

Field Description
BalancePoints Indicates the available balance points.
CardCode A code obtained from a third-party processor representing the
card type to integrate with the POS terminal. This code
supports up to 32 characters.
fsLoyaltyCardInfo
TenderId Tender ID of the gift card tender.
CardNumber Indicates the gift card number.
EncryptionSeed For internal purpose.
Track1 Indicates the track 1 data of the MSR card that is swiped as
input.
Track2 Indicates the track 2 data of the MSR card that is swiped as
input.
InvoiceId A unique value identifying the invoice. It is similar to the Check
ID.
CurrencyCode The currency code of the enterprise as configured in the
Universal Desktop.
SaleAmount The amount for which sale is made.
BalanceAmount Indicates the unpaid check amount.
BalancePoints Indicates the available balance points.
LoyaltyRewardPointsName The promotion name in the loyalty. This name is retrieved from
the loyalty endpoint.
AvailableLabel For internal purpose.
AccountName Indicates the account holder name.
smSettleFlag An integer that represents whether the settlement is successful
for PMS Vintage (Account).
patPaymentId A unique value to identify the payment done through Pay At
Table.
isPatAcknowledge ▪ True - The payment made at table is acknowledged.
▪ False - The payment made at table is not acknowledged.
customerProfileUUId A unique value to identify the customer profile.
availableBalances
PlayerBalanceType Indicates the type of casino player balance. It includes Points,
Patron Points, and Patron Linked Points.
PlayerBalanceAmount Indicates the casino player balane amount.
pmsZoominkey A unique ID that is generated from the check number. This
number is sent to the third-party PMS systems, where it is used
to retrieve the order receipt from the InfoGenesis database.
loyaltyTenderData
Points Indicates the loyalty tender points retrieved from loyalty
endpoint.
PromoCode Indicates the loyalty promotion code retrieved from loyalty
endpoint.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 109
 IGPOS API | Reference Guide

Field Description
PromoName Indicates the loyalty promotion name retrieved from loyalty
endpoint.
PromoType Indicates the loyalty tender promo type. The various promo
types include:
▪ Ig_discount
▪ Pms_visuaone
▪ Pms_lms, Pms_stay
▪ Pms_core
▪ Pms_lightspeed
▪ Pms_rpos
▪ Pms_resortsuite
▪ Casino_igt
▪ Casino_mohegan
▪ Casino_aristocrat
▪ Casino_sgcmp
▪ Casino_sgacsc
▪ Casino_konami
▪ Casino_cmp
▪ Casino_cams
▪ Loyalty_engage
▪ Loyalty_mmhayes
▪ Loyalty_ghs_rccl
▪ Loyalty_starbucks
▪ Loyalty_aspen
▪ Loyalty_boynerewards
▪ Loyalty_hri
▪ Loyalty_hmc
▪ Loyalty_cams
▪ Loyalty_ezlinks
▪ Loyalty_galaxy
▪ Pump_ghs
MenuId Indicates the loyalty tender menuID retrieved from the loyalty
endpoint.
MenuQty Indicates the loyalty tender menu quantity retrieved from the
loyalty endpoint.
MenuUnitPrice Indicates the loyalty tender menu unit price retrieved from the
loyalty endpoint.
ExtraInfo Indicates the loyalty tender extrainfo retrieved from the loyalty
endpoint.
authMode Specifies the authorization mode.
Example: CC Auth Mode
isPatAuth ▪ True - The authorization is performed through pay at table.
▪ False - The authorization is not performed through pay at
table.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 110
 IGPOS API | Reference Guide

Field Description
receiptsToPrint Indicates the number of receipts to print after tendering a
check.
isDeposit ▪ True - The deposit is made during the refund closed
checks. This means the amount is credited to the
appropriate guest for initiated refund.
▪ False - No deposits are made.
realTimePostSiteId Refers to PMS Posted Site ID.
isAuth ▪ True - Indicates it is an authorization.
▪ False - Indicates it is not an authorization.
tenderClassId For internal purpose.
accountType For internal purpose.
splitCheckId For internal purpose.
amountMaxAuth The maximum amount for which the authorization can be
made.
authFlags For internal purpose.
authOnlyFlag ▪ True - It is only for authorization. The tender verification
codes selected for the PMS tender type is not account type
and is cash only.
▪ False - It is not strictly for authorization. The tender
verification codes selected for the PMS tender type is
account type.
voidFlag ▪ True - The tender applied in the check is voided.
▪ False - The tender is not voided.
amt_auto_adjusted For internal purpose.
hostCapture_flag For internal purpose.
pms_fidelio_flag ▪ True - The PMS Fidelio type is supported.
▪ False - The PMS Fidelio type is not supported.
amt_tpg_auth For internal purpose.
emvMobileFlag ▪ True - The payment is done as PayAtTable.
▪ False - The payment is done as PayAtCounter or other
available modes of payment.
isSendRequestToPmsHost ▪ True - The request is sent to PMS host.
▪ False - The request is not sent to PMS host.
isVATModeEnabled ▪ True - The tax is included in the item price and service
charge associated with the check.
▪ False - The tax is not included in the item price and service
charge.
isLimitedReopenFlag ▪ True - Users are restricted from reopening the check after
the specified limit.
▪ False - Users do not have any restrictions on reopening
the check.
isIGTerminal For internal purpose.
receiptText The text to be printed on the receipt.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 111
 IGPOS API | Reference Guide

Field Description
auxReceiptText The description of aux receipt.
receiptPrintCount The total count of receipt to be printed.
noOfDecimals The number of decimals used for currency divisor.
revenuecategories
Id A system generated or manually entered unique value in the
range of [1-99] to identify the revenue category.
RevCatDimId For internal purpose.
GroupId A unique value identifying the revenue category group.
IRSFlag ▪ True - The category is included in the IRS reports.
▪ False - The category is not included in the IRS reports.
SalesAmount The amount for which the sale is made.
DiscountAmount The discount amount associated with the check.
ExclusiveTaxAmount The non-inclusive tax amount.
NoTaxNetSales The cost of the item without discount amount, inclusive gratuity,
and inclusive service charge.
SalesAmountTaxInclusive The tax amount associated with the sale price.
TaxInclusiveItemDiscountAmo The tax amount associated with the total item discount price.
unt
InclusiveTaxAmount The total amount of inclusive tax calculated.
TaxCode A unique string identifying the tax category.
IsTenderRestricted ▪ True - The specified item is tender restricted item.
▪ False - The specified item is not a tender restricted item.
GiftCardCreditInfo
Status
Code A unique code identifying the success/error messages.
Message The success/error messages displayed during the check
transaction.
DebugMessage The debug messages during the check transaction.
CardData
CardNumber Indicates the gift card number.
CardClassifier For internal purpose.
CVV2 For internal purpose.
PinNumber The security pin to use the gift card.
CardExpiration The validity of the gift card.
CardTrackOne Specifies the card data track 1 information.
CardTrackTwo Specifies the card data track 2 information.
AddressVerification For internal purpose.
SecurityToken For internal purpose.
CardDataSource For internal purpose.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 112
 IGPOS API | Reference Guide

Field Description
AvailableBalance
Amount The balance amount that the gift card holds.
Currency Indicates the type of currency.
Example: USD, Euro, and others.
InvoiceID A unique value identifying the invoice. It is similar to the Check
ID.
HandleData A string holding the handle information.
TenderID A unique and modifiable value within a range of [1-255]. Some
of the PMS interfaces will not permit users to use the check
types whose ID is greater than nine [9] when Tender ID
number is higher than ninety-nine [99].
IsSale ▪ True - The gift card transaction is a sale.
▪ False - The gift card transaction is not a sale.
giftCardBalance Indicates the available balance on the customer’s gift card.
campusCardBalance Indicates the available balance on the campus card.
isReopen ▪ True - The check is reopened.
▪ False - The check is not reopened.
modifiedVatDifferenceAmt The amount that is calculated by subtracting exclusive modified
VAT cost from the exclusive cost of gratuity and service
charge.
preAuthTaxAmount The tax amount that is calculated before authorization.
isModifiedVatToServiceCharge ▪ True - The modified VAT is applicable to service charge.
▪ False - The modified VAT is not applicable to service
charge.
currentCourseId A unique value identifying the course for the items added in the
check.
vipSeat Identifies a seat as a VIP for which a special character will be
placed next to the seat on a kitchen printer receipt.
seatTotal For internal purpose.
fiscalInfo A string holding information about the fiscal.
fiscalText A string holding the receipt information regarding taxes and
fiscal details.
fiscalTaxSummary For internal purpose.
taxInvoiceNumber For internal purpose.
quebecCheckDate For internal purpose.
guestAccountNumber For internal purpose.
inventoryUpdateList For internal purpose.
matchContext
MatchPackageId For internal purpose.
MatchPackages
int

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 113
 IGPOS API | Reference Guide

Field Description
Index For internal purpose.
Items
MatchList
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildMatchItems
MatchList
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
ComboType For internal purpose.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 114
 IGPOS API | Reference Guide

Field Description
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
ChildMatchItems
QuantityNeeded For internal purpose.
QuantityNeeded For internal purpose.
MatchedPackages
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
BackupMatches
MatchList

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 115
 IGPOS API | Reference Guide

Field Description
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
ChildMatchItems
MatchList
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 116
 IGPOS API | Reference Guide

Field Description
PackageId For internal purpose.
GroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
ChildMatchItems
QuantityNeeded For internal purpose.
QuantityNeeded For internal purpose.
BackupMatchesList
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
BackupMatchPackages
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 117
 IGPOS API | Reference Guide

Field Description
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
Package
Id For internal purpose.
AutoPackage For internal purpose.
Priority For internal purpose.
PackageItems
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
ComboType For internal purpose.
ItemType For internal purpose.
Id For internal purpose.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 118
 IGPOS API | Reference Guide

Field Description
PackageId For internal purpose.
SelectionGroupId For internal purpose.
Quantity For internal purpose.
Sequence For internal purpose.
CheckIndex For internal purpose.
Amount For internal purpose.
IsSaved For internal purpose.
ChildItems
TotalPrice For internal purpose.
Quantity For internal purpose.
RejectedPackages
IsAutoPackaged For internal purpose.
IsFullScan For internal purpose.
LastIndexScanned For internal purpose.
rejectedPackages
fiscalLotteryCode For internal purpose.
additionalInfo
string For internal purpose.
colombiaCustomInfo
string For internal purpose.
indiaGuestInfo
GuestId ID of the guest.
GSTIN Guest’s GST number.
StateCode The code assigned for the guest’s state.
FirstName Guest’ first name.
LastName Guest’s last name.
AddressField1 Guest’s address.
AddressField2 Guest’s address.
AddressField3 Guest’s address.
AddressField4 Guest’s address.
irnNumber The invoice reference number used in India Fiscal.
banquetDataInfo For internal purpose.
orNumber Indicates the order receipt number. This is generated when the
Terminal Option 1229 (Disable the generation of offline OR) is
disabled.
arNumber Indicates the account receivable number.
refundSeqNumber A string consisting of Terminal ID and refund sequence number
based on the Terminal form. When the Terminal Option 1216

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 119
 IGPOS API | Reference Guide

Field Description
(Enable Philippines Fiscal Functionality) is enabled, the refund
sequence number gets filled.
voidSeqNumber A string consisting of Terminal ID and void sequence number
based on the configurations in the Terminal form.
dataString For internal purpose.
starbucks
TransactionNumber A unique reference number identifying a transaction. When the
transaction number is not available, check number is used.
SourceTransactionNumber A unique number used to identify the source system from
which the transaction is executed.
UtcOffset The time difference between local time and Universal Time
(UTC) is specified in the appropriate format (+hh:mm or -
hh:mm). This helps in identifying the local transaction date and
time.
RetryIndicator ▪ True - The request is re-iterated when it gets timed out.
▪ False - The request is not re-iterated when it gets timed
out.
MerchantId A unique merchant identifier that lies within a range of 1-16
characters. This ID is used for Starbucks card operations.
Store
StoreNumber The zero-padded 6-digit Starbucks store number where the
transaction is completed.
SourceStoreNumber A unique identifier to identify.
RegisterNumber A 2-6-digit unique Starbuck register number where the
transaction is completed.
LoyaltyMember
MemberUId A unique identifier of an active loyalty member. This is not
applicable for country codes that support MSR 2.0.
CardNumber Member’s card number.
Name
FirstName Member’s first name.
LastName Member’s last name.
Program
Name The program name to which the member is registered to.
TierSummary
Id The ID of the member’s current tier.
PointSummary
TierPoints The total number of tier points earned by the member in the
current tier. 0 is returned for a new member.
RewardPoints The total number of reward points that are eligible for redeem.
RewardPointsRedeemed The total number of reward points that are actually redeemed.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 120
 IGPOS API | Reference Guide

Field Description
RewardPointsAvailable The balance reward points after the redeem.
RewardSummary
Coupons
Id A unique value identifying the coupon.
Name
ShortName The short name of the coupon.
LongName The long name of the coupon.
RewardCode A code that is used to redeem the coupon.
ExpiryDate The date at which the coupon expires. It expires at midnight on
the specified date.
RedemptionDetail
AllowedCount The number of times the specified coupon is allowed to be
redeemed.
RedeemedCount The number of times the specified coupon is redeemed.
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
OrderIndex The index of items in the order.
ModifierId A unique value identifying the modifier.
ModifierIndex The index of modifiers in the order.
IsEligible ▪ True - The Starbucks coupon is eligible.
▪ False - The Starbucks coupon is not eligible.
Quantity The coupon quantity.
Discount
Id A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
DimId For internal purpose.
Level Denotes whether it is an item level discount or a check level
discount.
DiscountSKUCode An alphanumeric discount code (printed on receipts) with a
maximum of 30 characters that enables users to apply a
discount to the check by scanning the barcode.
SecurityId Security Level ID. The item can be ordered only by employees
above this security level
ProfitCenterGroupId A system generated or manually entered unique numerical
value within the range of [1-999] assigned to the profit center
group. With some of the Property Management System (PMS)
interfaces, only up to two-digit numbers (99) are usable.
IsFixed ▪ True - Denotes that the discount is for a fixed percentage
or amount.
▪ False - Denotes it is an open discount that varies in
percentage or amount.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 121
 IGPOS API | Reference Guide

Field Description
IsPercentage ▪ True - Calculates discount on a percent basis.
▪ False - Calculates discount on an amount basis.
IsExclusive ▪ True - The check can have only one discount and it cannot
be clubbed with any other discounts.
▪ False - The discount can be applied in conjunction with
any other discounts.
AffectTax ▪ True - The discount does not impact the taxes available in
the check.
▪ False - The taxes get adjusted according to the discount
applied.
Value The value of the discount.
MaxValue The maximum value till which the discount can be applied. This
is used in case of percentage or open discounts.
PromptExtraCode A prompt to provide additional information for a chosen
discount. User can enter the text manually using the on-screen
keyboard or by using the card swipe.
PromptOpen ▪ True - The extra data is collected while applying the
discount.
▪ False - The extra data is not collected while applying the
discount.
AllowedRevenueGroup All the four revenue groups in the Main tab are selected by
default. If none is selected, the Eligibility tab is disabled. The
Product Classes, Items, Store Items, Check Types, and
Packages on the Eligibility tab are populated based on the
Revenue Group selection
DiscountRule
RuleId A system generated or manually entered number for the
coupon or discount.
RuleDimId For internal purpose.
RuleDateFrom Indicates the start day (in DD/MM/YY format) from which the
discount will be applied.
RuleDateTo Indicates the last day (in DD/MM/YY format) to which the
discount will be applied.
RuleStartTimeMinutes Indicates the discount start time in minutes.
RuleEndTimeMinutes Indicates the discount end time in minutes.
RuleRecurrenceType Indicates the frequency of the same discount to come into
effective. Eg: Daily, Weekly, Monthly, and Yearly.
RuleDayofweekMask Discount rule recurrence setting to indicate the day of the week
when the rule can be applied.
RuleDayofmonth Discount rule recurrence setting to indicate the day of the
month when the rule can be applied.
RuleOrdinalDay Discount rule recurrence setting to indicate the ordinal day in a
month/year when the rule can be applied.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 122
 IGPOS API | Reference Guide

Field Description
RuleMonthofyear Discount rule recurrence setting to indicate the month of the
year when the rule can be applied.
RuleRevenueGroup Based on the selected revenue group, Product Classes, Items,
Store Items, Check Types, and Packages are populated. By
default, all four categories in the revenue groups are selected.
IsItemCriteriaEnabled ▪ True - The minimum item quantity is checked before
applying the item level discount.
▪ False - The minimum item quantity is not checked before
applying the item level discount.
MinItemQuantity The minimum quantity of item to apply item level discount.
ItemPriceDiscount The item level discount price that is decided based on the price
of the item. When Highest is configured, the maximum unit
price among the items will be considered as the discount value.
RuleConstraintJoin
RuleConstraintId For internal purpose.
RelevantIds
Id Indicates the division or store modifier ID that is eligible for
discount.
ItemFlag ▪ True - Indicates it is an item.
▪ False - Indicates it is not an item.
Tier
TierId It is a unique system generated value that falls within a range
of [1-999].
TierName An alphanumeric value with a maximum limit of 50 characters
indicates the player’s tier level.
CMSId Denotes the Casino Management System ID.
MaxLimit The maximum discount limit applicable for a tier.
RewardValue The value of the tier rewards applicable to the guest.
TierDesc The description about the tier level.
ExtraData Represents a unique numeric value for the modifier.
IsTenderReducesDisc ▪ True - The discount gets re-calculated in proportion to the
tender, thereby enabling users to apply discounts even in a
partially tendered check.
▪ False - The discount does not get re-calculated.
splitDiscFlag For internal purpose.
IsAffectGratuity ▪ True - The discount does not impact the gratuity.
▪ False - The gratuity gets adjusted based on the applied
discount.
IsAffectServiceCharge ▪ True - The discount does not impact the service charge.
▪ False - The service charge gets adjusted based on the
applied discount.
IsStarbucksDiscount ▪ True - The Starbuck’s loyalty program is applicable.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 123
 IGPOS API | Reference Guide

Field Description
▪ False - The Starbuck’s loyalty program is not applicable.
StarbucksDiscountInfo
MerchantId A unique merchant identifier that lies within a range of 1-16
characters. This ID is used for Starbucks card operations.
TransactionNumber A unique reference number identifying a transaction. When the
transaction number is not available, the check number is used.
IsSaved ▪ True - The check is saved.
▪ False - The check is not saved.
IsVoided ▪ True - The items in the check are voided.
▪ False - The items in the check are not voided.
StoreNumber The zero-padded 6-digit Starbucks store number where the
transaction is completed.
RegisterNumber A 2–6-digit unique Starbuck register number where the
transaction is completed.
Sequence The sequence of the items in the check.
RedemptionSequence A container of information regarding the redemption status of
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
DiscountId A system generated or manually entered value within the range
[1-9999] that identifies the discount.
RewardCode A unique code that is used to redeem the coupon.
IsCouponDisc ▪ True - It is a coupon discount.
▪ False - It is not a coupon discount.
ModifierId A unique value identifying the modifier.
IsRCCLDiscount ▪ True - It is an RCCL Discount.
▪ False - It is not an RCCL Discount.
RCCLDiscountInfo
PromotionID A unique string identifying the promo to avail RCCLDiscount.
PromoName The name of the promo.
Points The reward points available for RCCLDiscount.
MenuItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
Quantity The item quantity.
UnitPrice The cost of item.
ACESDiscountInfo
PromotionID A unique string identifying the promo to avail ACESDiscount.
PromoName The name of the promo.
PrizeID A unique value identifying the available prizes in the
ACESDiscount.
PackageID A unique value identifying the package.
Amount The discount amount.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 124
 IGPOS API | Reference Guide

Field Description
PrizeType Indicates one of the following price types:
▪ Free
▪ Discount
▪ Flat Discount
▪ Flat Price
PromoProductClassName For internal purpose.
DiscExtraText Indicates additional text details provided for ACES discounts.
AppliedItemIndex The index of items for which the ACES discount is applied.
PackageItemIndex The index of package items.
IsTaxable ▪ True - The tax is applicable for the order.
▪ False - The tax is not applicable for the order.
IsTaxOnOldPrice ▪ True - The tax is applied to the item price that is calculated
without discount.
▪ False - The tax is applied to the item price that is
calculated after applying the discount.
MinCartAmount The minimum cart amount to apply discount.
PMSAccountDiscountMaxCap The maximum discount value to be considered for PMS
account-based discount.
IsPMSAccountDiscount ▪ True - The discount is a PMS account-based discount.
▪ False - The discount is not a PMS account-based discount.
RewardCode A unique code that is used to redeem the coupon.
PointSummary
TierPoints The total number of tier points earned by the member in the
current tier. 0 is returned for a new member.
RewardPoints The total number of reward points that are eligible for redeem.
RewardPointsRedeemed The total number of reward points that are actually redeemed.
RewardPointsAvailable The balance reward points after the redeem.
StarbucksDiscountInfo
MerchantId A unique merchant identifier that lies within a range of 1-16
characters. This ID is used for Starbucks card operations.
TransactionNumber A unique reference number identifying a transaction. When the
transaction number is not available, the check number is used.
IsSaved ▪ True - The check is saved.
▪ False - The check is not saved.
IsVoided ▪ True - The items in the check are voided.
▪ False - The items in the check are not voided.
StoreNumber The zero-padded 6-digit Starbucks store number where the
transaction is completed.
RegisterNumber A 2–6-digit unique Starbuck register number where the
transaction is completed.
Sequence The sequence of the items in the check.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 125
 IGPOS API | Reference Guide

Field Description
RedemptionSequence A container of information regarding the redemption status of
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
DiscountId A system generated or manually entered value within the range
[1-9999] that identifies the discount.
RewardCode A unique code that is used to redeem the coupon.
IsCouponDisc ▪ True - It is a coupon discount.
▪ False - It is not a coupon discount.
ModifierId A unique value identifying the modifier.
loyaltyCredit
LoyaltyCreditIndexId For internal purpose.
CreditAmount For internal purpose.
loyaltyTenderData
Points Indicates the loyalty tender points retrieved from loyalty
endpoint.
PromoCode Indicates the loyalty promotion code retrieved from loyalty
endpoint.
PromoName Indicates the loyalty promotion name retrieved from loyalty
endpoint.
PromoType Indicates the loyalty tender promo type. The various promo
types include:
▪ Ig_discount
▪ Pms_visuaone
▪ Pms_lms, Pms_stay
▪ Pms_core
▪ Pms_lightspeed
▪ Pms_rpos
▪ Pms_resortsuite
▪ Casino_igt
▪ Casino_mohegan
▪ Casino_aristocrat
▪ Casino_sgcmp
▪ Casino_sgacsc
▪ Casino_konami
▪ Casino_cmp
▪ Casino_cams
▪ Loyalty_engage
▪ Loyalty_mmhayes
▪ Loyalty_ghs_rccl
▪ Loyalty_starbucks
▪ Loyalty_aspen
▪ Loyalty_boynerewards
▪ Loyalty_hri

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 126
 IGPOS API | Reference Guide

Field Description
▪ Loyalty_hmc
▪ Loyalty_cams
▪ Loyalty_ezlinks
▪ Loyalty_galaxy
▪ Pump_ghs
MenuId Indicates the loyalty tender menuID retrieved from the loyalty
endpoint.
MenuQty Indicates the loyalty tender menu quantity retrieved from the
loyalty endpoint.
MenuUnitPrice Indicates the loyalty tender menu unit price retrieved from the
loyalty endpoint.
ExtraInfo Indicates the loyalty tender extrainfo retrieved from the loyalty
endpoint.
empTipGratScData
EmpId For internal purpose.
TipAmt For internal purpose.
GratAmt For internal purpose.
SvcChgAmt For internal purpose.
bonusCodeData
BonusIndex For internal purpose.
BonusCode For internal purpose.
splitPaymentByTypeDetail
SplitSelectionType Indicates how the split is performed. The following are the
supported types:
▪ Split by Count
▪ Split by Amount
▪ Split by Percentage
NoOfSplits The total number of split payments.
SplitPaymentDetails
SplitPercentage Indicates the percentage used in the split payment.
SplitAmount The amount calculated from the total split amount.
SplitAmountMaxThreshold Indicates the maximum split amount for a given check.
isCasinoEnabled ▪ True - The casino management is enabled.
▪ False - The casino management is disabled.
isFoodServiceLoyaltyEnabled ▪ True - The food service loyalty is enabled.
▪ False - The food service loyalty is disabled.
istO185Enabled ▪ True - The Terminal Option 185 (Calculate tax on gross
subtotal) is enabled. When this terminal option is enabled,
the check’s tax is calculated on the gross subtotal (before
discounts).
▪ False - The Terminal Option 185 (Calculate tax on gross
subtotal) is disabled. When this terminal option is disabled,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 127
 IGPOS API | Reference Guide

Field Description
the check’s tax is calculated on the net subtotal (after
discounts).
isBrunswickInterfaceEnabled ▪ True - The Terminal Option 1199 (Enable Brunswick
Interface) is enabled. When this terminal option is enabled,
the communication is established between InfoGenesis
and Brunswick.
▪ True - The Terminal Option 1199 (Enable Brunswick
Interface) is disabled. When this terminal option is
disabled, no communication is established between
InfoGenesis and Brunswick.
isCompleteTender For internal purpose.
closedChecks Indicates sub-checks of the master check.
openTimeInMilliSeconds The time (in milli seconds) at which the check was opened.
closeTimeInMilliSeconds The time (in milli seconds) at which the check was opened.
deliveryInfo
CustomerName Guest’s name.
Address Guest’s address of the guest.
PostalCode Guest’s postal code.
Phone Guest’s phone
PickUpTime The pick-up time of the order.
Cutlery Indicates the cutlery choices of the guest.
Type Indicates the fulfilment type.
Example: Dine-in, Pick-up, or Delivery.
Email Guest’s email address.
checkObjectType Indicates the type of check.
Example: Normal, Scheduled Check, Sub Check, or Master
Check.
subCheckAddons For internal purpose.
uniqueKeyNumber A unique value identifying the check.
isScheduledCheckFinalPayme ▪ True - The payment is not finalized for a scheduled order.
nt ▪ False - The payment is finalized for a scheduled order.
associatedCheckList The list of checks associated with the actual check.
kssEventType Indicates the type of kitchen event.
Example: KP, KV, Both, or None.
addOnCharges
addOnAmount The amount for add-on charges.
addOnModifiedVatAmt The amount calculated for add-on charges when Use Modified
VAT is set to True.
TaxCollection
_dictionayTaxById
c_ExclusiveCost

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 128
 IGPOS API | Reference Guide

Field Description
value For internal purpose.
ExclusiveCost For internal purpose.
c_InclusiveCost
value For internal purpose.
c_ExclusiveCost
value For internal purpose.
c_FixedInclusiveCost
value For internal purpose.
c_FixedExclusiveCost
value For internal purpose.
c_RemovedTaxPercent
value For internal purpose.
ExclusiveCost The total amount of exclusive tax calculated.
InclusiveCost The cost of the item which is tax inclusive.
FixedInclusiveCost A fixed inclusive cost amount.
FixedExclusiveCost A fixed exclusive cost amount.
RemovedTaxPercent The percentage of removed tax.
Taxes
Details
Amount The total tax amount associated with the tender.
Id A unique value identifying the tax.
RoundingConfiguration
roundType Round off the value of the check to the nearest unit.
roundBasis A desired value in the range of [1-50000] to round the check.
For example, in the US, typing 50000 rounds to $500.00.
Level Specifies add-on charges level. It can be either check level or
item level.
ChargeType Indicates the type of add-on charge.
▪ Gratuity = 1
▪ ServiceCharge = 2
▪ Tip = 3
▪ Withheld = 4
▪ CreditTender = 5
Id A unique value identifying the add-on charge.
DimId For internal purpose.
AddOnCalculationType Specifies the add-on calculation type. The types include
Percentage, FixedAmount, or both.
RoundingConfiguration
roundType Round off the value of the check to the nearest unit.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 129
 IGPOS API | Reference Guide

Field Description
roundBasis A desired value in the range of [1-50000] to round the check.
For example, in the US, typing 50000 rounds to $500.00.
Percentage The percentage of add-on charge applied.
FixedCheckAmount The fixed amount calculated for add-ons applied in the check.
FixedCoverAmount Indicates the cover count for a check.
MinCover The minimum cover count per check.
MaxCover The maximum cover count per check.
CanRemovalAtTerminal ▪ True - The gratuity or service charge gets removed from
the check. This option is accessible only by employees
with higher job security levels. They can remove or restore
a gratuity (job code function 191) or a service charge (job
code function 225).
▪ False - The employees cannot remove the gratuities or
service charge from the check.
CanPayoutAtTerminal ▪ True - Gratuity or service charge accumulates along with
other tips to be paid out in cash at the terminal. A tip
payout can be performed at the terminal via the terminal’s
Shift Reset report (activate Terminal Option 210
(Automatically prompt for tip transfer and tip payout) to
automatically prompt for tip payout) or by selecting the Tip
Payout button. Running the Shift Reset report also updates
the Server Shift Sales, Tips and Gratuities report, the
Server Shift Sales, Tips, and the Grats Summary report.
▪ False - When user selects not to pay out this gratuity at the
terminal, it is still reported on back-office reports, so the
gratuity is paid by alternative means (i.e., payroll).
IsAddOnExclusive ▪ True - The add-on charge is exclusive. The gratuity and
service charges are on a fixed amount basis.
▪ False - The add-on charge is non-exclusive. The gratuity
and service charge are on a percentage basis.
IsRemoved ▪ True - The add-on charge is removed from the check.
▪ False - The add-on charge is not removed from the check.
Recipient The appropriate add-on recipients. It can Cashier, Employee,
and Server.
Employee
Id A unique number [1 to 999,999,999] assigned to an employee.
EmployeeDimId For internal purpose.
EmpShiftId The shift ID of the employee.
EmpJobCode The jobcode assigned to the employee.
Name The name of the employee.
Percentage For internal purpose
SalesType Specifies the add-on sales type. It can be gross sales or net
sales.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 130
 IGPOS API | Reference Guide

Field Description
AssociatedRevenueCategories Refers to the associated revenue categories of the add-on
charge.
IsAddOnTaxApplicable ▪ True - The tax is applicable for the add-ons applied in the
check.
▪ False - The tax is not applicable for the add-ons applied in
the check.
UseModifiedVat ▪ True - The VAT is modified, and the modified VAT amount
is used.
▪ False - The modified VAT amount is not used.
RedeemEligible Customers earn loyalty points as rewards when the system is
integrated with Casinos or others.
EarnEligible Customers can redeem their loyalty points.
IncludeIRSReporting ▪ True - The sales from the appropriate tender are included
in IRS Tip and IRS Tip by profit center reports.
▪ False - The sales from the appropriate tender are not
included in IRS Tip and IRS Tip by profit center reports.
IsTaxInclusiveItem ▪ True - The tax is included for the items added in the check.
▪ False - The tax is excluded for the items added in the
check.
AddonGroup
AddonGroupId ID of the add-on group.
AddonGroupName The name of the add-on group.
ReportRev ▪ True - A report is generated for the revenue.
▪ False - No report is generated for the revenue.
IsGratuity ▪ True - The add-on is a gratuity.
▪ False - The add-on is not a gratuity.
RevCatId A unique value identifying the revenue category.
AddonGroupDimId For internal purpose.
IsGroupedAddon ▪ True - The add-on is grouped.
▪ False - The add-on is not grouped.
IsTenderGrat ▪ True - The gratuity charge is applied to the tender.
▪ False - The gratuity charge is not applied to the tender.
TenderDetails A tuple which holds the values of TenderBasis, IsPost, and
Add-On amount.
Amount The total add-on amount.
ModifiedVatAmount The modified vat amount for the add-on applied in the check.
ExclusiveAmount Indicates the add-on amount. The appropriate amount is
assigned only when AddOnExclusive is set to True.
ExclusiveTaxCost The exclusive amount calculated as tax for the add-on applied
in the check.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 131
 IGPOS API | Reference Guide

Authentication
Login
This API is called to authenticate user credentials.
Method: POST
URL: https://<environment>/Login

Sample Request
{
"ClientCertificateId": "string"
}

□ Refer to the following table for the description:

Field Description
ClientCertificateId Indicates the certificate ID of the POS API client. It
authenticates the source of requests.

Sample Response
"string"

□ Refer to the following table for the description:

Field Description
string A JSON web token is returned.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 132
 IGPOS API | Reference Guide

Check Transaction
CreateCheck
This API is called to create an empty check with the information passed in the request.
Method: POST
URL: https://<environment>/CreateCheck

Sample Request
{
"checkType": "string",
"tableNumber": "string",
"coverCount": 0,
"checkLabel": "string",
"roomNumber": "string",
"dataTag": "string",
"dataTagType": 0,
"taggedAccountId": "string",
"gaPriceLevel": 0,
"EmployeeId": "string"
}

□ Refer to the following table for descriptions:

Field Description
checkType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.
tableNumber A unique number labelled for a table.
coverCount Shows the number of covers per check.
checkLabel Denotes the label assigned to the check.
roomNumber An alpha numeric value with 8 characters support denotes the
designated identity for the room.
dataTag The name of the guest whose account has been tagged to the
check
dataTagType The type of the account that the guest has used. The following
are the available account types:
▪ None = 0
▪ GA = 1
▪ InteractiveAccount = 2
▪ Loyalty = 3
▪ Member = 4
▪ Folio = 5
▪ Banquet = 6

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 133
 IGPOS API | Reference Guide

Field Description
▪ CampusCard = 7
taggedAccountId The account ID of the guest that has been tagged to the check.
gaPriceLevel Denote the default price level assigned to the GA class.
EmployeeId A unique number [1 to 999,999,999] assigned for an employee.

Sample Response
Refer to the Check Data Sample Response section for more information.

SetDeliveryInfo
This API is called to add delivery information to the check, which will then be added to the
kitchen requests.
Method: POST
URL: https://<environment>/SetDeliveryInfo

Sample Request
{
"checkNumber": "{{CHECK_NUMBER}}",
"guid": "{{CHECK_GUID}}",
"deliveryInfo": {
"CustomerName": "CName",
"Address": "ASD, NO 10, 600098",
"PostalCode": "6879797",
"Phone": "+1-432345667",
"PickUpTime": "2023-11-21 07:30:39",
"Cutlery": "1",
"Type": "Online",
"Email": "someemail@mail.com"
}
}

□ Refer to the following table for descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
deliveryInfo
customerName Indicates the name of the guest.
Address Indicates the delivery address.
PostalCode Indicates the postal code of the delivery address.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 134
 IGPOS API | Reference Guide

Field Description
Phone Indicates the guest’s phone number.
PickUpTime Indicates the time at which the order must be delivered.
Cutlery Indicates the cutlery choices selected by the guest.
Type Indicates the fulfilment type.
Email Indicates the guest’s email address.

Sample Response
Refer to the Check Data Sample Response section for more information.

AddDonation
API to enable donation amount to be credited to the GA account.
Method: POST
URL: https://<environment>/AddDonation

Sample Request
{
"checkNumber": "{{CHECK_NUMBER}}",
"checkGuid": "{{CHECK_GUID}}",
"PaymentHandles": [
{
"paymentHandle": "string",
"amount": 20
}
]
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
checkGuid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
PaymentHandles
paymentHandle If payment handle is given, the donation is credited to the
matched GA account. If payment handle is not given, the
donation is credited to the unmatched GA account.
amount The donation amount to be credited. The amount must always
be positive.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 135
 IGPOS API | Reference Guide

Sample Response
Refer to the Check Data Sample Response section for more information.

CalculateOrder
CalculateOrder API is called to calculate the check total after adding items, discounts, and
payments based on configurations. The response of this API does not contain error messages.
For example, when an item is 86’ed, the response of this API does not pass the information that
the item is not available.
Method: POST
URL: https://<environment>/CalculateOrder

Sample Request
{
"ScheduleTime": null,
"checkType": null,
"tableNumber": null,
"coverCount": 0,
"roomNumber": "string",
"gaPriceLevel": 0,
"scheduleTime": null,
"checkLabel": "string",
"dataTag": "string",
"dataTagType": 0,
"EmployeeId": "string",
"items": [
{
"quantity": 0,
"price": 0,
"openItemName": null,
"weight": 0,
"isPriceOverride": false,
"IsSoldByWeight": false,
"itemId": null,
"skuCode": null,
"modifiers": [
{
"id": 0,
"choiceGroupID": 0,
"discountExtraData": null,
"specialInstructions": null,
"modifiers": null,
"ChoiceGroupData": null,
"Quantity": 0
}
],
"specialInstructions": [
{

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 136
 IGPOS API | Reference Guide

"id": 0,
"text": null
}
],
"discounts": [
{
"discountId": 0,
"discountLevel": 0,
"openDiscountValue": 0,
"extraData": null,
"DiscSource": 0,
"promoCode": null,
"IsPMSAccountDiscount": false,
"PMSAccountDiscountMaxCap": 0
}
]
}
],
"discounts": [
{
"discountId": 0,
"discountLevel": 0,
"openDiscountValue": 0,
"extraData": null,
"DiscSource": 0,
"promoCode": null,
"IsPMSAccountDiscount": false,
"PMSAccountDiscountMaxCap": 0
}
],
"serviceChargeValue": 0,
"gratuityValue": 0,
"tipValue": 0,
"packages": [
{
"packageId": null,
"quantity": 0,
"SeatNumber": null,
"Items": [
{
"SelectionGroupId": 0,
"ItemId": 0,
"Sequence": 0,
"Quantity": 0,
"Modifiers": null,
"specialInstructions": null,
"Price": 0,
"IsPackagePmixFlag": false
}
]
}
],
"tenders": [

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 137
 IGPOS API | Reference Guide

{
"tenderId": null,
"tenderAmount": 0,
"tipAmount": 0
}
]
}

□ Refer to the following table for field descriptions:

Field Description
ScheduleTime The time at which the items in the check need to be served.
checkType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.
tableNumber A unique number labelled for a table.
coverCount Shows the number of covers per check.
roomNumber An alpha numeric value with 8 characters support denotes the
designated identity for the room.
gaPriceLevel The price associated with the GA account type.
scheduleTime The time at which the items in the check need to be served.
checkLabel Indicates the label assigned to the check.
dataTag Name of the guest whose account has been tagged to the
check
dataTagType The type of the account that the guest has used. The following
are the available account types:
▪ None = 0
▪ GA = 1
▪ InteractiveAccount = 2
▪ Loyalty = 3
▪ Member = 4
▪ Folio = 5
▪ Banquet = 6
▪ CampusCard = 7
EmployeeId A unique number [1 to 999,999,999] assigned for an employee.
items
quantity Denotes the quantity of items listed in the check.
price Denotes the price of the item.
openItemName The name entered by the employee to an open item while
adding it to the check.
weight If the item is sold by its weight, this field denotes the weight of
the item listed in the check.
isPriceOverride ▪ True - Overrides the scanned price of a retail item.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 138
 IGPOS API | Reference Guide

Field Description
▪ False - Does not override the scanned price of a retail
item.
IsSoldByWeight ▪ True - It activates the Tare Weight field as the item’s base
price is the price per unit of weight (Pound, Kilogram,
gram, etc.,)
▪ False - Denotes the item is not sold on a weight basis.
itemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
skuCode The alphanumeric code assigned to the item that can be swiftly
scanned by a barcode reader during the purchase.
modifiers
id Represents a unique identity value for the modifier.
choiceGroupID A unique numerical value within a range of [1-99999] to identify
a choice group.
discountExtraData A prompt to provide additional information for a chosen
discount. User can enter the text manually using the on-screen
keyboard or by using the card swipe.
specialInstructions Denotes the special instruction added for modifiers.
modifiers Array of modifiers to be added to an item.
ChoiceGroupData Data pertaining to the choice group that holds the modifier
Quantity Denotes the quantity of modifiers added to the check.
specialInstructions
id A unique numerical value within a range of [1-9999] to identify
the special instruction.
text Represents the name of the special instruction with a maximum
of 20 characters.
discounts
discountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
discountLevel Denotes whether it is an item level discount or a check level
discount.
openDiscountValue Denotes the value of the discount in percentage or amount
basis. This varying percentage can be represented accurately
with 3 decimal places.
extraData A prompt to provide additional information for a chosen
discount.
DiscSource Indicates the source of the discount. For example, PMS
Discount, Auto Discount from Tender, and others)
promoCode The promo code associated with a Discount.
IsPMSAccountDiscount ▪ True - The discount is a PMS account-based discount.
▪ False - The discount is not a PMS account-based discount.
PMSAccountDiscountMaxCap The maximum discount value to be considered for PMS
account-based discount.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 139
 IGPOS API | Reference Guide

Field Description
discounts
discountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
discountLevel Denotes whether it is an item level discount or a check level
discount.
openDiscountValue Denotes the value of the discount in percentage or amount
basis. This varying percentage can be represented accurately
with 3 decimal places.
extraData A prompt to provide additional information for a chosen
discount.
DiscSource Indicates the source of the discount. For example, PMS
Discount, Auto Discount from Tender, and others)
promoCode The promo code associated with a discount.
IsPMSAccountDiscount ▪ True - The discount is a PMS account-based discount.
▪ False - The discount is not a PMS account-based discount.
PMSAccountDiscountMaxCap The maximum discount value to be considered for PMS
account-based discount.
serviceChargeValue A fixed charge paid to the service provider for availing their
service.
gratuityValue Indicates the gratuity value associated with the check.
tipValue Indicates the tip value associated with the check.
packages
packageId A unique value identifying the package.
quantity Denotes the quantity of packages added to the check.
SeatNumber Indicates the seat number for which the packages are
intended.
Items
SelectionGroupId A unique number that identifies a selection group.
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
Sequence The sequence of the items in the check.
Quantity Denotes the quantity of items listed in the check.
Modifiers Indicates the modifiers that are added to the check.
specialInstructions Denotes the special instruction added for items.
Price Denotes the price of the item.
IsPackagePmixFlag ▪ True - Indicates it is a package item.
▪ False - Indicates it is not a package item.
tenders
tenderId A unique and modifiable value in the enterprise level within a
range of [1-255] identifying a tender. Some of the PMS
interfaces will not permit users to use the check types whose

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 140
 IGPOS API | Reference Guide

Field Description
ID is greater than nine [9] when Tender ID number is higher
than ninety-nine [99].
tenderAmount The price/total amount to be tendered.
tipAmount Indicates the tip value associated with the check.

Sample Response
Refer to the Check Data Sample Response section for more information.

CalculateOrderwithErrors
This API is called to get check data that has errors. For example, when an item is 86’ed, this
API gives the response that the item is not available.
This is applicable only to InfoGenesis POS 12.1.4.
Method: POST
URL: https://<environment>/CalculateOrderwithErrors

Sample Request
{
"ScheduleTime": null,
"checkType": null,
"tableNumber": null,
"coverCount": 0,
"roomNumber": "string",
"gaPriceLevel": 0,
"scheduleTime": null,
"checkLabel": "string",
"dataTag": "string",
"dataTagType": 0,
"EmployeeId": "string",
"items": [
{
"quantity": 0,
"price": 0,
"openItemName": null,
"weight": 0,
"isPriceOverride": false,
"IsSoldByWeight": false,
"itemId": null,
"skuCode": null,
"modifiers": [
{
"id": 0,
"choiceGroupID": 0,
"discountExtraData": null,
"specialInstructions": null,
"modifiers": null,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 141
 IGPOS API | Reference Guide

"ChoiceGroupData": null,
"Quantity": 0
}
],
"specialInstructions": [
{
"id": 0,
"text": null
}
],
"discounts": [
{
"discountId": 0,
"discountLevel": 0,
"openDiscountValue": 0,
"extraData": null,
"DiscSource": 0,
"promoCode": null,
"IsPMSAccountDiscount": false,
"PMSAccountDiscountMaxCap": 0
}
]
}
],
"discounts": [
{
"discountId": 0,
"discountLevel": 0,
"openDiscountValue": 0,
"extraData": null,
"DiscSource": 0,
"promoCode": null,
"IsPMSAccountDiscount": false,
"PMSAccountDiscountMaxCap": 0
}
],
"serviceChargeValue": 0,
"gratuityValue": 0,
"tipValue": 0,
"packages": [
{
"packageId": null,
"quantity": 0,
"SeatNumber": null,
"Items": [
{
"SelectionGroupId": 0,
"ItemId": 0,
"Sequence": 0,
"Quantity": 0,
"Modifiers": null,
"specialInstructions": null,
"Price": 0,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 142
 IGPOS API | Reference Guide

"IsPackagePmixFlag": false
}
]
}
],
"tenders": [
{
"tenderId": null,
"tenderAmount": 0,
"tipAmount": 0
}
]
}

□ Refer to the following table for field descriptions:

Field Description
ScheduleTime The time at which the items in the check need to be served.
checkType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.
tableNumber A unique number labelled for a table.
coverCount Shows the number of covers per check.
roomNumber An alpha numeric value with 8 characters support denotes the
designated identity for the room.
gaPriceLevel The price associated with the GA account type.
scheduleTime The time at which the items in the check need to be served.
checkLabel Indicates the label assigned to the check.
dataTag The name of the guest whose account has been tagged to the
check
dataTagType The type of the account that the guest has used. The following
are the available account types:
▪ None = 0
▪ GA = 1
▪ InteractiveAccount = 2
▪ Loyalty = 3
▪ Member = 4
▪ Folio = 5
▪ Banquet = 6
▪ CampusCard = 7
EmployeeId A unique number [1 to 999,999,999] assigned for an employee.
items
quantity Denotes the quantity of items listed in the check.
price Denotes the price of the item.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 143
 IGPOS API | Reference Guide

Field Description
openItemName The name entered by the employee to an open item while
adding it to the check.
weight If the item is sold by its weight, this field denotes the weight of
the item listed in the check.
isPriceOverride ▪ True - Overrides the scanned price of a retail item.
▪ False - Does not override the scanned price of a retail
item.
IsSoldByWeight ▪ True - It activates the Tare Weight field as the item’s base
price is the price per unit of weight (Pound, Kilogram,
gram, etc.,)
▪ False - Denotes the item is not sold on a weight basis.
itemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
skuCode The alphanumeric code assigned to the item that can be swiftly
scanned by a barcode reader during the purchase.
modifiers
id Represents a unique identity value for the modifier.
choiceGroupID A unique numerical value within a range of [1-99999] to identify
a choice group.
discountExtraData A prompt to provide additional information for a chosen
discount. User can enter the text manually using the on-screen
keyboard or by using the card swipe.
specialInstructions Denotes the special instruction added for modifiers.
modifiers Array of modifiers to be added to an item.
ChoiceGroupData Data pertaining to the choice group that holds the modifier.
Quantity Denotes the quantity of modifiers added to the check.
specialInstructions
id A unique numerical value within a range of [1-9999] to identify
the special instruction.
text Represents the name of the special instruction with a maximum
of 20 characters.
discounts
discountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
discountLevel Denotes whether it is an item level discount or a check level
discount.
openDiscountValue Denotes the value of the discount in percentage or amount
basis. This varying percentage can be represented accurately
with 3 decimal places.
extraData A prompt to provide additional information for a chosen
discount.
DiscSource Indicates the source of the discount. For example, PMS
Discount, Auto Discount from Tender, and others)

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 144
 IGPOS API | Reference Guide

Field Description
promoCode The promo code associated with a Discount.
IsPMSAccountDiscount ▪ True - The discount is a PMS-based discount.
▪ False - The discount is not a PMS-based discount.
PMSAccountDiscountMaxCap The maximum cap to be considered for PMS account-based
discount.
discounts
discountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
discountLevel Denotes whether it is an item level discount or a check level
discount.
openDiscountValue Denotes the value of the discount in percentage or amount
basis. This varying percentage can be represented accurately
with 3 decimal places.
extraData A prompt to provide additional information for a chosen
discount.
DiscSource Indicates the source of the discount. For example, PMS
Discount, Auto Discount from Tender, and others)
promoCode The promo code associated with a Discount.
IsPMSAccountDiscount ▪ True - The discount is a PMS-based discount.
▪ False - The discount is not a PMS-based discount.
PMSAccountDiscountMaxCap The maximum cap to be considered for PMS account-based
discount.
serviceChargeValue A fixed charge paid to the service provider for availing their
service.
gratuityValue Indicates the gratuity value associated with the check.
tipValue Indicates the tip value associated with the check.
packages
packageId A unique value identifying the package.
quantity Denotes the quantity of packages added to the check.
SeatNumber Indicates the seat number for which the packages are
intended.
Items
SelectionGroupId A unique number that identifies a selection group.
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
Sequence The sequence of the items in the check.
Quantity Denotes the quantity of items listed in the check.
Modifiers Indicates the modifiers that are added to the check.
specialInstructions Denotes the special instruction added for items.
Price Denotes the price of the item.
IsPackagePmixFlag ▪ True - Indicates it is a package item.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 145
 IGPOS API | Reference Guide

Field Description
▪ False - Indicates it is not a package item.
tenders
tenderId A unique and modifiable value in the enterprise level within a
range of [1-255] identifying a tender. Some of the PMS
interfaces will not permit users to use the check types whose
ID is greater than nine [9] when Tender ID number is higher
than ninety-nine [99].
tenderAmount The price/total amount to be tendered.
tipAmount Indicates the tip value associated with the check.

Sample Response
Refer to the Check Data Sample Response section for more information.

ProcessOrder
ProcessOrder API is called to perform the following operations in one go:
▪ Create a check
▪ Add items
▪ Save the check with appropriate order details
This API sends the order details to the InfoGenesis database.
Method: POST
URL: https://<environment>/ProcessOrder

Sample Request
{
"ScheduleTime": null,
"checkType": null,
"tableNumber": null,
"coverCount": 0,
"roomNumber": "string",
"gaPriceLevel": 0,
"scheduleTime": null,
"checkLabel": "string",
"dataTag": "string",
"dataTagType": 0,
"EmployeeId": "string",
"items": [
{
"quantity": 0,
"price": 0,
"openItemName": null,
"weight": 0,
"isPriceOverride": false,
"IsSoldByWeight": false,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 146
 IGPOS API | Reference Guide

"itemId": null,
"skuCode": null,
"modifiers": [
{
"id": 0,
"choiceGroupID": 0,
"discountExtraData": null,
"specialInstructions": null,
"modifiers": null,
"ChoiceGroupData": null,
"Quantity": 0
}
],
"specialInstructions": [
{
"id": 0,
"text": null
}
],
"discounts": [
{
"discountId": 0,
"discountLevel": 0,
"openDiscountValue": 0,
"extraData": null,
"DiscSource": 0,
"promoCode": null,
"IsPMSAccountDiscount": false,
"PMSAccountDiscountMaxCap": 0
}
]
}
],
"discounts": [
{
"discountId": 0,
"discountLevel": 0,
"openDiscountValue": 0,
"extraData": null,
"DiscSource": 0,
"promoCode": null,
"IsPMSAccountDiscount": false,
"PMSAccountDiscountMaxCap": 0
}
],
"serviceChargeValue": 0,
"gratuityValue": 0,
"tipValue": 0,
"packages": [
{
"packageId": null,
"quantity": 0,
"SeatNumber": null,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 147
 IGPOS API | Reference Guide

"Items": [
{
"SelectionGroupId": 0,
"ItemId": 0,
"Sequence": 0,
"Quantity": 0,
"Modifiers": null,
"specialInstructions": null,
"Price": 0,
"IsPackagePmixFlag": false
}
]
}
]
}

□ Refer to the following table for field descriptions:

Field Description
ScheduleTime The time at which the items in the check need to be served.
checkType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.
tableNumber A unique number labelled for a table.
coverCount Shows the number of covers per check.
roomNumber An alpha numeric value with 8 characters support denotes the
designated identity for the room.
gaPriceLevel The price associated with the GA account type.
scheduleTime The time at which the items in the check need to be served.
checkLabel Indicates the label assigned to the check.
dataTag The name of the guest whose account has been tagged to the
check
dataTagType The type of the account that the guest has used. The following
are the available account types:
▪ None = 0
▪ GA = 1
▪ InteractiveAccount = 2
▪ Loyalty = 3
▪ Member = 4
▪ Folio = 5
▪ Banquet = 6
▪ CampusCard = 7
EmployeeId A unique number [1 to 999,999,999] assigned for an employee.
items
quantity Denotes the quantity of items listed in the check.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 148
 IGPOS API | Reference Guide

Field Description
price Denotes the price of the item.
openItemName The name entered by the employee to an open item while
adding it to the check.
weight If the item is sold by its weight, this field denotes the weight of
the item listed in the check.
isPriceOverride ▪ True - Overrides the scanned price of a retail item.
▪ False - Does not override the scanned price of a retail
item.
IsSoldByWeight ▪ True - It activates the Tare Weight field as the item’s base
price is the price per unit of weight (Pound, Kilogram,
gram, and others)
▪ False - Denotes the item is not sold on a weight basis.
itemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
skuCode The alphanumeric code assigned to the item that can be swiftly
scanned by a barcode reader during the purchase.
modifiers
id Represents a unique identity value for the modifier.
choiceGroupID A unique numerical value within a range of [1-99999] to identify
a choice group.
discountExtraData A prompt to provide additional information for a chosen
discount. User can enter the text manually using the on-screen
keyboard or by using the card swipe.
specialInstructions Denotes the special instruction added for modifiers.
modifiers Array of modifiers to be added to an item.
ChoiceGroupData Data pertaining to the choice group that holds the modifier.
Quantity Denotes the quantity of modifiers added to the check.
specialInstructions
id A unique numerical value within a range of [1-9999] to identify
the special instruction.
text Represents the name of the special instruction with a maximum
of 20 characters.
discounts
discountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
discountLevel Denotes whether it is an item level discount or a check level
discount.
openDiscountValue Denotes the value of the discount in percentage or amount
basis. This varying percentage can be represented accurately
with 3 decimal places.
extraData A prompt to provide additional information for a chosen
discount.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 149
 IGPOS API | Reference Guide

Field Description
DiscSource Indicates the source of the discount. For example, PMS
Discount, Auto Discount from Tender, and others)
promoCode The promo code associated with a Discount.
IsPMSAccountDiscount ▪ True - The discount is a PMS account-based discount.
▪ False - The discount is not a PMS account-based discount.
PMSAccountDiscountMaxCap The maximum discount value to be considered for PMS
account-based discount.
discounts
discountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
discountLevel Denotes whether it is an item level discount or a check level
discount.
openDiscountValue Denotes the value of the discount in percentage or amount
basis. This varying percentage can be represented accurately
with 3 decimal places.
extraData A prompt to provide additional information for a chosen
discount.
DiscSource Indicates the source of the discount. For example, PMS
Discount, Auto Discount from Tender, and others)
promoCode The promo code associated with a Discount.
IsPMSAccountDiscount ▪ True - The discount is a PMS-based discount.
▪ False - The discount is not a PMS-based discount.
PMSAccountDiscountMaxCap The maximum cap to be considered for PMS account-based
discount.
serviceChargeValue A fixed charge paid to the service provider for availing their
service.
gratuityValue Indicates the gratuity value associated with the check.
tipValue Indicates the tip value associated with the check.
packages
packageId A unique value identifying the package.
quantity Denotes the quantity of packages added to the check.
SeatNumber Indicates the seat number for which the packages are
intended.
Items
SelectionGroupId A unique number that identifies a selection group.
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
Sequence The sequence of the items in the check.
Quantity Denotes the quantity of items listed in the check.
Modifiers Indicates the modifiers that are added to the check.
specialInstructions Denotes the special instruction added for items.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 150
 IGPOS API | Reference Guide

Field Description
Price Denotes the price of the item.
IsPackagePmixFlag ▪ True - Indicates it is a package item.
▪ False - Indicates it is not a package item.

Sample Response
Refer to the Check Data Sample Response section for more information.

SaveCheck
SaveCheck API is used to save a check and send the check information to the InfoGenesis
database. This API is called when an open check must be saved.
Method: POST
URL: https://<environment>/SaveCheck

Sample Request
{
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response:
"Success"

VoidCheck
This API is used to void a check. When this API is called, the check is entirely removed.
Method: POST
URL: https://<environment>/VoidCheck

Sample Request
{
"VoidReason": 0,
"checkNumber": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 151
 IGPOS API | Reference Guide

"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
VoidReason A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

AppendCheck
This API is used to add new items or apply discounts to the saved check. When this API is
called, it recalls the saved check, appends the latest information sent in the request, and saves
the check.
Method: POST
URL: https://<environment>/AppendCheck

Sample Request
{
"checkNumber": null,
"guid": null,
"items": [
{
"quantity": 0,
"price": 0,
"openItemName": null,
"weight": 0,
"isPriceOverride": false,
"IsSoldByWeight": false,
"itemId": null,
"skuCode": null,
"modifiers": [
{
"id": 0,
"choiceGroupID": 0,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 152
 IGPOS API | Reference Guide

"discountExtraData": null,
"specialInstructions": null,
"modifiers": null,
"ChoiceGroupData": null,
"Quantity": 0
}
],
"specialInstructions": [
{
"id": 0,
"text": null
}
],
"discounts": [
{
"discountId": 0,
"discountLevel": 0,
"openDiscountValue": 0,
"extraData": null,
"DiscSource": 0,
"promoCode": null,
"IsPMSAccountDiscount": false,
"PMSAccountDiscountMaxCap": 0
}
]
}
],
"discounts": [
{
"discountId": 0,
"discountLevel": 0,
"openDiscountValue": 0,
"extraData": null,
"DiscSource": 0,
"promoCode": null,
"IsPMSAccountDiscount": false,
"PMSAccountDiscountMaxCap": 0
}
],
"serviceChargeValue": 0,
"gratuityValue": 0,
"tipValue": 0,
"packages": [
{
"packageId": null,
"quantity": 0,
"SeatNumber": null,
"Items": [
{
"SelectionGroupId": 0,
"ItemId": 0,
"Sequence": 0,
"Quantity": 0,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 153
 IGPOS API | Reference Guide

"Modifiers": null,
"specialInstructions": null,
"Price": 0,
"IsPackagePmixFlag": false
}
]
}
]
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
items
quantity Denotes the quantity of items listed in the check.
price Denotes the price of the item.
openItemName The name entered by the employee to an open item while
adding it to the check.
weight If the item is sold by its weight, this field denotes the weight of
the item listed in the check.
isPriceOverride ▪ True - Overrides the scanned price of a retail item.
▪ False - Does not override the scanned price of a retail
item.
IsSoldByWeight ▪ True - It activates the Tare Weight field as the item’s base
price is the price per unit of weight (Pound, Kilogram,
gram, and others.)
▪ False - Denotes the item is not sold on a weight basis.
itemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
skuCode The alphanumeric code assigned to the item that can be swiftly
scanned by a barcode reader during the purchase.
modifiers
id Represents a unique identity value for the modifier.
choiceGroupID A unique numerical value within a range of [1-99999] to identify
a choice group.
discountExtraData A prompt to provide additional information for a chosen
discount. User can enter the text manually using the on-screen
keyboard or by using the card swipe.
specialInstructions Denotes the special instruction added for modifiers.
modifiers Array of modifiers to be added to an item.
ChoiceGroupData Data pertaining to the choice group that holds the modifier.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 154
 IGPOS API | Reference Guide

Field Description
Quantity Denotes the quantity of modifiers added to the check.
specialInstructions
id A unique numerical value within a range of [1-9999] to identify
the special instruction.
text Represents the name of the special instruction with a maximum
of 20 characters.
discounts
discountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
discountLevel Denotes whether it is an item level discount or a check level
discount.
openDiscountValue Denotes the value of the discount in percentage or amount
basis. This varying percentage can be represented accurately
with 3 decimal places.
extraData A prompt to provide additional information for a chosen
discount.
DiscSource Indicates the source of the discount. For example, PMS
Discount, Auto Discount from Tender, and others)
promoCode The promo code associated with a Discount.
IsPMSAccountDiscount ▪ True - The discount is a PMS account-based discount.
▪ False - The discount is not a PMS account-based discount.
PMSAccountDiscountMaxCap The maximum discount value to be considered for PMS
account-based discount.
discounts
discountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
discountLevel Denotes whether it is an item level discount or a check level
discount.
openDiscountValue Denotes the value of the discount in percentage or amount
basis. This varying percentage can be represented accurately
with 3 decimal places.
extraData A prompt to provide additional information for a chosen
discount.
DiscSource Indicates the source of the discount. For example, PMS
Discount, Auto Discount from Tender, and others)
promoCode The promo code associated with a Discount.
IsPMSAccountDiscount ▪ True - The discount is a PMS account-based discount.
▪ False - The discount is not a PMS account-based discount.
PMSAccountDiscountMaxCap The maximum discount value to be considered for PMS
account-based discount.
serviceChargeValue A fixed charge paid to the service provider for availing their
service.
gratuityValue Indicates the gratuity value associated with the check.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 155
 IGPOS API | Reference Guide

Field Description
tipValue Indicates the tip value associated with the check.
packages
packageId A unique value identifying the package.
quantity Denotes the quantity of packages added to the check.
SeatNumber Indicates the seat number for which the packages are
intended.
Items
SelectionGroupId A unique number that identifies a selection group.
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
Sequence The sequence of the items in the check.
Quantity Denotes the quantity of items listed in the check.
Modifiers Indicates the modifiers that are added to the check.
specialInstructions Denotes the special instruction added for items.
Price Denotes the price of the item.
IsPackagePmixFlag ▪ True - Indicates it is a package item.
▪ False - Indicates it is not a package item.

Sample Response
Refer to the Check Data Sample Response section for more information.

AppendOpenCheck
This API is used to add items to an open check. It is called only when items must be added to
an open check. The latest information sent in the request gets appended to the appropriate
open check.
Method: POST
URL: https://<environment>/AppendOpenCheck

Sample Request
{
"checkNumber": null,
"guid": null,
"items": [
{
"quantity": 0,
"price": 0.0,
"openItemName": null,
"weight": 0.0,
"isPriceOverride": false,
"IsSoldByWeight": false,
"itemId": null,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 156
 IGPOS API | Reference Guide

"skuCode": null,
"modifiers": [
{
"id": 0,
"choiceGroupID": 0,
"discountExtraData": null,
"specialInstructions": null,
"modifiers": null,
"ChoiceGroupData": null,
"Quantity": 0
}
],
"specialInstructions": [
{
"id": 0,
"text": null
}
],
"discounts": [
{
"discountId": 0,
"discountLevel": 0,
"openDiscountValue": 0.0,
"extraData": null,
"DiscSource": 0,
"promoCode": null,
"IsPMSAccountDiscount": false,
"PMSAccountDiscountMaxCap": 0.0
}
]
}
],
"discounts": [
{
"discountId": 0,
"discountLevel": 0,
"openDiscountValue": 0.0,
"extraData": null,
"DiscSource": 0,
"promoCode": null,
"IsPMSAccountDiscount": false,
"PMSAccountDiscountMaxCap": 0.0
}
],
"serviceChargeValue": 0.0,
"gratuityValue": 0.0,
"tipValue": 0.0,
"packages": [
{
"packageId": null,
"quantity": 0,
"SeatNumber": null,
"Items": [

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 157
 IGPOS API | Reference Guide

{
"SelectionGroupId": 0,
"ItemId": 0,
"Sequence": 0,
"Quantity": 0,
"Modifiers": null,
"specialInstructions": null,
"Price": 0,
"IsPackagePmixFlag": false
}
]
}
]
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
items
quantity Denotes the quantity of items listed in the check.
price Denotes the price of the item.
openItemName The name entered by the employee to an open item while
adding it to the check.
weight If the item is sold by its weight, this field denotes the weight of
the item listed in the check.
isPriceOverride ▪ True - Overrides the scanned price of a retail item.
▪ False - Does not override the scanned price of a retail
item.
IsSoldByWeight ▪ True - It activates the Tare Weight field as the item’s base
price is the price per unit of weight (Pound, Kilogram,
gram, and others.)
▪ False - Denotes the item is not sold on a weight basis.
itemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
skuCode The alphanumeric code assigned to the item that can be swiftly
scanned by a barcode reader during the purchase.
modifiers
id Represents a unique identity value for the modifier.
choiceGroupID A unique numerical value within a range of [1-99999] to identify
a choice group.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 158
 IGPOS API | Reference Guide

Field Description
discountExtraData A prompt to provide additional information for a chosen
discount. User can enter the text manually using the on-screen
keyboard or by using the card swipe.
specialInstructions Denotes the special instruction added for modifiers.
modifiers Array of modifiers to be added to an item.
ChoiceGroupData Data pertaining to the choice group that holds the modifier.
Quantity Denotes the quantity of modifiers added to the check.
specialInstructions
id A unique numerical value within a range of [1-9999] to identify
the special instruction.
text Represents the name of the special instruction with a maximum
of 20 characters.
discounts
discountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
discountLevel Denotes whether it is an item level discount or a check level
discount.
openDiscountValue Denotes the value of the discount in percentage or amount
basis. This varying percentage can be represented accurately
with 3 decimal places.
extraData A prompt to provide additional information for a chosen
discount.
DiscSource Indicates the source of the discount. For example, PMS
Discount, Auto Discount from Tender, and others)
promoCode The promo code associated with a Discount.
IsPMSAccountDiscount ▪ True - The discount is a PMS-based discount.
▪ False - The discount is not a PMS-based discount.
PMSAccountDiscountMaxCap The maximum cap to be considered for PMS account-based
discount.
discounts
discountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
discountLevel Denotes whether it is an item level discount or a check level
discount.
openDiscountValue Denotes the value of the discount in percentage or amount
basis. This varying percentage can be represented accurately
with 3 decimal places.
extraData A prompt to provide additional information for a chosen
discount.
DiscSource Indicates the source of the discount. For example, PMS
Discount, Auto Discount from Tender, and others)
promoCode The promo code associated with a Discount.
IsPMSAccountDiscount ▪ True - The discount is a PMS-based discount.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 159
 IGPOS API | Reference Guide

Field Description
▪ False - The discount is not a PMS-based discount.
PMSAccountDiscountMaxCap The maximum cap to be considered for PMS account-based
discount.
serviceChargeValue A fixed charge paid to the service provider for availing their
service.
gratuityValue Indicates the gratuity value associated with the check.
tipValue Indicates the tip value associated with the check.
packages
packageId A unique value identifying the package.
quantity Denotes the quantity of packages added to the check.
SeatNumber Indicates the seat number for which the packages are
intended.
Items
SelectionGroupId A unique number that identifies a selection group.
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
Sequence The sequence of the items in the check.
Quantity Denotes the quantity of items listed in the check.
Modifiers Indicates the modifiers that are added to the check.
specialInstructions Denotes the special instruction added for items.
Price Denotes the price of the item.
IsPackagePmixFlag ▪ True - Indicates it is a package item.
▪ False - Indicates it is not a package item.

Sample Response
Refer to the Check Data Sample Response section for more information.

GetFinancialBins
API to get FinancialBins for a check.
Method: POST
URL: https://<environment>/GetFinancialBins

Sample Request
{
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 160
 IGPOS API | Reference Guide

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
[
{
"Type": "string",
"Id": 0,
"Amount": 0,
"Quantity": 0
}
]

□ Refer to the following table for field descriptions:

Field Description
Type Indicates the type of Financial Bin:
▪ Revenue: 1
▪ Discount: 2
▪ Tax: 3
▪ Gratuity: 4
▪ Service Charge: 5
▪ Tip: 6
▪ Round: 7
▪ Part Bins: 8
▪ Inclusive Tax: 9
▪ Exclusive Tax: 10
▪ Grat Tax: 11
▪ Service Charge Tax: 12
Id A unique value identifying the financial class.
Amount Denotes the monetary amount for the financial bin.
Quantity The quantity of Financial Bin of the same type that has been
applied.

RecallCheck
RecallCheck API is used to recall a saved check.
Method: POST
URL: https://<environment>/RecallCheck

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 161
 IGPOS API | Reference Guide

Sample Request
{
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

TryPayCheck
TryPayCheck API is used to get the final amount that must be paid by the guest for all internal
tenders. Internal tenders include the following: Loyalty, RTP, Room Charge, Member Charge,
and GA. This API must be called after invoking GetHandles.
Method: POST
URL: https://<environment>/TryPayCheck

Sample Request
{
"handle": "string",
"checkNumber": "string",
"guid": "string",
"tenderAmount": 0,
"tenderIndex": "string"
}

□ Refer to the following table for field descriptions:

Field Description
handle Check Handle returned as part of the GetHandles call.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 162
 IGPOS API | Reference Guide

Field Description
tenderamount The total amount to be tendered.
tenderIndex The index of the tender applied to the check.

Sample Response
Refer to the Check Data Sample Response section for more information.

ExternalTryPayCheck
This API is used to get the final amount that must be paid by the guest for all external tenders,
such as credit card tender.
Method: POST
URL: https://<environment>/ExternalTryPayCheck

Sample Request
{
"tenderId": "string",
"tenderAmount": 0,
"checkNumber": "string",
"guid": "string",
"authIndex": "string"
}

□ Refer to the following table for the field descriptions:

Field Description
tenderId A unique and modifiable value in the enterprise level that lies within a
range of [1-255]. Some of the PMS interfaces will not permit users to
use the check types whose ID is greater than nine [9] when Tender
ID number is higher than ninety-nine [99].
tenderAmount The total amount to be tendered.
checkNumber A numerical value that gives unique identification to every check
generated in the POS terminal. This value is an amalgamation of
terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it is
given a GUID which is used in all the subsequent check operations
as its identifier.
authIndex The index of the authorization to be added to the check.

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 163
 IGPOS API | Reference Guide

ExternalAuth
ExternalAuth API is called to add authorization of credit card to an open check.
Method: POST
URL: https://<environment>/ExternalAuth

Sample Request
{
"checkNumber": "string",
"guid": "string",
"tenderId": "string",
"transactionId": "string",
"transactionStatus": "string",
"transactionTime": "2023-12-05T11:24:33.547Z",
"signatureCapture": "string",
"pinVerified": true,
"amount": {
"requestAmount": 0,
"authorisedAmount": 0,
"tipAmount": 0,
"changeAmount": 0,
"breakageAmount": 0,
"SaleAmount": 0,
"chargedAmount": 0,
"balance_amt": 0
},
"clientInfo": {
"token": "string",
"tokenExpiryDate": "string",
"transactionFollowOnData": "string",
"accountName": "string",
"accountNumber": "string",
"authCode": "string",
"referenceID": "string",
"roomNumber": "string",
"sequenceId": "string",
"balance": 0,
"pointsBalance": 0,
"type": "string"
},
"emvInfo": {
"mode": "string",
"authMode": "string",
"applicationIndentifier": "string",
"applicationLabel": "string",
"issuerApplicationData": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"cryptogram": "string",
"isFallBack": true

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 164
 IGPOS API | Reference Guide

},
"cardInfo": {
"entryMode": "string",
"issuer": "string",
"cardExpiration": "string",
"cardType": "string",
"cardData": "string"
},
"recieptData": {
"merchantCopy": [
"string"
],
"customerCopy": [
"string"
]
},
"financialBins": [
{
"type": 0,
"id": 0,
"amount": 0,
"quantity": 0
}
],
"transactionInfo": {
"AccountNumber": "string",
"AuthorizationTime": "2023-12-05T11:24:33.547Z",
"SecurityToken": "string",
"AuthCode": "string",
"AccountName": "string",
"AccountType": "string",
"FollowOnData": "string",
"ReferenceId": "string",
"InvoiceId": "string",
"AuthAccount": "string",
"PostAccount": "string",
"isCreditTender": true,
"hostCaptureFlag": true,
"VoucherInfo": [
{
"compId": 0,
"voucherType": "string",
"description": "string",
"expirationDate": "2023-12-05T11:24:33.547Z",
"quantity": 0,
"balanceAmount": 0,
"redeemedAmount": 0,
"voucherId": "string"
}
],
"PointsInfo": [
{
"pointsType": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 165
 IGPOS API | Reference Guide

"availablePoints": 0,
"availableAmount": 0,
"redeemedPoints": 0,
"redeemedAmount": 0,
"currencyAmountRedemptionLimit": 0
}
]
}
}

□ Refer to the following table for the field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
tenderId A unique and modifiable value in the enterprise level within a
range of [1-255] identifying a tender. Some of the PMS
interfaces will not permit users to use the check types whose
ID is greater than nine [9] when Tender ID number is higher
than ninety-nine [99].
transactionId A unique value that identifies the transaction. This identification
number helps in checking the status and other required
information related to the transaction.
transactionStatus Indicates the status of the transaction - Eg: Completed
transaction or failed transaction.
transactionTime Indicates the time at which the transaction has been
processed.
signatureCapture Customer’s signature can be recorded by connecting a
signature capture device with the POS terminal. Whenever the
customer’s card is swiped, the signature can be recorded by
configuring this feature.
pinVerified ▪ True - Indicates the successful verification of the pin.
▪ False - Indicates pin verification is failed.
amount
requestAmount The requested authorization amount.
authorisedAmount The amount authorized by the gateway.
tipAmount The tip amount in the check.
changeAmount The amount that is to be returned to guest after the sale.
breakageAmount The balance from an over tender which is not returned to the
guest or used as a tip.
Example: If a $10 voucher is used for $6 check, the $4 is
considered as the breakage amount.
SaleAmount The amount for which the sale is made.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 166
 IGPOS API | Reference Guide

Field Description
chargedAmount The request amount or sale amount that must be tendered.
balance_amt The balance amount in the check.
clientInfo
token The client token to authenticate the request.
tokenExpiryDate The expiry date of the token.
transactionFollowOnData The data that is received from the third-party is used to perform
actions, such as void tenders or sale reversal transactions.
accountName Indicates the client’s account name.
accountNumber Indicates the client’s account number.
authCode This is an authentication code for the store to which the
terminal belongs.
referenceID A unique value to identify the external auth transaction.
roomNumber An alpha numeric value with 8 characters support denotes the
designated identity for the room.
sequenceId For internal purpose.
balance The balance amount in the card during authorization.
pointsBalance The reward points balance available in the card.
type Indicates the account type.
emvInfo
mode Refers to one of the following modes:
▪ Chip
▪ Swipe
▪ Contactless
▪ Key
authMode Indicates the mode used to authorize the transaction.
applicationIndentifier The application identifier number.
applicationLabel It is a response from the third-party. Mnemonic associated with
the AID according to ISO/IEC 7816-5 - EMV Tag 50
issuerApplicationData A third-party response containing proprietary application data
for transmission to the issuer in an online transaction - EMV
Tag 9F10.
terminalVerificationResults A third-party response indicating the status of the multiple
functions/tests as seen from the terminal. These indicators
from the terminal influences the decision of offline and online
processing for an EMV transaction - EMV Tag 95.
transactionStatusInformation Indicates the functions performed in a transaction - EMV Tag
9B.
authorizationResponseCode A sting consisting of the response code returned from the EMV
transaction.
cryptogram The cryptogram that is returned by the ICC in response to the
Generate AC command. This is used to verify the request
invoked from the card - EMV Tag 9F26.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 167
 IGPOS API | Reference Guide

Field Description
isFallBack ▪ True - Guests are allowed to change the payment method
when swiping or taping the card has failed.
▪ False - Guests are not allowed to change the payment
method.
cardInfo
entryMode Mode of entry for the card details. Specifies if it is manual or
swipe.
issuer The card issuer name.
cardExpiration Indicates the validity of the card.
cardType Indicates the type of the card.
cardData Additional information provided for the appropriate card.
recieptData
merchantCopy A copy printed from the terminal containing the sales draft text
for merchants.
customerCopy A copy printed from the terminal containing the sales draft text
for customers.
financialBins
type Indicates the type of Financial Bin:
▪ Revenue: 1
▪ Discount: 2
▪ Tax: 3
▪ Gratuity: 4
▪ Service Charge: 5
▪ Tip: 6
▪ Round: 7
▪ Part Bins: 8
▪ Inclusive Tax: 9
▪ Exclusive Tax: 10
▪ Grat Tax: 11
▪ Service Charge Tax: 12
id A unique value identifying the financial class.
amount Denotes the monetary amount for the financial bin.
quantity The quantity of Financial Bin of the same type that has been
applied.
transactionInfo
AccountNumber The account number that is used to authorize the account.
AuthorizationTime The time when the authorization was made.
SecurityToken The token that is returned during the auth transactions.
AuthCode This is an authentication code for the store to which the
terminal belongs.
AccountName The name of the account holder.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 168
 IGPOS API | Reference Guide

Field Description
AccountType The type of account.
FollowOnData The data that is received from the third-party is used to perform
actions, such as void tenders or sale reversal transactions.
ReferenceId A unique value to identify the external auth transaction.
InvoiceId A unique value identifying the invoice. It is similar to the Check
ID.
AuthAccount The account to which the authorization is made.
PostAccount The account to which the tender details shall be posted after
the transaction.
isCreditTender ▪ True - Indicates the tender is a credit.
▪ False - Indicates the tender is not a credit.
hostCaptureFlag For internal purpose.
VoucherInfo
compId Indicates the ID of the comps to be applied.
voucherType The type of voucher that is being applied.
description The description of the voucher.
expirationDate The expiry date of the voucher.
quantity The number of vouchers being applied.
balanceAmount The amount balance due in the check.
redeemedAmount The amount that has been redeemed via vouchers.
voucherId The voucher ID that is being redeemed.
PointsInfo
pointsType The type of points, such as Patron, Comp, and others.
availablePoints The available point balance for the guest.
availableAmount The available balance in the amount.
redeemedPoints The points redeemed in this tender.
redeemedAmount The amount redeemed in this tender.
currencyAmountRedemptionLi The limit up to which points can be redeemed, expressed in
mit currency amount.

Sample Response
Refer to the Check Data Sample Response section for more information.

ExternalAccept
This API is called to accept the authorization made for the credit card in an open check.
Method: POST
URL: https://<environment>/ExternalAccept

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 169
 IGPOS API | Reference Guide

Sample Request
{
"tenderToken": 0,
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for the field descriptions:

Field Description
tenderToken The encrypted details of the inquiry that was previously made.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

ExternalTenderCheck
This API is called to add credit card payment information to an open check.
Method: POST
URL: https://<environment>/ExternalTenderCheck

Sample Request
{
"TenderToken": "string",
"transactionId": "string",
"transactionStatus": "string",
"transactionTime": "2023-11-23T10:17:00.706Z",
"signatureCapture": "string",
"handle": "string",
"pinVerified": true,
"closeOrder": true,
"amount": {
"requestAmount": 0,
"authorisedAmount": 0,
"tipAmount": 0,
"changeAmount": 0,
"breakageAmount": 0,
"SaleAmount": 0,
"chargedAmount": 0,
"balance_amt": 0
},

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 170
 IGPOS API | Reference Guide

"clientInfo": {
"token": "string",
"tokenExpiryDate": "string",
"transactionFollowOnData": "string",
"accountName": "string",
"accountNumber": "string",
"authCode": "string",
"referenceID": "string",
"roomNumber": "string",
"sequenceId": "string",
"balance": 0,
"pointsBalance": 0,
"type": "string"
},
"emvInfo": {
"mode": "string",
"authMode": "string",
"applicationIndentifier": "string",
"applicationLabel": "string",
"issuerApplicationData": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"cryptogram": "string",
"isFallBack": true
},
"cardInfo": {
"entryMode": "string",
"issuer": "string",
"cardExpiration": "string",
"cardType": "string",
"cardData": "string"
},
"recieptData": {
"merchantCopy": [
"string"
],
"customerCopy": [
"string"
]
},
"financialBins": [
{
"type": 0,
"id": 0,
"amount": 0,
"quantity": 0
}
],
"transactionInfo": {
"AccountNumber": "string",
"AuthorizationTime": "2023-11-23T10:17:00.706Z",
"SecurityToken": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 171
 IGPOS API | Reference Guide

"AuthCode": "string",
"AccountName": "string",
"AccountType": "string",
"FollowOnData": "string",
"ReferenceId": "string",
"InvoiceId": "string",
"AuthAccount": "string",
"PostAccount": "string",
"isCreditTender": true,
"hostCaptureFlag": true,
"VoucherInfo": [
{
"compId": 0,
"voucherType": "string",
"description": "string",
"expirationDate": "2023-11-23T10:17:00.706Z",
"quantity": 0,
"balanceAmount": 0,
"redeemedAmount": 0,
"voucherId": "string"
}
],
"PointsInfo": [
{
"pointsType": "string",
"availablePoints": 0,
"availableAmount": 0,
"redeemedPoints": 0,
"redeemedAmount": 0,
"currencyAmountRedemptionLimit": 0
}
]
}
}

□ Refer to the following table for the field descriptions:

Field Description
TenderToken The encrypted details of the inquiry that was previously
made.
transactionId A unique value that identifies the transaction. This
identification number helps in checking the status and other
required information related to the transaction.
transactionStatus Indicates the status of the transaction - Eg: Completed
transaction or failed transaction.
transactionTime Indicates the time at which the transaction has been
processed.
signatureCapture Customer’s signature can be recorded by connecting a
signature capture device with the POS terminal. Whenever
the customer’s card is swiped, the signature can be recorded
by configuring this feature.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 172
 IGPOS API | Reference Guide

Field Description
handle When a given input is validated/authorized succesfully by the
integrated payment service provider, a unique handle is
returned for that tender. This is then used to complete the
payment.
pinVerified ▪ True - Indicates the successful verification of the pin.
▪ False - Indicates pin verification is failed.
closeOrder ▪ True - The sale is completed, and the order is closed.
▪ False - The sale is not completed, and the order is not
closed.
amount
requestAmount The requested authorization amount.
authorisedAmount The amount authorized by the gateway.
tipAmount The tip amount in the check.
changeAmount The amount that is to be returned to guest after the sale.
breakageAmount The balance from an over tender which is not returned to the
guest or used as a tip.
Example: If a $10 voucher is used for $6 check, the $4 is
considered as the breakage amount.
SaleAmount The amount for which the sale is made.
chargedAmount The request amount or sale amount that must be tendered.
balance_amt The balance amount in the check.
clientInfo
token The client token to authenticate the request.
tokenExpiryDate The expiry date of the token.
transactionFollowOnData The data that is received from the third-party is used to
perform actions, such as void tenders or sale reversal
transactions.
accountName Indicates the client’s account name.
accountNumber Indicates the client’s account number.
authCode This is an authentication code for the store to which the
terminal belongs.
referenceID A unique value to identify the external tender transaction.
roomNumber An alpha numeric value with 8 characters support denotes
the designated identity for the room.
sequenceId For internal purpose.
balance The balance amount in the card during authorization.
pointsBalance The reward points balance available in the card.
type Indicates the account type.
emvInfo
mode Refers to one of the following modes:
▪ Chip

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 173
 IGPOS API | Reference Guide

Field Description
▪ Swipe
▪ Contactless
▪ Key
authMode Indicates the mode used to authorize the transaction.
applicationIndentifier The application identifier number.
applicationLabel It is a response from the third-party. Mnemonic associated
with the AID according to ISO/IEC 7816-5 - EMV Tag 50
issuerApplicationData A third-party response containing proprietary application data
for transmission to the issuer in an online transaction - EMV
Tag 9F10.
terminalVerificationResults A third-party response indicating the status of the multiple
functions/tests as seen from the terminal. These indicators
from the terminal influences the decision of offline and online
processing for an EMV transaction - EMV Tag 95.
transactionStatusInformation Indicates the functions performed in a transaction - EMV Tag
9B.
authorizationResponseCode A sting consisting of the response code returned from the
EMV transaction.
cryptogram The cryptogram that is returned by the ICC in response to the
Generate AC command. This is used to verify the request
invoked from the card - EMV Tag 9F26.
isFallBack ▪ True - Guests are allowed to change the payment
method when swiping or taping the card has failed.
▪ False - Guests are not allowed to change the payment
method.
cardInfo
entryMode Mode of entry for the gift card details. Specifies if it is manual
or swipe.
issuer The card issuer name.
cardExpiration The validity of the card.
cardType Indicates the type of cards.
cardData Additional information provided for the appropriate card.
recieptData
merchantCopy A copy printed from the terminal containing the sales draft
text for merchants.
customerCopy A copy printed from the terminal containing the sales draft
text for customers.
financialBins
type Indicates the type of Financial Bin:
▪ Revenue: 1
▪ Discount: 2
▪ Tax: 3
▪ Gratuity: 4

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 174
 IGPOS API | Reference Guide

Field Description
▪ Service Charge: 5
▪ Tip: 6
▪ Round: 7
▪ Part Bins: 8
▪ Inclusive Tax: 9
▪ Exclusive Tax: 10
▪ Grat Tax: 11
▪ Service Charge Tax: 12
id A unique value identifying the financial class.
amount Denotes the monetary amount for the financial bin.
quantity The quantity of Financial Bin of the same type that has been
applied.
transactionInfo
AccountNumber The account number that is used to authorize the account.
AuthorizationTime The time when the authorization was added to the check.
SecurityToken The token that is returned during the auth transactions.
AuthCode This is an authentication code for the store to which the
terminal belongs.
AccountName The account holder name.
AccountType The account type.
FollowOnData The data that is received from the third-party is used to
perform actions, such as void tenders or sale reversal
transactions.
ReferenceId A unique value to identify the external tender transaction.
InvoiceId A unique value identifying the invoice. It is similar to the
Check ID.
AuthAccount The GA account to which the authorization is made.
PostAccount The GA account to which the tender details shall be posted
after the transaction.
isCreditTender ▪ True - Indicates the tender is a credit.
▪ False - Indicates the tender is not a credit.
hostCaptureFlag For internal purpose.
VoucherInfo
compId Indicates the ID of the comps to be applied.
voucherType The type of voucher that is being applied.
description The description of the voucher.
expirationDate The expiry date of the voucher.
quantity The number of vouchers being applied.
balanceAmount The amount balance due in the check.
redeemedAmount The amount that has been redeemed via vouchers.
voucherId The voucher ID that is being redeemed.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 175
 IGPOS API | Reference Guide

Field Description
PointsInfo
pointsType The type of points, such as Patron, Comp, and others.
availablePoints The available point balance for the guest.
availableAmount The available balance in the amount.
redeemedPoints The points redeemed in this tender.
redeemedAmount The amount redeemed in this tender.
currencyAmountRedemptionLimit The limit up to which points can be redeemed, expressed in
currency amount.

Sample Response
Refer to the Check Data Sample Response section for more information.

CreateScheduleOrderCheck
This API is called to create an empty check with the scheduled date and time sent in the
request. InfoGenesis POS 4.5.x supports a maximum of 1 day, and InfoGenesis POS 12.x
supports a maximum of 365 days for scheduled orders.
Method: POST
URL: https://<environment>/CreateScheduleOrderCheck

Sample Request
{
"checkType": 1,
"scheduleTime": "2023-03-11 15:58:00",
"tableNumber": "",
"coverCount": 0,
"checkLabel": "sample check",
"roomNumber": "",
"dataTag": "",
"dataTagType": 0,
"taggedAccountId": "",
"gaPriceLevel": 0
}

□ Refer to the following table for the field descriptions:

Field Description
checkType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.
scheduleTime The time at which the items in the check need to be served.
tableNumber A unique number labelled for a table.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 176
 IGPOS API | Reference Guide

Field Description
coverCount Shows the number of covers per check.
checkLabel Denotes the label assigned to the check.
roomNumber An alpha numeric value with 8 characters support denotes the
designated identity for the room.
dataTag The name of the guest whose account has been tagged to the
check
dataTagType The type of the account that the guest has used. The following
are the available account types:
▪ None = 0
▪ GA = 1
▪ InteractiveAccount = 2
▪ Loyalty = 3
▪ Member = 4
▪ Folio = 5
▪ Banquet = 6
▪ CampusCard = 7
taggedAccountId The account ID of the guest that has been tagged to the check.
gaPriceLevel The price associated with the GA account type.

Sample Response
Refer to the Check Data Sample Response section for more information.

SetSchedule
SetSchedule API is used to set a schedule for an open check. When this API is called, the
scheduled date and time sent in the request are added to the open check. InfoGenesis POS
4.5.x supports a maximum of 1 day, and InfoGenesis POS 12.x supports a maximum of 365
days for scheduled orders.
Method: POST
URL: https://<environment>/SetSchedule

Sample Request
{
"checkNumber": "",
"guid": "",
"scheduleTime": "2023-07-01 01:38:00",
"isSchedule": true
}

□ Refer to the following table for the field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 177
 IGPOS API | Reference Guide

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
scheduleTime The time at which the items in the check need to be served.
isSchedule ▪ True - The check is a scheduled check.
▪ False - The check is not a scheduled check.

Sample Response
Refer to the Check Data Sample Response section for more information.

VoidTender
VoidTender API is used to void partial tenders applied to the check. This API is supported only
for proxy payments and the settlements take place according to the void transactions.
Method: POST
URL: https://<environment>/VoidTender

Sample Request
{
"checkNumber": "string",
"guid": "string",
"Index": 0
}

□ Refer to the following table for the field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
Index The index of tenders applied to the check.

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 178
 IGPOS API | Reference Guide

RemoveTender
This API is called to remove the tender applied to the check. This API is supported only for non-
proxy payments, such as Cash, GA, and Coupon, for which the settlement is not required.
Method: POST
URL: https://<environment>/RemoveTender

Sample Request
{
"checkNumber": "string",
"guid": "string",
"Index": 0
}

□ Refer to the following table for the field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
Index The index of tenders applied to the check.

Sample Response
Refer to the Check Data Sample Response section for more information.

AddPackage
This API is called to add a package item to an open check.
Method: POST
URL: https://<environment>/AddPackage

Sample Request
{
"packageId": "string",
"checkNumber": "string",
"guid": "string",
"quantity": 0,
"seatNumber": "string",
"items": [
{
"itemId": 0,
"sequence": 0,
"quantity": 0,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 179
 IGPOS API | Reference Guide

"selectionGroupId": 0,
"modifiers": [
{
"id": 0,
"choiceGroupID": 0,
"modifiers": [
{
"id": 0,
"choiceGroupID": 0
}
]
}
]
}
]
}

□ Refer to the following table for the field descriptions:

Field Description
packageId A unique value identifying the package.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
quantity Denotes the quantity of the package in the check.
seatNumber Indicates the seat number for which the items are intended.
items
itemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
sequence The sequence of items in the check.
quantity Denotes the quantity of items listed in the check.
selectionGroupId A unique number that identifies a selection group.
modifiers
id Represents a unique numeric value for the modifier.
choiceGroupID A unique numerical value within a range of [1-99999] to identify
a choice group.
modifiers
id Represents a unique numeric value for the modifier.
choiceGroupID A unique numerical value within a range of [1-99999] to identify
a choice group.

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 180
 IGPOS API | Reference Guide

SetCoverCount
This API is called to set the cover count in an open check.
Method: POST
URL: https://<environment>/SetCoverCount

Sample Request
{
"checkNumber": "string",
"guid": "string",
"coverCount": 0
}

□ Refer to the following table for the field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
coverCount Indicates the total number of covers in a meal period.

Sample Response
Refer to the Check Data Sample Response section for more information.

ModifyGratuity
ModifyGratuity API is called to modify the existing gratuity value in an open check.
Method: POST
URL: https://<environment>/ModifyGratuity

Sample Request
{
"checkNumber": "string",
"guid": "string",
"gratuityValue": 0
}

□ Refer to the following table for the field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 181
 IGPOS API | Reference Guide

Field Description
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
gratuityValue Displays the gratuity value associated with the check.

Sample Response
Refer to the Check Data Sample Response section for more information.

ModifyServiceCharge
API to modify existing service charge value in an open check.
Method: POST
URL: https://<environment>/ModifyServiceCharge

Sample Request
{
"serviceChargeValue": 0,
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for the field descriptions:

Field Description
serviceChargeValue A fixed charge paid to the service provider for availing their
service.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

ApplyDiscount
This API is called to apply a discount to an open check. Both item level and check level
discounts are applicable. The following are the two possible use-cases:
▪ When ItemIndex is passed in the request, the item level discount is applied.
▪ When ItemIndex is not passed in the request, the check level discount is applied.
Method: POST

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 182
 IGPOS API | Reference Guide

URL: https://<environment>/ApplyDiscount

Sample Request
{
"openDiscountValue": 0,
"discountId": 0,
"itemIndex": 0,
"checkNumber": "string",
"guid": "string",
"extraData": "string"
}

□ Refer to the following table for field descriptions:

Field Description
openDiscountValue The value of the open discount to be applied.
discountId A system generated or user typed unique number in the range
of [1-9999] to identify the discount at the POS terminal.
itemIndex The index of the item to which the discount has been applied.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
extraData Additional information for a chosen discount.

Sample Response
Refer to the Check Data Sample Response section for more information.

RemoveGratuity
This API is called to remove the gratuity value in an open check.
Method: POST
URL: https://<environment>/RemoveGratuity

Sample Request
{
"checkNumber":"string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 183
 IGPOS API | Reference Guide

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

RemoveServiceCharge
This API is called to remove the service charge value in an open check.
Method: POST
URL: https://<environment>/RemoveServiceCharge

Sample Request
{
"checkNumber":"string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

RemoveCheckTax
This API is called to remove the applied tax in an open check.
Method: POST
URL: https://<environment>/RemoveCheckTax

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 184
 IGPOS API | Reference Guide

Sample Request
{
"checkNumber":"string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

RestoreCheckTax
This API is called to restore the removed tax amount in an open check.
Method: POST
URL: https://<environment>/RestoreCheckTax

Sample Request
{
"checkNumber":"string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 185
 IGPOS API | Reference Guide

RestoreGratuity
This API is called to restore the removed gratuity value in an open check.
Method: POST
URL: https://<environment>/RestoreGratuity

Sample Request
{
"checkNumber":"string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

RestoreServiceCharge
This API is called to restore the removed service charge amount in an open check.
Method: POST
URL: https://<environment>/RestoreServiceCharge

Sample Request
{
"checkNumber":"string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 186
 IGPOS API | Reference Guide

Sample Response
Refer to the Check Data Sample Response section for more information.

CancelCheck
This API is used to cancel the open check that was not saved previously. When the check is
recalled, and if it remains in the open state, the CancelCheck operation cannot be performed. In
such cases, only the VoidCheck API can be invoked.
Method: POST
URL: https://<environment>/CancelCheck

Sample Request
{
"checkNumber":"string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

RemoveTryPayCheck
This API Is called to remove the executed TryPayCheck transaction. This is applicable for both
TryPayCheck and External TryPayCheck transactions.
Method: POST
URL: https://<environment>/RemoveTryPayCheck

Sample Request
"string"

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 187
 IGPOS API | Reference Guide

VoidDiscount
This API is called to void the applied discount in an open check. Both the item level and check
level discounts can be voided.
Method: POST
URL: https://<environment>/VoidDiscount

Sample Request
{
"checkNumber": "string",
"guid": "string",
"discountIndex": 0,
"itemIndex": 0
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
discountIndex The index of the discount being voided.
itemIndex The index of the item to which the discount has been voided.

Sample Response
Refer to the Check Data Sample Response section for more information.

ModifyWithheldAmount
This API is called to modify withheld amount.
Method: POST
URL: https://<environment>/ModifyWithheldAmount

Sample Request
{
"withheldValue": 0,
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 188
 IGPOS API | Reference Guide

Field Description
withheldValue For future use.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

ModifyCreditTender
This API is called to modify credit tender.
Method: POST
URL: https://<environment>/ModifyCreditTender

Sample Request
{
"creditTender": 0,
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
creditTender The credit tender amount that must be modified.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

TipTransfer
This API is called to transfer the tip amount from one employee to another.
Method: POST
URL: https://<environment>/TipTransfer

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 189
 IGPOS API | Reference Guide

Sample Request
{
"fromEmployeeId": 0,
"toEmployeeId": 0,
"transferAmount": 0,
"terminalId": 0,
"profitCenterId": 0,
"mealPeriodId": 0
}

□ Refer to the following table for field descriptions:

Field Description
fromEmployeeId A unique number [1 to 999,999,999] assigned for an employee.
This denotes the ID of the employee who transfers the tip.
toEmployeeId A unique number [1 to 999,999,999] assigned for an employee.
This denotes the ID of the employee who receives the tip.
transferAmount The desired tip that needs to be transferred.
terminalId A numerical value within a range of [1-9999] that gives a
unique identity to the POS terminal.
profitCenterId A unique and modifiable value within a range of [1-999] that
identifies the profit center. Some of the Property Management
Systems (PMS) interfaces allow only up to the range of [1-99].
mealPeriodId A unique number within the range of [1-255] that identifies the
meal period. Some of the Property Management Systems
(PMS) interfaces allow only up to the range of [1-9].

Sample Response
"string"

TipPayout
This API is called to perform a tip payout against an employee.
Method: POST
URL: https://<environment>/TipPayout

Sample Request
{
"employeeId": 0,
"payoutAmount": 0,
"terminalId": 0,
"profitCenterId": 0,
"mealPeriodId": 0
}

□ Refer to the following table for field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 190
 IGPOS API | Reference Guide

Field Description
employeeId A unique number [1 to 999,999,999] assigned for an employee.
payoutAmount The total tip payout amount.
terminalId A numerical value within a range of [1-9999] that gives a
unique identity to the POS terminal.
profitCenterId A unique and modifiable value within a range of [1-999] that
identifies the profit center. Some of the Property Management
Systems (PMS) interfaces allow only up to the range of [1-99].
mealPeriodId A unique number within the range of [1-255] that identifies the
meal period. Some of the Property Management Systems
(PMS) interfaces allow only up to the range of [1-9].

Sample Response
"string"

ShiftReset
This API is called to reset the current shift of the employee.
Method: POST
URL: https://<environment>/ShiftReset

Sample Request
{
"operatorID": 0,
"terminalId": 0,
"openCheckFlag": true,
"cashDrop": 0,
"cashTip": 0,
"clockOutFlag": true,
"employeeId": 0
}

□ Refer to the following table for field descriptions:

Field Description
operatorId A unique identification number that is assigned to the terminal
operator.
terminalId A numerical value within a range of [1-9999] that gives a
unique identity to the POS terminals.
openCheckFlag ▪ True - Indicates the open checks created by the employee
and that needs to be transferred.
▪ False - Indicates no open checks.
cashDrop Indicates the cash on hand minus starting cash amount unless
a loan is used at the beginning of the shift to represent the
float. Cashiers are prompted to enter the cash drop amount
and then have to verify the same.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 191
 IGPOS API | Reference Guide

Field Description
cashTip Indicates the total amount of cash tips received in a particular
shift. Terminal operators declare the cash tip value at the end
of their shift to
clockOutFlag ▪ True - Indicate that the employee clocks out on running
this report.
▪ False - The employee does not clock out.
employeeId A unique number [1 to 999,999,999] assigned to an employee.

Sample Response
"string"

ModifyServer
This API is called to modify server in an open check.
Method: POST
URL: https://<environment>/ModifyServer

Sample Request
{
"employeeId": 0,
"password": "string",
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
employeeId A unique number [1 to 999,999,999] assigned to an employee.
password A four-digit numerical value that allows employees to sign-in to
the POS terminal. Employees can sign-in without typing the
password if it is set to zero.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 192
 IGPOS API | Reference Guide

SetTable
This API is called to set a table number for an open check.
Method: POST
URL: https://<environment>/SetTable

Sample Request
{
"checkNumber": "string",
"guid": "string",
"tableNumber": "0",
"isCheckLabel": true
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
tableNumber A unique number labelled for a table.
isCheckLabel ▪ True - A label is assigned to a check.
▪ False - A label is not assigned to a check.

Sample Response
Refer to the Check Data Sample Response section for more information.

ModifySeat
This API is called to modify an existing seat in the table.
Method: POST
URL: https://<environment>/ModifySeat

Sample Request
"string"

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 193
 IGPOS API | Reference Guide

RecallCheckList
This API is used to recall a set of open checks. It recalls all open checks in the given profit
center.
Method: POST
URL: https://<environment>/RecallCheckList

Sample Request
{
"maxTableCount": 0,
"profitCenterId": 0
}

□ Refer to the following table for field descriptions:

Field Description
maxTableCount The maximum number of tables available in the
restaurant/hotel.
profitCenterId A unique and modifiable value within a range of [1-999] that
identifies the profit center. Some of the Property Management
Systems (PMS) interfaces allow only up to the range of [1-99].

Sample Response
{
"checkCount": 0,
"openCheckResponses": [
{
"CheckNumber": 0,
"ProfitCenter": 0,
"TableNumber": "string",
"Amount": 0,
"OpenDateTime": "2023-12-07T11:07:41.690Z",
"IsCheckLabel": true,
"CheckType": "string",
"EmployeeList": {
"Length": 0,
"LongLength": 0,
"Rank": 0,
"SyncRoot": {},
"IsReadOnly": true,
"IsFixedSize": true,
"IsSynchronized": true
},
"MealPeriod": 0
}
],
"ContextValues": {
"additionalProp1": {
"code": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 194
 IGPOS API | Reference Guide

"text": "string"
},
"additionalProp2": {
"code": "string",
"text": "string"
},
"additionalProp3": {
"code": "string",
"text": "string"
}
}
}

□ Refer to the following table for field descriptions:

Field Description
checkCount The total number of checks stored.
openCheckResponses
CheckNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
ProfitCenter Denotes the profit center to which the checks belong to.
TableNumber A unique number labelled for a table.
Amount The total amount of the listed items in the check.
OpenDateTime Indicates the open date (YYYY-MM-DD) and time (HH:MM:SS)
of the check.
IsCheckLabel ▪ True - A label is assigned to a check.
▪ False - A label is not assigned to a check.
CheckType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.
EmployeeList
Length For internal purpose.
LongLength For internal purpose.
Rank For internal purpose.
SyncRoot For internal purpose.
IsReadOnly For internal purpose.
IsFixedSize For internal purpose.
IsSynchronized For internal purpose.
MealPeriod A particular period in a day to categorize specific items, price
levels, and others. Also, Meal Period is used to generate
reports, such as sales performance report, product mix report,
etc., for that particular period of the day.
ContextValues

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 195
 IGPOS API | Reference Guide

Field Description
additionalProp1
code For future use.
text For future use.
additionalProp2
code For future use.
text For future use.
additionalProp3
code For future use.
Text For future use.

AddTip
API to add tip amount to an open check.
Method: POST
URL: https://<environment>/AddTip

Sample Request
{
"tipAmount": 0,
"isPercent": true,
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
tipAmount The total amount tipped to the user by the guests.
isPercent ▪ True - The tip is calculated as a percentage of the check
total.
▪ False - The tip is not calculated as a percentage of the
check total.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 196
 IGPOS API | Reference Guide

ModifyTip
API to modify existing tip amount.
Method: POST
URL: https://<environment>/ModifyTip

Sample Request
{
"tipAmount": 0,
"isPercent": true,
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
tipAmount The total amount tipped to the user by the guests.
isPercent ▪ True - The default tip in percentages (10, 15, 18, 20)
appears.
▪ False - The default tip in dollar amount (0,1, 2, and 5)
appears.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

AddGuest
The AddGuest API is called to add guest information to an open check. The GetHandle API
must be invoked before calling this API.
Method: POST
URL: https://<environment>/AddGuest

Sample Request
{
"checkNumber": "string",
"guid": "string",
"handle": "string"
}

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 197
 IGPOS API | Reference Guide

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
handle When a given input is validated/authorized succesfully by the
integrated payment service provider, a unique handle is
returned for that tender. This is then used to complete the
payment.

Sample Response
Refer to the Check Data Sample Response section for more information.

VoidGuest
API to void already added guest information from the open check.
Method: POST
URL: https://<environment>/VoidGuest

Sample Request
{
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

VoidTip
This API is called to void already added tip amount in an open check.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 198
 IGPOS API | Reference Guide

Method: POST
URL: https://<environment>/VoidTip

Sample Request
{
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

HoldCheck
This API is called to hold a check. When the check is on hold, the items are not passed to the
kitchen.
Method: POST
URL: https://<environment>/HoldCheck

Sample Request
{
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 199
 IGPOS API | Reference Guide

Sample Response
Refer to the Check Data Sample Response section for more information.

ModifyCheckType
This API is called to modify an existing check type in an open check.
Method: POST
URL: https://<environment>/ModifyCheckType

Sample Request
{
"checkType": "string",
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

TransferCheck
This API is called to transfer a check from one profit center to another profit center.
Method: POST
URL: https://<environment>/TransferCheck

Sample Request
{
"profitCenterId": "string",
"tableNumber": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 200
 IGPOS API | Reference Guide

"employeeId": "string",
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
profitCenterId A unique and modifiable value within a range of [1-999] that
identifies the profit center. Some of the Property Management
Systems (PMS) interfaces allow only up to the range of [1-99].
tableNumber A unique number labelled for a table.
employeeId A unique number [1 to 999,999,999] assigned for an employee.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

SetSplitAmount
This API is called to set a split amount for an open check.
Method: POST
URL: https://<environment>/SetSplitAmount

Sample Request
{
"checkNumber": "string",
"guid": "string",
"splitAmount": "0"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
splitAmount The split amount to divide the total check amount.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 201
 IGPOS API | Reference Guide

Sample Response
Refer to the Check Data Sample Response section for more information.

HoldOrFireItems
This API is called to put an item on hold or fire status in an open check.
Method: POST
URL: https://<environment>/HoldOrFireItems

Sample Request
{
"isFire": true,
"checkNumber": "string",
"guid": "string",
"index": 0,
"orderItemIndex": 0
}

□ Refer to the following table for field descriptions:

Field Description
isFire ▪ True - Sends a previously held item to the kitchen printer.
▪ False - The item is still held without processing it to the
kitchen.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
index The overall check index (including other entities like discount,
modifiers, and others).
orderItemIndex The index of the items in the order.

Sample Response
Refer to the Check Data Sample Response section for more information.

SetHoldOrFire
This API is called to set the default status for the items to be added to the check. For example,
when the default status of the check is set to hold using this API, the status for any item added
to this check will be on hold.
Method: POST
URL: https://<environment>/SetHoldOrFire

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 202
 IGPOS API | Reference Guide

Sample Request
"string"

Sample Response
"string"

GetGuestTierDiscounts
This API is called to get the discounts applicable to the guest’s tier that is associated with the
check.
Method: POST
URL: https://<environment>/GetGuestTierDiscounts

Sample Request
{
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
"string"

CloseOrder
The CloseOrder API is used to complete the check. This API must be invoked only after
completing the payment.
For example, when payment-related APIs such as ExternalTendercheck, Sale, or Accept APIs
are used, the CloseOrder API must be called only after completing the payment using the above
APIs.
Method: POST
URL: https://<environment>/CloseOrder

Sample Request
{

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 203
 IGPOS API | Reference Guide

"checkNumber": "string",
"guid": "string",
"fireAllItems": false
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
fireAllItems ▪ True - All the items in the check are sent to the kitchen.
▪ False - Only items in the hold state are sent to the kitchen.

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 204
 IGPOS API | Reference Guide

Item Transaction
Process86
This API is called to 86 an item.
Method: POST
URL: https://<environment>/Process86

Sample Request
[
{
"Type": 1,
"Id": 1003,
"Action": 2
}
]

□ Refer to the following table for field descriptions:

Field Description
Type The type of entity (items or modifiers) which is being 86'ed.
Id A unique value identifying the entity.
Action Indicates the action (86/un86) to be performed on the entity.

Sample Response
"string"

VoidItem
This API is called to void an item in the open check.
Method: POST
URL: https://<environment>/VoidItem

Sample Request
{
"checkNumber": "string",
"guid": "string",
"index": 0,
"voidReasonId": 0
}

□ Refer to the following table for the field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 205
 IGPOS API | Reference Guide

Field Description
checkNumber A numerical value that gives unique identification to every check
generated in the POS terminal. This value is an amalgamation of
terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it is
given a GUID which is used in all the subsequent check operations
as its identifier.
index The item index (position of items) in the check.
voidReasonId A unique number in the range [2-253] that identifies the reason for
the void. The void reasons ID = 1, 254, 255 are already predefined
and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check

Sample Response
Refer to the Check Data Sample Response section for more information.

ReturnItem
This API is called to return an item.
Method: POST
URL: https://<environment>/ReturnItem

Sample Request
{
"checkNumber": "string",
"guid": "string",
"index": 0
}

□ Refer to the following table for the field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every check
generated in the POS terminal. This value is an amalgamation of
terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it is
given a GUID which is used in all the subsequent check operations
as its identifier.
index The index of the items in the check.

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 206
 IGPOS API | Reference Guide

AddItem
This API is called to add an item to an open check.
Method: POST
URL: https://<environment>/AddItem

Sample Request
{
"quantity": 0,
"itemId": "string",
"checkNumber": "string",
"guid": "string",
"index": 0,
"price": 0,
"weight": 0,
"openItemName": "string",
"isPriceOverride": true,
"IsSoldByWeight": true,
"seatNumber": "string",
"skuCode": "string",
"modifiers": [
{
"id": 0,
"choiceGroupID": 0,
"discountExtraData": "string",
"modifiers": [
{
"id": 0,
"choiceGroupID": 0
}
]
}
],
"specialInstructions": [
{
"text": "string",
"id": 0
}
]
}

□ Refer to the following table for field descriptions:

Field Description
quantity Denotes the quantity of items listed in the check.
itemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 207
 IGPOS API | Reference Guide

Field Description
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
index The index of the items in the check.
price Indicates the price of every item in the check with the currency
symbol and the language that is selected on the Enterprise
form.
weight If the item is sold by its weight, this field denotes the weight of
the item listed in the check.
openItemName The name entered by the employee to an open item while
adding it to the check
isPriceOverride ▪ True - Overrides the scanned price of a retail item.
▪ False - Does not override the scanned price of a retail
item.
IsSoldByWeight ▪ True - The function activates the Tare Weight field as the
item’s base price is the price per unit of weight (Pound,
Kilogram, gram, etc.,)
▪ False - Denotes the item is not sold on a weight basis.
seatNumber Indicates the seat number for which the items are intended.
skuCode The alphanumeric code assigned to the item that can be swiftly
scanned by a barcode reader during the purchase.
modifiers
id Represents a unique identity value for the modifier.
choiceGroupID A unique numerical value within a range of [1-99999] to identify
a choice group.
discountExtraData A prompt to provide additional information for a chosen
discount. User can enter the text manually using the on-screen
keyboard or by using the card swipe.
modifiers
id Represents a unique identity value for the modifier.
choiceGroupID A unique numerical value within a range of [1-99999] to identify
a choice group.
specialInstructions
text Represents the name of the special instruction with a maximum
of 20 characters.
id A unique numerical value within a range of [1-9999] to identify
the special instruction.

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 208
 IGPOS API | Reference Guide

ModifyItemQuantity
This API is called to modify item quantity in an open check.
Method: POST
URL: https://<environment>/ModifyItemQuantity

Sample Request
{
"quantity": 0,
"checkNumber": "string",
"guid": "string",
"index": 1,
"price": 0,
"weight": 0
}

□ Refer to the following table for field descriptions:

Field Description
quantity Denotes the quantity of items listed in the check.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
index The index of the items in the check.
price Indicates the price of every item in the check with the currency
symbol and the language that is selected on the Enterprise
form.
weight If the item is sold by its weight, this field denotes the weight of
the item listed in the check.

Sample Response
Refer to the Check Data Sample Response section for more information.

RemoveItemTax
This API is called to remove item tax value that is added in an open check.
Method: POST
URL: https://<environment>/RemoveItemTax

Sample Request
{
"checkNumber": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 209
 IGPOS API | Reference Guide

"guid": "string",
"index": 0
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
index The index of the items for which the tax is removed.

Sample Response
Refer to the Check Data Sample Response section for more information.

RestoreItemTax
This API is called to restore the removed item tax in an open check.
Method: POST
URL: https://<environment>/RestoreItemTax

Sample Request
{
"checkNumber": "string",
"guid": "string",
"index": 0
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
index The item index (position of items) in the check.

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 210
 IGPOS API | Reference Guide

ReorderItem
This API is called to reorder items in an open check.
Method: POST
URL: https://<environment>/ReorderItem

Sample Request
{
"quantity": 0,
"checkNumber": "string",
"guid": "string",
"index": 1,
"price": 0,
"weight": 0
}

□ Refer to the following table for field descriptions:

Field Description
quantity Denotes the quantity of items listed in the check.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
index The index of items in the check.
price Indicates the price of every item in the check with the currency
symbol and the language that is selected on the Enterprise
form.
weight If the item is sold by its weight, this field denotes the weight of
the item listed in the check.

Sample Response
Refer to the Check Data Sample Response section for more information.

ModifyItemDiscount
This API is called to modify applied item discount value in an open check.
Method: POST
URL: https://<environment>/ModifyItemDiscount

Sample Request
{
"checkNumber": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 211
 IGPOS API | Reference Guide

"guid": "string",
"discountIndex": 0,
"itemIndex": 0
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
discountIndex The index of the discount being modified.
itemIndex The index of the item to which the discount has been modified.

Sample Response
Refer to the Check Data Sample Response section for more information.

AddItemByItemNumber
This API is called to add an item using the item number in an open check.
Method: POST
URL: https://<environment>/AddItemByItemNumber

Sample Request
{
"quantity": 1,
"itemId": "string",
"checkNumber": "string",
"guid": "string",
"index": 0,
"price": 0,
"weight": 0,
"openItemName": "string",
"isPriceOverride": true,
"seatNumber": "string",
"itemNumber": "string"
}

□ Refer to the following table for field descriptions:

Field Description
quantity Denotes the quantity of items listed in the check.
itemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 212
 IGPOS API | Reference Guide

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
index The index of items in the check.
price Indicates the price of every item in the check with the currency
symbol and the language that is selected on the Enterprise
form.
weight If the item is sold by its weight, this field denotes the weight of
the item listed in the check.
openItemName The name entered by the employee to an open item while
adding it to the check
isPriceOverride ▪ True - Overrides the scanned price of a retail item.
▪ False - Does not override the scanned price of a retail
item.
seatNumber Seat number to which this item is to be tagged in the check.
itemNumber For future use.

Sample Response
Refer to the Check Data Sample Response section for more information.

AddSpecialInstruction
This API is called to add special instruction for an item in the open check.
Method: POST
URL: https://<environment>/AddSpecialInstruction

Sample Request
{
"text": "string",
"id": 0,
"index": 0,
"checkNumber": "string",
"guid": "string",
"modifierSpecialInstruction": [
{
"text": "string",
"id": 0,
"index": 0
}
]
}

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 213
 IGPOS API | Reference Guide

□ Refer to the following table for field descriptions:

Field Description
text Represents the name of the special instruction with a maximum
of 20 characters.
id A unique numerical value within a range of [1-9999] to identify
the special instruction.
index Index of the special instruction being modified.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
modifierSpecialInstruction The item index
text Represents a string value that provides special instruction to
the modifier.
id A unique numerical value within a range of [1-99999] to identify
a modifier.
index The Index of the modifiers to which the special instruction has
been modified.

Sample Response
Refer to the Check Data Sample Response section for more information.

VoidSpecialInstruction
This API is called to void special instruction that was added for an item in the open check.
Method: POST
URL: https://<environment>/VoidSpecialInstruction

Sample Request
{
"index": 0,
"checkNumber": "string",
"guid": "string",
"voidReasonId": 0,
"modiferSpecialInstruction": [
{
"index": 0,
"voidReasonId": 0
}
]
}

□ Refer to the following table for field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 214
 IGPOS API | Reference Guide

Field Description
index Index of the special instruction being voided.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
voidReasonId A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check
modifierSpecialInstruction
index The Index of the modifiers to which the special instruction has
been voided.
voidReasonId A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check

Sample Response
Refer to the Check Data Sample Response section for more information.

ItemPriceOverride
This API is called to override the item price in an open check.
Method: POST
URL: https://<environment>/ItemPriceOverride

Sample Request
"string"

Sample Response
Refer to the Check Data Sample Response section for more information.

AddModifier
This API is called to add modifier to a specific item in an open check.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 215
 IGPOS API | Reference Guide

Method: POST
URL: https://<environment>/AddModifier

Sample Request
{
"itemIndex": 0,
"checkNumber": "string",
"guid": "string",
"modifiers": [
{
"id": 0,
"choiceGroupID": 0,
"discountExtraData": "string",
"modifiers": [
{
"id": 0,
"choiceGroupID": 0,
"modifiers": null
}
]
}
]
}

□ Refer to the following table for field descriptions:

Field Description
itemIndex The item index (position of items) in the check.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
modifiers
id Represents a unique identity value for the modifier.
choiceGroupID A unique numerical value within a range of [1-99999] to identify
a choice group.
discountExtraData A prompt to provide additional information for a chosen
discount. User can enter the text manually using the on-screen
keyboard or by using the card swipe.
modifiers
id Represents a unique identity value for the modifier.
choiceGroupID A unique numerical value within a range of [1-99999] to identify
a choice group.
modifiers Array of modifiers to be added to an item.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 216
 IGPOS API | Reference Guide

Sample Response
Refer to the Check Data Sample Response section for more information.

VoidModifier
This API is called to void the modifier of a specific item in an open check.
Method: POST
URL: https://<environment>/VoidModifier

Sample Request
{
"checkNumber": "string",
"guid": "string",
"checkItemIndex": 0,
"itemIndex": 0,
"index": 0,
"voidReasonId": 0
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
checkItemIndex The index of the item that includes modifier.
ItemIndex The index of the item to which the modifiers has been voided.
index The index of the modifiers that has been voided.
voidReasonId A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 217
 IGPOS API | Reference Guide

Full Service
Login
API to authenticate user credentials.
Method: POST
URL: https://<environment>/fs/Login

The request and response of this API are the same as Login API (Authentication). Refer to
Sample Request and Sample Response sections of the Login API for more information.

CalculateOrder
CalculateOrder API is called to calculate the check total after adding items, discounts, and
payments based on configurations. The response of this API does not contain error messages.
For example, when an item is 86’ed, the response of this API does not pass the information that
the item is not available.
Method: POST
URL: https://<environment>/fs/CalculateOrder

The request and response of this API are the same as CalculateOrder API (Check
Transaction). Refer to Sample Request and Sample Response sections of the
CalculateOrder API for more information.

CalculateOrderWithErrors
This API is called to get check data that has errors. For example, when an item is 86’ed, this
API gives the response that the item is not available.
This is applicable only to InfoGenesis POS 12.1.4.
Method: POST
URL: https://<environment>/fs/CalculateOrderwithErrors

The request and response of this API are the same as CalculateOrderWithErrors API
(Check Transaction). Refer to Sample Request and Sample Response sections of the
CalculateOrderWithErrors API for more information.

AppendCheck
This API is used to add new items or apply discounts to the saved check. When this API is
called, it recalls the saved check, appends the latest information sent in the request, and saves
the check.
Method: POST
URL: https://<environment>/fs/AppendCheck

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 218
 IGPOS API | Reference Guide

Sample Request
The request of this API is the same as AppendCheck API (Check Transaction). Refer to the
Sample Request section of the AppendCheck API for more information.

Sample Response
Success

GetOpenCheckInfo
This API is called to get information about the open check. It retrieves the information about the
check that was already opened and saved from the IG database.
Method: POST
URL: https://<environment>/fs/GetOpenCheckInfo

Sample Request
{
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every check
generated in the POS terminal. This value is an amalgamation of
terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it is
given a GUID which is used in all the subsequent check operations
as its identifier

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 219
 IGPOS API | Reference Guide

Payments
GetHandles
This API is called to validate the account number/card number for the PMS or CMS. It gives the
account information and balances as a response.
Method: POST
URL: https://<environment>/GetHandles

Sample Request
{
"tenderId": "string",
"checkNumber": "string",
"checkAmount": 0,
"guid": "string",
"eventId": "string",
"inputData": {
"id": "string",
"name": "string",
"sendToPMSHost": true,
"IsGetCasinoAddOnData": true,
"cardData": {
"pin": "string",
"track1": "string",
"track2": "string"
},
"type": "string",
"couponId": "string"
}
}

□ Refer to the following table for descriptions:

Field Description
tenderId A unique and modifiable value within a range of [1-255]. Some
of the PMS interfaces will not permit users to use the check
types whose ID is greater than nine [9] when Tender ID
number is higher than ninety-nine [99].
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
checkAmount Displays the total amount of the check.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
eventId For future use.
inputData

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 220
 IGPOS API | Reference Guide

Field Description
id A unique string value identifying the customer.
name A unique string value representing the name of the customer.
sendtoPMSHost ▪ True - The input data is sent directly to the PMS Host from
the payment proxy.
▪ False - The input data is sent to the PMS XML service.
IsGetCasinoAddOnData ▪ True - The add-on data is collected for casino tenders.
▪ False - The add-on data is not collected for casino tenders.
cardData
pin Indicates the pin for authenticating the card/account details of
the guest.
track1 Indicates the track 1 data of the MSR card that is swiped as
input.
track2 Indicates the track 2 data of the MSR card that is swiped as
input.
type Type of input data that is sent.
Example: In PMS inquiry the input data can be a room number
or account number.
couponId Coupon ID is identical to Discount ID as both values share the
same ID pool. It is a unique number within a range of [1-9999].

Sample Response
{
"ErrorMessage": "string",
"PaymentHandle": [
{
"Handle": "string",
"InquiryInfo": {
"Id": "string",
"Type": "string",
"Name": "string",
"CardData": {
"Track1": "string",
"Track2": "string",
"EncryptedData": "string",
"encryptionMode": "string"
},
"StartDate": "string",
"EndDate": "string",
"InvoiceID": "string"
},
"Name": "string",
"Type": "string",
"Balance": 0,
"IsBalanceVisible": true,
"IsRefundable": true,
"allowed_flag": true,
"limit_flag": true,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 221
 IGPOS API | Reference Guide

"AdditionalAttributes": {
"additionalProp1": {
"code": "string",
"text": "string"
},
"additionalProp2": {
"code": "string",
"text": "string"
},
"additionalProp3": {
"code": "string",
"text": "string"
}
},
"AllowedAPIs": [
"string"
],
"charged_amt": 0,
"price_level_id": 0,
"discount_id": 0,
"post_accnt": "string",
"auth_accnt": "string",
"auth_type": "string",
"err_status": 0,
"Restrictions": [
{
"Id": "string",
"Name": "string",
"Type": "string",
"Value": "string"
}
],
"Discounts": [
{
"Id": "string",
"Name": "string",
"Type": "string",
"Value": "string"
}
],
"Inclusions": [
{
"Id": "string",
"Name": "string",
"Type": "string",
"Value": "string"
}
]
}
],
"Status": 0
}

□ Refer to the following table for the field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 222
 IGPOS API | Reference Guide

Field Description
ErrorMessage Indicates the error message that must be displayed when the
GetHandles call is not successful
PaymentHandle
Handle When a given input is validated/authorized succesfully by the
integrated payment service provider, a unique handle is
returned for that tender. This is then used to complete the
payment.
InquiryInfo
Id Indicates the ID used for inquiry such as account ID, Player ID,
and others.
Type Type of inquiry that is made.
Name Indicates the name of the guest.
CardData
Track1 Indicates the track 1 data of the MSR card that is swiped as
input.
Track2 Indicates the track 2 data of the MSR card that is swiped as
input.
EncryptedData Indicates the encrypted card data.
encryptionMode Indicates the mode with which the card data is encrypted.
StartDate Date and time at which the GetHandles call is initiated.
EndDate For future use.
InvoiceID Indicates the check ID for which the payment is being made.
Name Indicates the name of the guest.
Type Indicates the type of the payment.
Balance Indicates the balance in the card/account.
IsBalanceVisible ▪ True - Displays the available balance on the screen.
▪ False - The balance is not displayed on the screen.
IsRefundable ▪ True - Refund is allowed.
▪ False - Refund is not allowed.
allowed_flag For future use.
limit_flag For future use.
AdditionalAttributes
additionalProp1
code For future use.
text For future use.
additionalProp2
code For future use.
text For future use.
additionalProp3
code For future use.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 223
 IGPOS API | Reference Guide

Field Description
text For future use.
AllowedAPIs The list of API calls allowed for this handle such as Inquiry,
Sale, and others. For certain tenders Inquiry is not supported,
for some, refund is not supported.
charged_amt The amount for which the payment is made.
price_level_id A unique number identifying the current price level.
discount_id ID of the discount that is mapped to the tender which needs to
be automatically applied to the check when the tender is
applied based on the configurations in UD
post_accnt The account to which the payment transaction details must be
posted.
auth_accnt The account which is used to authorize the payment.
auth_type Indicates the type of authorization that is made.
err_status The error code that is returned by the payment service provider
for an error.
Restrictions
Id A unique value identifying the restriction.
Name The name of the restriction.
Type The type of the restriction.
Value The value of the restriction.
Discounts
Id A unique value identifying the discount.
Name The name of the discount.
Type The type of the discount.
Value The discount value.
Inclusions
Id A unique value identifying the inclusion.
Name The name of the inclusion.
Type The type of the inclusion.
Value The appropriate value.
Status Status of the GetHandles call. It indicates either success or
error code.

GetAllHandles
This API is specific for GA. It is called to retrieve all available account information and its
appropriate balances.
Method: POST
URL: https://<environment>/GetAllHandles

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 224
 IGPOS API | Reference Guide

Sample Request
{
"tenderId": "string",
"checkNumber": "string",
"checkAmount": 0,
"guid": "string",
"eventId": "string",
"inputData": {
"id": "string",
"name": "string",
"sendToPMSHost": true,
"IsGetCasinoAddOnData": true,
"cardData": {
"pin": "string",
"track1": "string",
"track2": "string"
},
"type": "string",
"couponId": "string"
}
}

□ Refer to the following table for descriptions:

Field Description
tenderId A unique and modifiable value within a range of [1-255]. Some
of the PMS interfaces will not permit users to use the check
types whose ID is greater than nine [9] when Tender ID
number is higher than ninety-nine [99].
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
checkAmount Displays the total amount of the check.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
eventId For future use.
inputData
id A unique string value identifying the customer.
name A unique string value representing the name of the customer.
sendtoPMSHost ▪ True - The input data is sent directly to the PMS Host from
the payment proxy.
▪ False - The input data is sent to the PMS XML service.
IsGetCasinoAddOnData ▪ True - The add-on data is collected for casino tenders.
▪ False - The add-on data is not collected for casino tenders.
cardData

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 225
 IGPOS API | Reference Guide

Field Description
pin Indicates the pin for authenticating the card/account details of
the guest.
track1 Indicates the track 1 data of the MSR card that is swiped as
input.
track2 Indicates the track 2 data of the MSR card that is swiped as
input.
type Type of input data that is sent.
Example: In PMS inquiry the input data can be a room number
or account number.
couponId Coupon ID is identical to Discount ID as both values share the
same ID pool. It is a unique number within a range of [1-9999].

Sample Response
{
"ErrorMessage": "string",
"PaymentHandle": [
{
"Handle": "string",
"InquiryInfo": {
"Id": "string",
"Type": "string",
"Name": "string",
"CardData": {
"Track1": "string",
"Track2": "string",
"EncryptedData": "string",
"encryptionMode": "string"
},
"StartDate": "string",
"EndDate": "string",
"InvoiceID": "string"
},
"Name": "string",
"Type": "string",
"Balance": 0,
"IsBalanceVisible": true,
"IsRefundable": true,
"allowed_flag": true,
"limit_flag": true,
"AdditionalAttributes": {
"additionalProp1": {
"code": "string",
"text": "string"
},
"additionalProp2": {
"code": "string",
"text": "string"
},
"additionalProp3": {

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 226
 IGPOS API | Reference Guide

"code": "string",
"text": "string"
}
},
"AllowedAPIs": [
"string"
],
"charged_amt": 0,
"price_level_id": 0,
"discount_id": 0,
"post_accnt": "string",
"auth_accnt": "string",
"auth_type": "string",
"err_status": 0,
"Restrictions": [
{
"Id": "string",
"Name": "string",
"Type": "string",
"Value": "string"
}
],
"Discounts": [
{
"Id": "string",
"Name": "string",
"Type": "string",
"Value": "string"
}
],
"Inclusions": [
{
"Id": "string",
"Name": "string",
"Type": "string",
"Value": "string"
}
]
}
],
"Status": 0
}

□ Refer to the following table for the field descriptions:

Field Description
ErrorMessage Indicates the error message that must be displayed when the
GetHandles call is not successful
PaymentHandle
Handle When a given input is validated/authorized succesfully by the
integrated payment service provider, a unique handle is

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 227
 IGPOS API | Reference Guide

Field Description
returned for that tender. This is then used to complete the
payment.
InquiryInfo
Id Indicates the ID used for inquiry such as account ID, Player ID,
and others.
Type Type of inquiry that is made.
Name Indicates the name of the guest.
CardData
Track1 Indicates the track 1 data of the MSR card that is swiped as
input.
Track2 Indicates the track 2 data of the MSR card that is swiped as
input.
EncryptedData Indicates the encrypted card data.
encryptionMode Indicates the mode with which the card data is encrypted.
StartDate Date and time at which the GetHandles call is initiated.
EndDate For future use.
InvoiceID Indicates the check ID for which the payment is being made.
Name Indicates the name of the guest.
Type Indicates the type of the payment.
Balance Indicates the balance in the card/account.
IsBalanceVisible ▪ True - Displays the available balance on the screen.
▪ False - The balance is not displayed on the screen.
IsRefundable ▪ True - Refund is allowed.
▪ False - Refund is not allowed.
allowed_flag For future use.
limit_flag For future use.
AdditionalAttributes
additionalProp1
code For future use.
text For future use.
additionalProp2
code For future use.
text For future use.
additionalProp3
code For future use.
text For future use.
AllowedAPIs The list of API calls allowed for this handle such as Inquiry,
Sale, and others. For certain tenders Inquiry is not supported,
for some, refund is not supported.
charged_amt The amount for which the payment is made.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 228
 IGPOS API | Reference Guide

Field Description
price_level_id A unique number identifying the current price level.
discount_id ID of the discount that is mapped to the tender which needs to
be automatically applied to the check when the tender is
applied based on the configurations in UD
post_accnt The account to which the payment transaction details must be
posted.
auth_accnt The account which is used to authorize the payment.
auth_type Indicates the type of authorization that is made.
err_status The error code that is returned by the payment service provider
for an error.
Restrictions
Id A unique value identifying the restriction.
Name The name of the restriction.
Type The type of the restriction.
Value The value of the restriction.
Discounts
Id A unique value identifying the discount.
Name The name of the discount.
Type The type of the discount.
Value The discount value.
Inclusions
Id A unique value identifying the inclusion.
Name The name of the inclusion.
Type The type of the inclusion.
Value The appropriate value.
Status Status of the GetHandles call. It indicates either success or
error code.

Sale
The Sale API is used to complete the payment transaction. It is called to perform a tender based
on the TryPayCheck API response.
Method: POST
URL: https://<environment>/Sale

Sample Request
{
"tenderToken": "string",
"checkNumber": "string",
"checkGuid": "string",
"amount": {

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 229
 IGPOS API | Reference Guide

"saleAmount": 0,
"tipAmount": 0
},
"OpenValue": 0,
"closeOrder": true
}

□ Refer to the following table for the field descriptions:

Field Description
tenderToken The encrypted details of the inquiry that was previously made.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
checkGuid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
amount
saleAmount The amount of sale that is made using this tender.
tipAmount Tip amount covered by this tender.
OpenValue The coupon value that is passed when using the coupon
tender.
closeOrder ▪ True - The sale is completed, and the order is closed.
▪ False - The sale is not completed, and the order is not
closed.

Sample Response
Refer to the Check Data Sample Response section for more information.

Auth
The Auth API is used to authorize an amount to the given payment handle. This API is called
only after invoking GetHandle API.
Method: POST
URL: https://<environment>/Auth

Sample Request
{
"handle": "string",
"checkNumber": "string",
"checkGuid": "string",
"authAmount": 0
}

□ Refer to the following table for the field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 230
 IGPOS API | Reference Guide

Field Description
handle Handle of the tender obtained from the GetHandles call.
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
checkGuid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
authAmount Amount to be authorized by the payment gateway.

Sample Response
Refer to the Check Data Sample Response section for more information.

Accept
The Accept API is used to accept an authorized tender amount. This API is called only after
invoking the Auth API.
Method: POST
URL: https://<environment>/Accept

Sample Request
{
"checkNumber": "string",
"checkGuid": "string",
"tenderToken": "string",
"amount": {
"saleAmount": 0,
"tipAmount": 0
},
"closeOrder": true
}

□ Refer to the following table for the field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
checkGuid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
tenderToken The encrypted details of the inquiry that was previously made.
amount
saleAmount The amount of sale that is made using this tender.
tipAmount Tip amount covered by this tender.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 231
 IGPOS API | Reference Guide

Field Description
closeOrder ▪ True - The sale is completed, and the order is closed.
▪ False - The sale is not completed, and the order remains
open.

Sample Response
Refer to the Check Data Sample Response section for more information.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 232
 IGPOS API | Reference Guide

Configuration
GetPromoItems
This API is called to get promo items.
Method: POST
URL: https://<environment>/GetPromoItems

Sample Request
{
"ProfitcenterId": 380,
"MealPeriodIds": [
9
]
}

□ Refer to the following table for descriptions:

Field Description
ProfitcenterId A unique and modifiable value within a range of [1-999] that
identifies the profit center. Some of the Property Management
Systems (PMS) interfaces allow only up to the range of [1-99].
MealPeriodIds A unique number within the range of [1-255] that identifies the
meal period. Some of the Property Management Systems
(PMS) interfaces allow only up to the range of [1-9].

Sample Response
[
{
"mealPeriodId": 1,
"items": [
1,
2,
3,
5
],
"packages": [
1,
2,
3,
4
]
}
]

□ Refer to the following table for field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 233
 IGPOS API | Reference Guide

Field Description
mealPeriodId A unique number within the range of [1-255] that identifies the
meal period. Some of the Property Management Systems
(PMS) interfaces allow only up to the range of [1-9].
items The list of promotional items.
packages The list of promotional packages.

GetCheckTypes
This API is called to get check type.
Method: POST
URL: https://<environment>/GetCheckTypes

Sample Request
No Parameters.

Sample Response
[
{
"Id": "string",
"ObjectType": "string",
"Content": "string",
"Action": "string",
"CreatedDate": "2023-12-07T09:55:22.698Z",
"EmployeeId": 0,
"EmployeeName": "string",
"Guid": "string",
"ProfitCenter": "string",
"TableNumber": "string",
"Amount": 0,
"IsCheckLabel": true,
"IsHoldCheck": true,
"CheckType": 0,
"BackColor": 0,
"ForeColor": 0,
"SplitSeatId": 0
}
]

□ Refer to the following table for descriptions:

Field Description
Id Indicates the check type ID.
ObjectType For future use.
Content For future use.
Action For future use.
CreatedDate Represents the date of the created check.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 234
 IGPOS API | Reference Guide

Field Description
EmployeeId A unique number [1 to 999,999,999] assigned for an employee.
EmployeeName Indicates the name of the employee.
Guid For future use.
ProfitCenter A string value that denotes the name of the profit center to
which the check belongs to.
TableNumber A unique number labelled for a table.
Amount Indicates the total amount of the check.
IsCheckLabel ▪ True - A label is assigned to the check with a maximum of
20 alphanumeric characters.
▪ False - No label is assigned to the check.
IsHoldCheck ▪ True - Holds all the items in the check from being sent to
the kitchen printer.
▪ False - All Items in the check will be sent to the kitchen
printers.
CheckType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.
BackColor Displays the background color of the selected button. Multiple
buttons can be selected, and the background color can be
changed in one-go by choosing the desired color available in
the drop-down menu.
NOTE: The available colors vary according to the selected
theme.
ForeColor Displays the font color of the selected button. Multiple buttons
can be selected, and the font color can be changed in one-go
by choosing the desired color available in the drop-down menu.
NOTE: The available colors vary according to the selected
theme.
SplitSeatId A unique value identifying the seat of a split check. When a
check is split, all the items in the check can be divided into
separate checks and assigned to a particular seat.

GetAllCommonInfo
This API is called to get all common info.
Method: POST
URL: https://<environment>/GetAllCommonInfo

Sample Request
No Parameters

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 235
 IGPOS API | Reference Guide

Sample Response
{
"CheckNumberingCode": 0,
"CurrencyCultureName": "string",
"DateTimeCulture": "string",
"CurrencySymbol": "string",
"VatModeFlag": true,
"HyattGoldPassFlag": true,
"InclusiveGratuityFlag": true,
"CasinoManagementFlag": true,
"FoodServiceLoyaltyFlag": true,
"TimeZone": "string",
"LanguageId": "string",
"LanguageName": "string",
"DecimalDigits": 0,
"EnableReprintCount": true,
"TerminalDefaultLangId": "string",
"TerminalSystemLangId": "string",
"ServerDateFormat": "string",
"TimeOffset": "string",
"TenantId": 0,
"BuyContextId": "string",
"IGBuyUrl": "string"
}

□ Refer to the following table for field descriptions:

Field Description
CheckNumberingCode Defines the numbering sequence of checks for all enterprises
within IG POS system.
CurrencyCultureName The name of the currency culture mapped to the store.
Example: en-us.
DateTimeCulture Indicates the date and time format for the enterprise.
CurrencySymbol Indicates the currency symbol for the enterprise and this
symbol appears in all currency fields of the Universal Desktop
and reports.
VatModeFlag ▪ True - The check excludes all other taxes except of taxes
configured under VAT Revenues and VAT Gratuities tab.
▪ False - The check includes other taxes as well.
HyattGoldPassFlag ▪ True - The Hyatt Gold Pass configuration is enabled.
▪ False - The Hyatt Gold Pass configuration is disabled.
InclusiveGratuityFlag ▪ True - The tip is added in the price of the item, and do not
appear separately on the receipts.
▪ False - The gratuity appears separately on the receipts.
CasinoManagementFlag ▪ True - The casino loyalty configuration is enabled.
▪ False - The casino loyalty configuration is disabled.
FoodServiceLoyaltyFlag ▪ True - The food service loyalty configuration is enabled.
▪ False - The food service loyalty configuration is disabled.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 236
 IGPOS API | Reference Guide

Field Description
TimeZone Indicates the time zone in which the schedule runs. By default,
the system takes the server time zone. It must be set to local
time zone.
LanguageId A unique value to identify the language. The primary and
secondary language can be set according to the preferences
and terminal uses this primary language as a default language.
LanguageName Denotes the name of the language.
DecimalDigits A customization option to configure the currency’s decimal
digit.
EnableReprintCount Enabling this checkbox allows user to print reprint check count
on duplicate receipts.
TerminalDefaultLangId A unique number identifying the default language of the POS
terminal. Employee sees this language at the sign-on screen
and all the errors (before or after sign-up) are displayed in this
language.
TerminalSystemLangId A unique number identifying the system language for the POS
terminals. This language is used to display all the components
of terminal, such as the Menu, Jump Bars, etc. The selected
language gets added to the Regional and Language options of
the POS terminal.
ServerDateFormat Indicates the date format configured in the server.
TimeOffset The difference in time (hours and minutes) between
coordinated universal time and configured enterprise time
zone.
Example: (GMT-06:00) for Central Time Zone.
TenantId A system-generated or manually entered numerical value to
identify the tenants.
BuyContextId The context ID configured to interact with IG Kiosk 3.x (through
Agilysys Platform).
This field is Not Applicable.
IGBuyUrl IG Buy CBO URL.

GetEmployees
This API is called to get employee info.
Method: POST
URL: https://<environment>/GetEmployees

Sample Request
No Parameters

Sample Response
[
{

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 237
 IGPOS API | Reference Guide

"EmployeeId": "string",
"Password": "string",
"CardNumber": "string",
"DefaultJobCode": 0,
"JobCodes": [
0
],
"HasPassword": true,
"KeyPadLocation": 0,
"DefaultLanguage": "string",
"EmpLangId": "string"
}
]

□ Refer to the following table for the field descriptions:

Field Description
EmployeeId A unique number [1 to 999,999,999] assigned for an employee.
Password A four-digit numerical value that allows employees to sign-in to
the POS terminal. Employees can sign-in without typing the
password if it is set to zero.
CardNumber The same employee ID is assigned to the card number by
default. However, being an editable field, card number can be
altered if required.
DefaultJobCode The default Job Code for the employee is always blank. An
offline job code is mandatory as the employee’s record cannot
be saved until a job code is assigned.
JobCodes Represents the designated Job Codes of the employee.
HasPassword ▪ True - The employee has the password to login.
▪ False - The employee does not have the password to
login.
KeyPadLocation A desired location (left-hand side or right-hand side) to place
the keypad and order display in the POS terminal.
DefaultLanguage The default language set for the employee. The POS terminal
will display this language right from the employee’s sign-in
page.
EmpLangId A unique value assigned to indicate the primary language of
the employee.

GetCheckInfo
This API is called to get check information for a given check number.
Method: POST
URL: https://<environment>/GetCheckInfo

Sample Request
{
"checkNumber": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 238
 IGPOS API | Reference Guide

"guid": "string"
}

□ Refer to the following table for descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

GetClosedCheckInfoDispatcher
API to get closed check information from Dispatcher for a given check number.
Method: POST
URL: https://<environment>/GetClosedCheckInfoDispatcher

Sample Request
{
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

GetCheckTypeConfiguration
This API is called to get check type configuration.
Method: POST

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 239
 IGPOS API | Reference Guide

URL: https://<environment>/GetCheckTypeConfiguration

Sample Request
{
"checkType": "string"
}

□ Refer to the following table for description:

Field Description
checkType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.

Sample Response
{
"Id": 0,
"SecurityLevel": 0,
"PriceLevelId": 0,
"DiscountId": 0,
"CoverCount": 0,
"RoundingConfiguration": {
"RoundType": 0,
"RoundBasis": 0
},
"IncludeIRSReporting": true,
"TaxGroup": [
{
"Id": 0,
"TaxIds": "string"
}
],
"GratuityRevenueCategories": [
{
"GratuityId": 0,
"RevenueCategoryIds": [
0
]
}
],
"GratuityTaxes": [
{
"GratuityId": 0,
"TaxIds": [
0
]
}
],
"VATRevenueCategories": [

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 240
 IGPOS API | Reference Guide

{
"TaxId": 0,
"RevenueCategoryId": 0
}
],
"VATGratuities": [
{
"TaxId": 0,
"GratuityId": 0
}
],
"TaxOverrideType": 0,
"IsTenderAllowed": true,
"PromptForTable": true,
"PromptForCovers": true,
"PromptForServer": true,
"PromptForRoom": true,
"IsTaxIncluded": true,
"BackColor": 0,
"ForeColor": 0
}

□ Refer to the following table for field descriptions:

Field Description
Id Indicates the check type ID.
SecurityLevel A 0-10 level security system that ensures only authorized
employees perform the restricted operations, such as applying
discounts to checks, performing manager overrides, etc.
PriceLevelId A system-generated or manually entered unique value to
identify the price level.
DiscountId A system generated or user typed unique number in the range
of [1-9999] to identify the discount at the POS terminal.
CoverCount A unique number indicating the cover count value. The default
value is 0 and it supports up to 999.
RoundingConfiguration
RoundType Denotes the type of rounding - rounds up or rounds down. The
check amount gets rounded to the nearest value.
RoundBasis Denotes the unit of money for which the check rounds to. For
example, in U.S., typing 1 rounds the penny while typing 50000
rounds to $500.00
IncludeIRSReporting ▪ True - The sales from the appropriate tender are included
in IRS Tip and IRS Tip by profit center reports.
▪ False - The sales from the appropriate tender are not
included in IRS Tip and IRS Tip by profit center reports.
TaxGroup
Id A system generated or manually typed unique number within
the range of [1-255] to identify the tax group.
TaxIds The tax IDs that are mapped to the check type.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 241
 IGPOS API | Reference Guide

Field Description
GratuityRevenueCategories
GratuityId A unique numerical value identifying the gratuity.
RevenueCategoryIds A system generated or manually entered unique value in the
range of [1-99] to identify the revenue category.
GratuityTaxes
GratuityId A unique numerical value representing the gratuity.
TaxIds A system generated or manually typed unique number within
the range of [1-255] to identify the tax levied on the check.
VATRevenueCategories
TaxId A system generated or manually typed unique number within
the range of [1-255] to identify the tax levied on the check.
RevenueCategoryId A system generated or manually entered unique value in the
range of [1-99] to identify the revenue category.
VATGratuities
TaxId A system generated or manually typed unique number within
the range of [1-255] to identify the tax levied on the check.
GratuityId A unique numerical value identifying the gratuity.
TaxOverrideType Denotes any one of the three available taxoverride type.
▪ None: to accept (and not override) an item’s non-tax-
included or tax-included pricing.
▪ Tax - Inclusive: to force item prices to be tax-included for
this check type.
▪ Non-Tax-Inclusive: to force item prices to be tax-free for
this check type.
IsTenderAllowed ▪ True - A tender is said to be unrestricted for tendering its
check type to all tenders.
▪ False - A tender is said to be restricted for tendering its
check type to specific tenders.
PromptForTable A prompt for a table number before ordering.
PromptForCovers A prompt for the number of guests before ordering.
PromptForServer A prompt for a server number (or a card swipe) before
ordering.
PromptForRoom A prompt for a room number before ordering. This is referred to
as pre-tendering to a room, folio, generic authorization (GA),
and so on. The room or account information is captured at the
start of the transaction and stored in the check record until the
check is ready to be tendered. The account or room
information is redisplayed for confirmation before the check is
tendered.
Depending on the settings of terminal options 116-118, this
prompt can also be used for
▪ #116 - Prompt for data entry instead of room
▪ #117 - Prompt for GA Account (Type 1) instead of room.
When pre-tendering to generic authorization, the price level

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 242
 IGPOS API | Reference Guide

Field Description
of the check may be determined by the price level
assigned to the GA type for that account.
▪ #118 - Prompt for folio number (verification code 6) instead
of room.
IsTaxIncluded ▪ True - Tax is included for the listed items in the check.
▪ False - Tax is not included for the listed items in the check.
BackColor Displays the background color of the selected button. Multiple
buttons can be selected, and the background color can be
changed in one-go by choosing the desired color available in
the drop-down menu.
NOTE: The available colors vary according to the selected
theme.
ForeColor Displays the font color of the selected button. Multiple buttons
can be selected, and the font color can be changed in one-go
by choosing the desired color available in the drop-down menu.
NOTE: The available colors vary according to the selected
theme.

GetMenuItemsBySkuId
This API is called to get menu item information by SKU ID.
Method: POST
URL: https://<environment>/GetMenuItemsBySkuId

Sample Request
{
"SkuCode": "string",
"SearchType": "string"
}

□ Refer to the following table for descriptions:

Field Description
SkuCode Alphanumeric characters within a range of [1-30] assigned to
the item that can be scanned by the barcode reader.
SearchType Mentions the search type whether it is an exact match or
contains the string/value.

Sample Response
{
"SkuCode": "string",
"ActiveCheckType": "string",
"SearchType": "string",
"ObjectId": "string",
"ItemPrice": "string",
"Type": 0,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 243
 IGPOS API | Reference Guide

"FilteredItemIds": [
0
],
"FilteredCouponIds": [
0
],
"FilteredDiscountIds": [
0
]
}

□ Refer to the following table for descriptions:

Field Description
SkuCode Alphanumeric characters within a range of [1-30] assigned to
the item that can be scanned by the barcode reader.
ActiveCheckType Represents the check type of the selected check.
SearchType Mentions the search type whether it is an exact match or
contains the string/value.
ObjectId A unique numerical value to identify the object.
ItemPrice The price of items listed in the check.
Type It refers to the object type like Item, Discount, or Coupon.
FilteredItemIds Item IDs that are filtered according to a specific category.
FilteredCouponIds Coupon IDs that are filtered according to a specific category.
FilteredDiscountIds Discount IDs that are filtered according to a specific category.

GetAspenDiscounts
This API is called to get the discounts associated with a tier level.
Method: POST
URL: https://<environment>/GetAspenDiscounts

Sample Request
{
"id": "string"
}

□ Refer to the following table for the description:

Field Description
id Aspen account number to retrieve the associated discounts.

Sample Response
[
{
"Id": "string",
"Description": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 244
 IGPOS API | Reference Guide

"TransactionNumber": "string",
"RFID": "string",
"PassMedia": "string",
"CompanyCode": "string"
}
]

□ Refer to the following table for descriptions:

Field Description
Id Discount IDs associated with the Aspen account.
Description The description for the discount to be applied.
TransactionNumber For future use.
RFID For future use.
PassMedia For future use.
CompanyCode For future use.

GetModifiers
This API is called to get modifier information.
Method: POST
URL: https://<environment>/GetModifiers

Sample Request
{
"Id": "string"
}

□ Refer to the following table for descriptions:

Field Description
Id Represents the modifier IDs.

Sample Response
[
{
"Id": "string",
"ObjectType": "string",
"Content": "string",
"Action": "string",
"ChoiceGroupId": "string",
"IsContainsModifier": true,
"MinChoice": 0,
"MaxChoice": 0
}
]

□ Refer to the following table for descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 245
 IGPOS API | Reference Guide

Field Description
Id Represents a unique identity value for the modifier.
ObjectType For future use.
Content For future use.
Action For future use.
ChoiceGroupId A unique numerical value within a range of [1-99999] to identify
a choice group.
IsContainsModifier ▪ True - The choice group contains modifiers.
▪ False - The choice group does not contain modifiers.
MinChoice Indicates the minimum number (up to 20) of modifiers that can
be selected within the choice group.
MaxChoice Indicates the maximum number (up to 20) of modifiers that can
be selected within the choice group.

GetMembershipInfo
This API is called to get membership information.
Method: POST
URL: https://<environment>/GetMembershipInfo

Sample Request
{
"MembershipCode": "string"
}

□ Refer to the following table for descriptions:

Field Description
MembershipCode Indicates the membership code provided by the Visual One
PMS system. The check type of a transaction uses this code to
verify against the code set in Visual One. The code can be
alphanumeric, supporting up to 20 characters.

Sample Response
{
"MembershipId": 0,
"MembershipCode": "string",
"MembershipDetails": [
{
"ProfitCenterId": 0,
"CheckTypeId": 0
}
]
}

□ Refer to the following table for descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 246
 IGPOS API | Reference Guide

Field Description
MembershipId A system generated numerical value assigned to every
membership.
MembershipCode Indicates the membership code provided by the Visual One
PMS system. The check type of a transaction uses this code to
verify against the code set in Visual One. The code can be
alphanumeric, supporting up to 20 characters.
Example: SILVER2
MembershipDetails
ProfitCenterId A system generated or manually entered unique numerical
value within the range of [1-999] assigned to the profit center.
With some of the Property Management System (PMS)
interfaces, only up to two-digit numbers (99) are usable.
CheckTypeId A unique identification number for the check type.

GetEmployeeInfobyId
This API is called to get employee information.
Method: POST
URL: https://<environment>/GetEmployeeInfobyId

Sample Request
{
"employeeId": 0
}

□ Refer to the following table for descriptions:

Field Description
employeeId A unique number [1 to 999,999,999] assigned for an employee.

Sample Response
{
"EmployeeId": "string",
"Password": "string",
"CardNumber": "string",
"DefaultJobCode": 0,
"JobCodes": [
0
],
"HasPassword": true,
"KeyPadLocation": 0,
"DefaultLanguage": "string",
"EmpLangId": "string"
}

□ Refer to the following table for descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 247
 IGPOS API | Reference Guide

Field Description
EmployeeId A unique number [1 to 999,999,999] assigned for an employee.
Password A four-digit numerical value that allows employees to sign-in to
the POS terminal. Employees can sign-in without typing the
password if it is set to zero.
CardNumber The same employee ID is assigned to the card number by
default. However, being an editable field, card number can be
altered if required.
DefaultJobCode The default Job Code for the employee is always blank. An
offline job code is mandatory as the employee’s record cannot
be saved until a job code is assigned.
JobCodes Represents the designated Job Codes of the employee.
HasPassword ▪ True - The employee has the password to login.
▪ False - The employee does not have the password to
login.
KeyPadLocation A desired location (left-hand side or right-hand side) to place
the keypad and order display in the POS terminal.
DefaultLanguage The default language set for the employee. The POS terminal
will display this language right from the employee’s sign-in
page.
EmpLangId A unique value assigned to indicate the primary language of
the employee.

GetCommonInfo
This API is called to get common information by language.
Method: POST
URL: https://<environment>/GetCommonInfo

Sample Request
{
"LangId": "string"
}

□ Refer to the following table for descriptions:

Field Description
LangId A unique value to identify the language. The primary and
secondary language can be set according to the preferences
and terminal uses this primary language as a default language.

Sample Response
{
"CheckNumberingCode": 0,
"CurrencyCultureName": "string",
"DateTimeCulture": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 248
 IGPOS API | Reference Guide

"CurrencySymbol": "string",
"VatModeFlag": true,
"HyattGoldPassFlag": true,
"InclusiveGratuityFlag": true,
"CasinoManagementFlag": true,
"FoodServiceLoyaltyFlag": true,
"TimeZone": "string",
"LanguageId": "string",
"LanguageName": "string",
"DecimalDigits": 0,
"EnableReprintCount": true,
"TerminalDefaultLangId": "string",
"TerminalSystemLangId": "string",
"ServerDateFormat": "string",
"TimeOffset": "string",
"TenantId": 0,
"BuyContextId": "string",
"IGBuyUrl": "string"
}

□ Refer to the following table for descriptions:

Field Description
CheckNumberingCode Defines the numbering sequence of checks for all enterprises
within IG POS system.
CurrencyCultureName The name of the currency culture mapped to the store.
Example: en-us.
DateTimeCulture Indicates the date and time format for the enterprise.
CurrencySymbol Indicates the currency symbol for the enterprise and this
symbol appears in all currency fields of the Universal Desktop
and reports.
VatModeFlag ▪ True - The check excludes all other taxes except of taxes
configured under VAT Revenues and VAT Gratuities tab.
▪ False - The check includes other taxes as well.
HyattGoldPassFlag ▪ True - The Hyatt Gold Pass configuration is enabled.
▪ False - The Hyatt Gold Pass configuration is disabled.
InclusiveGratuityFlag ▪ True - The tip is added in the price of the item, and do not
appear separately on the receipts.
▪ False - The gratuity appears separately on the receipts.
CasinoManagementFlag ▪ True - The casino loyalty configuration is enabled.
▪ False - The casino loyalty configuration is disabled.
FoodServiceLoyaltyFlag ▪ True - The food service loyalty configuration is enabled.
▪ False - The food service loyalty configuration is disabled.
TimeZone Indicates the time zone in which the schedule runs. By default,
the system takes the server time zone. It must be set to local
time zone.
LanguageId A unique value to identify the language. The primary and
secondary language can be set according to the preferences
and terminal uses this primary language as a default language.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 249
 IGPOS API | Reference Guide

Field Description
LanguageName Denotes the name of the language.
DecimalDigits A customization option to configure the currency’s decimal
digit.
EnableReprintCount Enabling this checkbox allows user to print reprint check count
on duplicate receipts.
TerminalDefaultLangId A unique number identifying the default language of the POS
terminal. Employee sees this language at the sign-on screen
and all the errors (before or after sign-up) are displayed in this
language.
TerminalSystemLangId A unique number identifying the system language for the POS
terminals. This language is used to display all the components
of terminal, such as the Menu, Jump Bars, etc. The selected
language gets added to the Regional and Language options of
the POS terminal.
ServerDateFormat Indicates the date format configured in the server.
TimeOffset The difference in time (hours and minutes) between
coordinated universal time and configured enterprise time
zone.
Example: (GMT-06:00) for Central Time Zone.
TenantId A system-generated or manually entered numerical value to
identify the tenants.
BuyContextId The context ID configured to interact with IG Kiosk 3.x (through
Agilysys Platform).
This field is Not Applicable.
IGBuyUrl IG Buy CBO URL.

GetCustomerInfo
This API is called to get customer info.
Method: POST
URL: https://<environment>/GetCustomerInfo

Sample Request
{
"CustomerId": "string"
}

□ Refer to the following table for the description:

Field Description
CustomerId A unique identification number assigned to a customer.

Sample Response
{

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 250
 IGPOS API | Reference Guide

"Id": "string",
"Name": "string",
"Enterprises": [
{
"Id": "string",
"Name": "string",
"Divisions": [
{
"Id": "string",
"Name": "string",
"Stores": [
{
"Id": "string",
"Name": "string",
"Terminals": [
{
"Id": "string"
}
]
}
]
}
],
"Profiles": [
{
"Id": "string",
"Name": "string"
}
]
}
]
}

□ Refer to the following table for descriptions:

Field Description
Id A unique identification number assigned to a customer.
Name A string value indicating the name of the customer.
Enterprises
Id A unique identification number assigned to the enterprise.
Name A string value representing the name of the enterprise.
Divisions
Id A unique identification number assigned to the division.
Name A string value representing the name of the division.
Stores
Id A unique identification number assigned to the store.
Name A string value representing the name of the store.
Terminals

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 251
 IGPOS API | Reference Guide

Field Description
Id A numerical value within a range of [1-9999] that gives a
unique identity to the POS terminal.
Profiles
Id A unique value assigned to the customer’s profile.
Name A string value representing the name of the customer profile.

GetCoupons
This API is called to get available coupons.
Method: POST
URL: https://<environment>/GetCoupons

Sample Request
{
"couponId": 0,
"tenderId": 0
}

□ Refer to the following table for descriptions:

Field Description
couponId A unique number identifying the coupon.
tenderId A unique and modifiable value in the enterprise level within a
range of [1-255] identifying a tender. Some of the PMS
interfaces will not permit users to use the check types whose
ID is greater than nine [9] when Tender ID number is higher
than ninety-nine [99].

Sample Response
[
{
"Id": 0,
"IsPercentage": true,
"CouponSKUCode": "string",
"TenderId": 0,
"IsOpen": true,
"Value": 0,
"MaxValue": 0,
"ProfitCenterGroupId": 0,
"AccountNumber": "string",
"ThresholdAmount": 0,
"CanAddExtraText": true
}
]

□ Refer to the following table for descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 252
 IGPOS API | Reference Guide

Field Description
Id The coupon ID to be applied.
IsPercentage ▪ True - Calculates discount on a percent basis.
▪ False - Calculates discount on an amount basis.
CouponSKUCode An alphanumeric coupon code (printed on receipts) with a
maximum of 30 characters that enables users to apply a
discount to the check by scanning the barcode.
TenderID A unique and modifiable value in the enterprise level within a
range of [1-255] identifying a tender. Some of the PMS
interfaces will not permit users to use the check types whose
ID is greater than nine [9] when Tender ID number is higher
than ninety-nine [99].
IsOpen ▪ True - Indicates it is an open coupon. The open coupons
do not have a fixed value, and it can be used for any value
till the maximum limit.
▪ False - Indicates it is not an open coupon.
Value The value of the coupon.
MaxValue The maximum amount till which an open coupon can be used.
ProfitCenterGroupId A system generated or manually entered unique numerical
value within the range of [1-999] assigned to the profit center
group. With some of the Property Management System (PMS)
interfaces, only up to two-digit numbers (99) are usable.
AccountNumber The posting account number to which the transaction details
are sent after the coupon is applied and check is closed. A
maximum of 12 alphanumeric characters are supported.
ThresholdAmount A minimum eligibility amount to use the coupons. The coupon
is applicable only when the check amount is greater than the
threshold amount. Range: 9999999.99 - 9999999.99
CanAddExtraText ▪ True - Extra data is requested from users for this coupon.
▪ False - Extra data is not requested from users.

GetMenuItems
This API is called to get menu items.
Method: POST
URL: https://<environment>/GetMenuItems

Sample Request
{
"itemId": "string"
}

□ Refer to the following table for field description.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 253
 IGPOS API | Reference Guide

Field Description
itemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.

Sample Response
[
{
"Id": 0,
"ItemNumber": "string",
"ProductClassId": 0,
"IsRestrictedProductClass": true,
"IsRestricted": true,
"GroupId": 0,
"SecurityId": 0,
"KitchenVideoDepartmentId": 0,
"KitchenVideoCategoryId": 0,
"KitchenVideoCookTime": 0,
"RevenueCategoryId": 0,
"TaxGroupId": 0,
"IsWeighted": true,
"TareWeight": 0,
"IsOpenPrice": true,
"IsItemActive": true,
"IsTaxIncluded": true,
"IsPrintOnCheck": true,
"IsDiscountable": true,
"IsVoidable": true,
"ScheduleId": 0,
"AllowPriceOverride": true,
"IsOpenNamePrompt": true,
"AllowSpecialInstruction": true,
"IsGiftCardItem": true,
"MaxCoverCount": 0,
"ChoiceGroup": [
{
"Id": 0,
"Name": "string",
"MinChoice": 0,
"MaxChoice": 0,
"Mods": [
{
"Id": 0
}
],
"ModifierSeq": [
0
]
}
],
"PriceLevelCost": {
"additionalProp1": {

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 254
 IGPOS API | Reference Guide

"code": 0,
"text": 0
},
"additionalProp2": {
"code": 0,
"text": 0
},
"additionalProp3": {
"code": 0,
"text": 0
}
},
"BaseCost": 0,
"SKUCode": [
"string"
],
"IsAlcoholRestricted": true,
"IsTobaccoRestricted": true,
"ChoiceGroupSeq": [
0
],
"RptCatId": 0,
"PackageIds": [
0
]
}
]

□ Refer to the following table for the field descriptions:

Field Description
Id A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
ItemNumber A numerical value assigned to an item in the store.
ProductClassId A system generated or manually entered unique number within
the range of [1-9999] that identifies the product class of an
item. The ID of the product class must be unique in the
enterprise.
IsRestrictedProductClass ▪ True - The item belongs to a restricted product class.
▪ False - The item does not belong to a restricted product
class.
IsRestricted ▪ True - Third-party restrictions is applied when ordering the
product class at the POS terminal.
▪ False - No restrictions when ordering product class at the
POS terminal.
GroupId Item group ID
SecurityId Security level ID. The item can be ordered only by employees
above this security level

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 255
 IGPOS API | Reference Guide

Field Description
KitchenVideoDepartmentId A system generated or a manually entered unique number in
the range of [1-999] identifying the specific kitchen
workstations.
KitchenVideoCategoryId A system generated or manually entered unique number in the
range of [1-999] characters that maps go QSR term and item
category. These categories correspond to the course that can
configured using QST’s TS-Connect Editor.
▪ 1 - Appetizer
▪ 2 - Soup-Salad
▪ 3 - Entrée
▪ 4 - Dessert
▪ 5 - Bar
KitchenVideoCookTime The configured cook time for the item that is displayed in the
kitchen video.
RevenueCategoryId A system generated or manually entered unique value in the
range of [1-99] to identify the revenue category.
TaxGroupId Id of the applicable Tax group
IsWeighted ▪ True - The item’s price depend on its weight.
▪ False - The item’s price does not depend on its weight.
TareWeight On checking the Is Sold by Weight check box, Tare Weight
field gets activated. This field supports a maximum value up to
99.9999.
IsOpenPrice ▪ True - The item is an open priced item.
▪ False - The item is not an open priced item.
IsItemActive ▪ True - The item is available to order.
▪ False - The item is 86’ed.
IsTaxIncluded ▪ True - Tax is included for the listed items in the check.
▪ False - Tax is not included for the listed items in the check.
IsPrintOnCheck ▪ True - Prints all items, even zero-priced items on the
check.
▪ False - Zero-Priced items are not printed in the check.
IsDiscountable ▪ True - The check or the items listed in the check are
eligible for the discount.
▪ False - The check or the items listed in the check are not
eligible for the discount.
IsVoidable ▪ True - A user can void an item.
▪ False - A user cannot void an item.
ScheduleId ID of the Price level Schedule mapped to the item.
AllowPriceOverride ▪ True - Overrides the scanned price of a retail item.
▪ False - Does not override the scanned price of a retail
item.
IsOpenNamePrompt ▪ True - The item is an open named item. For such items,
the name must be entered while ordering.
▪ False - The item is not an open named item.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 256
 IGPOS API | Reference Guide

Field Description
AllowSpecialInstruction ▪ True - Special instructions can be sent to the kitchen with
regards to cooking instructions, customer requests, and
others.
▪ False - No special instructions can be sent to the kitchen.
IsGiftCardItem ▪ True - The item is a gift card sale item.
▪ False - The item is not a gift card sale item.
MaxCoverCount Indicates the maximum number of people that can be served in
a meal period.
ChoiceGroup
Id A unique numerical value within a range of [1-99999] to identify
a choice group.
Name A string value that indicates the name of the choice group.
MinChoice Indicates the minimum number (up to 20) of modifiers that can
be selected within the choice group.
MaxChoice Indicates the maximum number (up to 20) of modifiers that can
be selected within the choice group.
Mods
Id Represents a unique identity value for the modifier.
ModifierSeq For future use.
PriceLevelCost
additionalProp1
code For future use.
text For future use.
additionalProp2
code For future use.
text For future use.
additionalProp3
code For future use.
text For future use.
BaseCost The base cost for weighed items.
SKUCode Alphanumeric characters within a range of [1-30] assigned to
the item that can be scanned by the barcode reader.
IsAlcoholRestricted ▪ True - Items that belong to Alcohol product class or
revenue category are restricted for guests.
▪ False - Items that belong to Alcohol product class or
revenue category are available for guests.
IsTobaccoRestricted ▪ True - Items that belong to tobacco product class or
revenue category are restricted for guests.
▪ False - Items that belong to tobacco product class or
revenue category are available for guests.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 257
 IGPOS API | Reference Guide

Field Description
ChoiceGroupSeq The sequence in which choice groups must be displayed while
ordering an item.
RptCatId Report category ID.
PackageIds A unique value identifying the package.

GetPackages
This API is called to get package information.
Method: POST
URL: https://<environment>/GetPackages

Sample Request
{
"ComboId": "string"
}

□ Refer to the following table for field descriptions:

Field Description
ComboId ID of the package whose details are being looked up.

Sample Response
{
"ComboId": 0,
"TotalPrice": 0,
"ComboItems": "string",
"AutoPackage": 0,
"Priority": 0
}

□ Refer to the following table for field descriptions:

Field Description
ComboId ID of the package whose details are being looked up.
TotalPrice Total Price of the package.
ComboItems Items within the package.
AutoPackage ▪ True - Indicates that an automatic packaging is applicable
for this package. When the items that belong to the same
package are added as individual items to a check, they are
recognized, and the respective package is formed.
▪ False - The automatic packaging is not applicable for this
package. Even when the items that belong to the same
package are added to a check, they will not be recognized
as a package and will remain as individual items.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 258
 IGPOS API | Reference Guide

Field Description
Priority It is mandatory for a package to have a priority assigned to it. 1
is the highest priority a package can have. Multiple packages
can have the same priority.

GetProfitCenterInfo
This API is called to get profit center information.
Method: POST
URL: https://<environment>/GetProfitCenterInfo

Sample Request
{
"ProfitCenterId": "string"
}

□ Refer to the following table for field description.

Field Description
ProfitCenterId A system generated or manually entered unique numerical
value within the range of [1-999] assigned to the profit center.
With some of the Property Management System (PMS)
interfaces, only up to two-digit numbers (99) are usable.

Sample Response
{
"Id": 0,
"SourcePropertyCode": "string",
"CreditCardLimits": {
"AgencyThreshold": 0,
"AuthThreshold": 0,
"PrintingThreshold": 0
},
"TipLimit": {
"LimitType": 0,
"MaxPercentage": 0
},
"Tables": [
{
"Id": 0,
"TableText": "string",
"SeatCount": 0,
"IsBooth": true,
"IsPrivate": true,
"IsOutside": true,
"IsSmoking": true,
"HasView": true,
"IsVip": true
}

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 259
 IGPOS API | Reference Guide

],
"PedId": "string",
"CountryCode": 0,
"DocLinesAdvance": 0,
"DocLinesPerPage": 0,
"PaymentProcessing": {
"Id": 0,
"Configuration": [
{
"Key": "string",
"Value": "string",
"HighLevelFlag": true
}
],
"Type": 0,
"UseForRGuestPayFlag": true
},
"ProfitCenterGroups": [
0
],
"PrimaryFloorPlanId": 0,
"PrimaryLanguage": "string",
"SecondaryLanguage": "string",
"PayAtTableUrl": "string"
}

□ Refer to the following table for the field descriptions:

Field Description
Id A system generated or manually entered unique numerical
value within the range of [1-999] assigned to the profit center.
With some of the Property Management System (PMS)
interfaces, only up to two-digit numbers (99) are usable.
SourcePropertyCode A code that represents the source property. This property that
sends the cross-property charge.
CreditCardLimits
AgencyThreshold This is the credit card dollar amount that the customer is willing
to risk. Charges at this amount or lower are not sent to the
credit card agency for approval. This option is not supported for
Agilysys Pay credit cards.
AuthThreshold At or below this amount, the prompt at the terminal to call for
voice auth does not appear. This option is not supported for
Agilysys Pay credit cards.
PrintingThreshold At or below this amount, no sales draft is printed. In addition to
bypassing the printing of credit card drafts, this setting also
applies to bypassing the signature prompt on an Agilysys Pay
signature capture-capable payment device and signature
capture application.
Support for bypassing the signature capture prompt only
applies to tenders using Tender Verification Code 144 and
Credit Card Payment via Agilysys Pay Interface.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 260
 IGPOS API | Reference Guide

Field Description
When Terminal Option 523 (Enable signature capture on the
external payment device) is enabled for OnDemand, the
application requests via the Accept function. Not supported for
Pay at Table.
TipLimit
LimitType A string value that indicates the type of the limit type
MaxPercentage The maximum tip percentage that can be configured. This field
gets activated when the Warn When Exceed, Manager
Override when Exceeded, or Do not Allow when Exceed
options are selected.
Tables
Id A system generated or manually entered unique value up to
999 that identifies a table.
TableText A string value up to 50 characters indicating the text associated
with the table or the name assigned to the table.
SeatCount Indicates the total seat count available in all tables. The
maximum count is 9,999.
IsBooth ▪ True - It is a booth table.
▪ False - It is not a booth table.
IsPrivate ▪ True - The table is private.
▪ False - The table is not private.
IsOutside ▪ True - It is an outdoor seat.
▪ False - It is an indoor seat.
IsSmoking ▪ True - Smoking is allowed in the table.
▪ False - Smoking is not allowed in the table.
HasView ▪ True - The table has a view.
▪ False - The table does not have a view.
IsVip ▪ True - Indicates table is reserved for VIP seating.
▪ False - Indicates table is not reserved for VIP seating.
PedId ID of the pin entry device.
CountryCode Denotes the country and phone number codes.
DocLinesAdvance Indicates the number of blank lines the check advances before
the first line prints. The default is 5 lines.
NOTE: This field is for hard checks only.
DocLinesPerPage Indicates the maximum number of lines that a check includes.
After this line, it forces a new page to continue. The default is
40 lines.
PaymentProcessing
Id A system generated value with a maximum of 255 characters
identifies the processed payments. This value should be
unique in the enterprise level.
Configuration

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 261
 IGPOS API | Reference Guide

Field Description
Key Keys in payment processing configuration for connecting to the
payment gateways.
Value Values corresponding to the keys in payment processing
configuration for connecting to the payment gateways.
HighLevelFlag For future use.
Type The payment processing record type indicating the payment
gateway such as FreedomPay, Shift4, and others.
UseForRGuestPayFlag For future use.
ProfitCenterGroups Indicates the profit centers assigned to a profit center group.
PrimaryFloorPlanId A unique value that identifies the primary floor plan for the profit
center.
PrimaryLanguage Displays the language that is selected as primary. Primary
language is used in printing the receipts.
SecondaryLanguage Shows the selected secondary language. This language is
used when translating the items, modifiers, and special
instructions that appear on the receipt.
PayAtTableUrl This URL points to the system where the pay at table service is
running.

GetTableDetails
This API is called to get table information.
Method: POST
URL: https://<environment>/GetTableDetails

Sample Request
{
"ProfitCenterId": "string"
}

□ Refer to the following table for field description.

Field Description
ProfitCenterId A system generated or manually entered unique numerical
value within the range of [1-999] assigned to the profit center.
With some of the Property Management System (PMS)
interfaces, only up to two-digit numbers (99) are usable.

Sample Response
[
{
"Id": 0,
"TableText": "string",
"SeatCount": 0,
"IsBooth": true,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 262
 IGPOS API | Reference Guide

"IsPrivate": true,
"IsOutside": true,
"IsSmoking": true,
"HasView": true,
"IsVip": true
}
]

□ Refer to the following table for field descriptions:

Field Description
Id A system generated or manually entered unique value up to
999 that identifies a table.
TableText A string value up to 50 characters indicating the text associated
with the table or the name assigned to the table.
SeatCount Indicates the total seat count available in all tables. The
maximum count is 9,999.
IsBooth ▪ True - It is a booth table.
▪ False - It is not a booth table.
IsPrivate ▪ True - The table is private.
▪ False - The table is not private.
IsOutside ▪ True - It is an outdoor seat.
▪ False - It is an indoor seat.
IsSmoking ▪ True - Smoking is allowed in the table.
▪ False - Smoking is not allowed in the table.
HasView ▪ True - The table has a view.
▪ False - The table does not have a view.
IsVip ▪ True - Indicates table is reserved for VIP seating.
▪ False - Indicates table is not reserved for VIP seating.

GetTableDetailsForProfitCenters
API to get table information by profit center.
Method: POST
URL: https://<environment>/GetTableDetailsForProfitCenters

Sample Request
{
"ProfitCenterList": []
}

□ Refer to the following table for field descriptions:

Field Description
ProfitCenterList List of profit centers for which table details are being retrieved.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 263
 IGPOS API | Reference Guide

Sample Response
[
{
"Id": 0,
"TableText": "string",
"SeatCount": 0,
"IsBooth": true,
"IsPrivate": true,
"IsOutside": true,
"IsSmoking": true,
"HasView": true,
"IsVip": true
}
]

□ Refer to the following table for field descriptions:

Field Description
Id A system generated or manually entered unique value up to
999 that identifies a table.
TableText A string value up to 50 characters indicating the text associated
with the table or the name assigned to the table.
SeatCount Indicates the total seat count available in all tables. The
maximum count is 9,999.
IsBooth ▪ True - It is a booth table.
▪ False - It is not a booth table.
IsPrivate ▪ True - The table is private.
▪ False - The table is not private.
IsOutside ▪ True - It is an outdoor seat.
▪ False - It is an indoor seat.
IsSmoking ▪ True - Smoking is allowed in the table.
▪ False - Smoking is not allowed in the table.
HasView ▪ True - The table has a view.
▪ False - The table does not have a view.
IsVip ▪ True - Indicates table is reserved for VIP seating.
▪ False - Indicates table is not reserved for VIP seating.

GetRevenueCategoryDetails
This API is called to get revenue category details.
Method: POST
URL: https://<environment>/GetRevenueCategoryDetails

Sample Request
{
"RevenueCategoryId": "string"

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 264
 IGPOS API | Reference Guide

□ Refer to the following table for field description.

Field Description
RevenueCategoryId The revenue category ID for which details need to be retrieved.

Sample Response
[
{
"Id": 0,
"GroupId": "string",
"IRSFlag": true,
"SalesAmount": 0,
"DiscountAmount": 0,
"ExclusiveTaxAmount": 0,
"NoTaxNetSales": 0,
"SalesAmountTaxInclusive": 0,
"TaxIclusiveItemDiscountAmount": 0,
"InclusiveTaxAmount": 0
}
]

□ Refer to the following table for field descriptions:

Field Description
Id A system generated or manually entered unique value in the
range of [1-99] to identify the revenue category.
GroupId For future use.
IRSFlag ▪ True - The category is included in the IRS reports.
▪ False - The category is not included in the IRS reports.
SalesAmount For future use.
DiscountAmount For future use.
ExclusiveTaxAmount For future use.
NoTaxNetSales For future use.
SalesAmountTaxInclusive For future use.
TaxInclusiveItemDiscountAmount For future use.
InclusiveTaxAmount The amount of inclusive tax calculated.

GetTerminalGroup
This API is called to get terminal group details.
Method: POST
URL: https://<environment>/GetTerminalGroup

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 265
 IGPOS API | Reference Guide

Sample Request
{
"ObjectType": "string"
}

□ Refer to the following table for field description.

Field Description
ObjectType The type of terminal group related detail that needs to be
retrieved. It includes:
▪ AdditionalConfiguration
▪ CheckType
▪ Jobcode
▪ MealPeriod
▪ MealPeriodStart
▪ ProfitCenterDayPartConfig
▪ ScreenTransition
▪ Tender
▪ TenderGroup

Sample Response
{
"TerminalId": 0,
"TerminalOptionGroupId": 0,
"TerminalGroupId": 0,
"ObjectType": 0,
"CheckTypeFlags": [
{
"PriceLevelId": 0,
"SecurityLevel": 0,
"TaxOverrideType": 0,
"IsTenderAllowed": true,
"PromptForTable": true,
"PromptForCovers": true,
"PromptForServer": true,
"PromptForRoom": true
}
],
"ObjectAndLinkedIds": [
{
"ObjectId": "string",
"LinkedId": 0
}
]
}

□ Refer to the following table for field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 266
 IGPOS API | Reference Guide

Field Description
TerminalId A numerical value within a range of [1-9999] that gives a
unique identity to the POS terminal.
TerminalOptionGroupId For future use.
TerminalGroupId A unique value in the enterprise level identifying the terminal
group.
ObjectType The type of terminal group related detail that needs to be
retrieved. It includes:
▪ AdditionalConfiguration
▪ CheckType
▪ Jobcode
▪ MealPeriod
▪ MealPeriodStart
▪ ProfitCenterDayPartConfig
▪ ScreenTransition
▪ Tender
▪ TenderGroup
CheckTypeFlags
PriceLevelId A system-generated or manually entered unique value to
identify the price level.
SecurityLevel A 0-10 level security system that ensures only authorized
employees perform the restricted operations, such as applying
discounts to checks, performing manager overrides, etc.
TaxOverrideType Denotes any one of the three available taxoverride type.
▪ None: to accept (and not override) an item’s non-tax-
included or tax-included pricing.
▪ Tax - Inclusive: to force item prices to be tax-included for
this check type.
▪ Non-Tax-Inclusive: to force item prices to be tax-free for
this check type.
IsTenderAllowed ▪ True - A tender is said to be unrestricted for tendering its
check type to all tenders.
▪ False - A tender is said to be restricted for tendering its
check type to specific tenders.
PromptForTable A prompt for a table number before ordering.
PromptForCovers A prompt for the number of guests before ordering.
PromptForServer A prompt for a server number (or a card swipe) before
ordering.
PromptForRoom A prompt for a room number before ordering. This is referred to
as pre-tendering to a room, folio, generic authorization (GA),
and so on. The room or account information is captured at the
start of the transaction and stored in the check record until the
check is ready to be tendered. The account or room
information is redisplayed for confirmation before the check is
tendered.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 267
 IGPOS API | Reference Guide

Field Description
Depending on the settings of terminal options 116-118, this
prompt can also be used for
▪ #116 - Prompt for data entry instead of room
▪ #117 - Prompt for GA Account (Type 1) instead of room.
When pre-tendering to generic authorization, the price level
of the check may be determined by the price level
assigned to the GA type for that account.
▪ #118 - Prompt for folio number (verification code 6) instead
of room.
ObjectAndLinkedIds
ObjectId For future use.
LinkedId For future use.

GetTerminalInfo
This API is called to get terminal info.
Method: POST
URL: https://<environment>/GetTerminalInfo

Sample Request
No Parameters

Sample Response
{
"Id": 0,
"TenderedTermId": 0,
"ProfitCenter": "string",
"PrintTermId": "string",
"IPAddress": "string",
"TerminalModes": 0
}

□ Refer to the following table for field descriptions:

Field Description
Id A numerical value within a range of [1-9999] that gives a
unique identity to the POS terminal.
TenderedTermId The terminal ID where the check has been tendered.
ProfitCenter A string supporting up to 30 characters denotes the name of
the Profit Center.
PrintTermId This ID is used to identify the terminal whose printer is used for
printing the receipt.
IPAddress Denotes the IP Address of the terminal.
TerminalModes Indicates modes of Financials Calculation for a Terminal. The
following are the available modes:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 268
 IGPOS API | Reference Guide

Field Description
▪ Normal - 0
▪ VAT - 1
▪ GratuityInclusive - 2
▪ ModifiedVAT - 3

GetTerminalOptions
This API is called to get terminal option.
Method: POST
URL: https://<environment>/GetTerminalOptions

Sample Request
No Parameters

Sample Response
{
"Id": 0,
"TerminalOptionIds": [
0
]
}

□ Refer to the following table for field descriptions:

Field Description
Id A numerical value within a range of [1-9999] that gives a
unique identity to the POS terminal.
TerminalOptionIds IDs of all the terminal options that have been enabled for a
given terminal option group ID

GetLanguageDetails
API to get language details.
Method: POST
URL: https://<environment>/GetLanguageDetails

Sample Request
{
"objectType": "string",
"languageId": "string"
}

□ Refer to the following table for field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 269
 IGPOS API | Reference Guide

Field Description
objectType For future use.
languageId A unique value to identify the language. The primary and
secondary language can be set according to the preferences
and terminal uses this primary language as a default language.

Sample Response
"string"

GetClosedCheckInfo
This API is called to get closed check info.
Method: POST
URL: https://<environment>/GetClosedCheckInfo

Sample Request
{
"checkNumber": "string",
"guid": "string"
}

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
Refer to the Check Data Sample Response section for more information.

GetClosedCheckReceipt
This API is called to get closed check receipt.
Method: POST
URL: https://<environment>/GetClosedCheckReceipt

Sample Request
{
"checkNumber": "string",
"guid": "string"

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 270
 IGPOS API | Reference Guide

□ Refer to the following table for field descriptions:

Field Description
checkNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.

Sample Response
"string"

GetOpenChecks
This API is called to get open check information.
Method: POST
URL: https://<environment>/GetOpenChecks

Sample Request
No Parameters

Sample Response
[
{
"Id": "string",
"ObjectType": "string",
"Content": "string",
"Action": "string",
"CreatedDate": "2023-12-08T08:53:04.427Z",
"EmployeeId": 0,
"EmployeeName": "string",
"Guid": "string",
"ProfitCenter": "string",
"TableNumber": "string",
"Amount": 0,
"IsCheckLabel": true,
"IsHoldCheck": true,
"CheckType": 0,
"BackColor": 0,
"ForeColor": 0,
"SplitSeatId": 0
}
]

□ Refer to the following table for field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 271
 IGPOS API | Reference Guide

Field Description
Id For future use.
ObjectType For future use.
Content For future use.
Action For future use.
CreatedDate Displays the date of the created check.
EmployeeID A unique number [1 to 999,999,999] assigned for an employee.
EmployeeName Indicates the name of the employee.
Guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
ProfitCenter A string value that denotes the name of the profit center to
which the check belongs to.
TableNumber A unique number labelled for a table.
Amount Indicates the total amount of the check.
IsCheckLabel ▪ True - A label is assigned to the check with a maximum of
20 alphanumeric characters.
▪ False - No label is assigned to the check.
IsHoldCheck ▪ True - Holds all the items in the check from being sent to
the kitchen printer.
▪ False - All Items in the check will be sent to the kitchen
printers.
CheckType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.
BackColor Displays the background color of the selected button. Multiple
buttons can be selected, and the background color can be
changed in one-go by choosing the desired color available in
the drop-down menu.
NOTE: The available colors vary according to the selected
theme.
ForeColor Displays the font color of the selected button. Multiple buttons
can be selected, and the font color can be changed in one-go
by choosing the desired color available in the drop-down menu.
NOTE: The available colors vary according to the selected
theme.
SplitSeatId A unique value identifying the seat of a split check. When a
check is split, all the items in the check can be divided into
separate checks and assigned to a particular seat.

GetOpenChecksByTable
This API is called to get open checks associated with the table.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 272
 IGPOS API | Reference Guide

Method: POST
URL: https://<environment>/GetOpenChecksByTable

Sample Request
"string"

Sample Response
[
{
"Id": "string",
"ObjectType": "string",
"Content": "string",
"Action": "string",
"CreatedDate": "2023-12-08T08:58:28.293Z",
"EmployeeId": 0,
"EmployeeName": "string",
"Guid": "string",
"ProfitCenter": "string",
"TableNumber": "string",
"Amount": 0,
"IsCheckLabel": true,
"IsHoldCheck": true,
"CheckType": 0,
"BackColor": 0,
"ForeColor": 0,
"SplitSeatId": 0
}
]

□ Refer to the following table for field descriptions:

Field Description
Id For future use.
ObjectType For future use.
Content For future use.
Action For future use.
CreatedDate Displays the date of the created check.
EmployeeId A unique number [1 to 999,999,999] assigned for an employee.
EmployeeName Indicates the name of the employee.
Guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
ProfitCenter Profit Center from which the request has originated.
TableNumber A unique number labelled for a table.
Amount Indicates the total amount of the check.
IsCheckLabel ▪ True - A label is assigned to the check with a maximum of
20 alphanumeric characters.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 273
 IGPOS API | Reference Guide

Field Description
▪ False - No label is assigned to the check.
IsHoldCheck ▪ True - Holds all the items in the check from being sent to
the kitchen printer.
▪ False - All Items in the check will be sent to the kitchen
printers.
CheckType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.
BackColor Displays the background color of the selected button. Multiple
buttons can be selected, and the background color can be
changed in one-go by choosing the desired color available in
the drop-down menu.
NOTE: The available colors vary according to the selected
theme.
ForeColor Displays the font color of the selected button. Multiple buttons
can be selected, and the font color can be changed in one-go
by choosing the desired color available in the drop-down menu.
NOTE: The available colors vary according to the selected
theme.
SplitSeatId A unique value identifying the seat of a split check. When a
check is split, all the items in the check can be divided into
separate checks and assigned to a particular seat.

GetTenderDetails
This API is called to get tender information.
Method: POST
URL: https://<environment>/GetTenderDetails

Sample Request
No Parameters

Sample Response
[
{
"Id": 0,
"SecurityId": 0,
"DiscountId": 0,
"CardCode": "string",
"FrankingCode": "string",
"Limit": 0,
"CurrencyConversionRate": 0,
"AdaptorType": 0,
"AdditionalCheckIdType": 0,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 274
 IGPOS API | Reference Guide

"VerificationManualEntryCode": 0,
"OpenCashDrawerCode": 0,
"OverTenderCode": 0,
"PostAccountNumber": "string",
"TenderPostings": {
"PostSiteId": 0,
"DestinationPropertyCode": "string",
"PostToPms": true,
"PostToSystem1": true,
"PostToSystem2": true,
"PostToSystem3": true,
"PostToSystem4": true,
"PostToSystem5": true,
"PostToSystem6": true,
"PostToSystem7": true,
"PostToSystem8": true
},
"OverridingCheckTypeId": 0,
"OverridingPriceLevelId": 0,
"TaxCompCode": 0,
"VerificationCode": 0,
"IsAmountRequired": true,
"AllowDuplicateReceipts": true,
"IsTaxAutoRemovable": true,
"IsRestricted": true,
"IsCreditTender": true,
"IsExclusive": true,
"IncludeIRSReporting": true,
"IsComp": true,
"PromptForExtraData": true,
"PromptForAlphaData": true,
"UseSignatureCapture": true,
"SaveToArchive": true,
"PromptForCVV": true,
"PromptForPostalCode": true,
"IsEarnEligible": true,
"CanBypassCardInput": true,
"CardTypes": [
{
"CardLength": 0,
"PrefixLength": 0,
"PrefixHigh": 0,
"PrefixLow": 0
}
],
"GAType": 0,
"CMSType": 0,
"CMSSubType": "string",
"PMSType": 0,
"PMSSubType": 0,
"AdapterConfigurationId": 0,
"RequestForwardType": 0,
"IsSecondarySystem": true,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 275
 IGPOS API | Reference Guide

"IsLookupOnly": true,
"IsShowAddtionalGuestInfo": true,
"IsShowGuestGroup": true,
"IsOfflineSupported": true,
"IsChargingOnly": true,
"IsTrciklePostingSupported": true,
"SupportedVendor": 0,
"IsTenderReducesDiscount": true
}
]

□ Refer to the following table for field descriptions:

Field Description
Id A unique and modifiable value within a range of [1-255]. Some
of the PMS interfaces will not permit users to use the check
types whose ID is greater than nine [9] when Tender ID
number is higher than ninety-nine [99].
SecurityId Security Level ID. The item can be ordered only by employees
above this security level
DiscountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
CardCode A code obtained from a third-party processor representing the
card type to integrate with the POS terminal. This code
supports up to 32 characters.
FrankingCode Franking codes allow different information to be printed on the
customer’s receipt based on the requirements. A specific code
for specific information. For example, the code to display
Account Number/Name is [20]; the code to display Remaining
Balance/Name is [21].
Limit The maximum amount of payment allowed for this tender. If an
amount greater than the floor limit is entered at the POS
terminal, the cashier is prevented from completing the
transaction.
A manager with a security level of nine can override floor limits.
Maximum digits: 10.
Maximum amount: $21,474,836.47 or 2,147,483,647
depending on the Currency Format setting on the Enterprise
form.
CurrencyConversionRate Denotes the rate for converting the currency. This field gets
activated only if the verification code ID is between 41 and 49.
For example, for converting Japanese Yen to Dollar, the
currency rate is 0.00733; for converting the UK Pounds to
Dollar, the rate is 1.24.
AdaptorType For future use.
AdditionalCheckIdType An additional check identifier. The default is set to none. The
options are:
▪ Account Receivable Number: Used for the tax reporting
requirements for some countries’ real time fiscal
integrations.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 276
 IGPOS API | Reference Guide

Field Description
▪ Tax Invoice Number: Used for the tax reporting
requirements for some countries’ real time fiscal
integrations.
▪ Order Receipt Number (OR#): The OR# prints by default
in the receipt header if set here. The format of the order
number is TTTT###### (TTTT = terminal number and
###### = 6-digit sequential check number).
For example, a check completed on terminal #214 with a
sequential check number of 123456 appears on the check
receipt as 0214123456. Use the | CPF token to print the OR#
on a custom CPF. The Order Receipt Number column appears
in the Check Sales Detail table in the IG business database
and the OR# is also in the TLOG if used. The OR# is not
searchable in the Recreate Check Utility.
▪ OR+ - Store: Used for Colombia and Filipino fiscal
interfaces.

VerificationManualEntryCode ▪ True - The verification is required for the manually entered

code.
▪ False - The verification is not required for the manually
entered code.
OpenCashDrawerCode ▪ True - The cash drawer opens while applying this tender.
▪ False - The cash drawer does not open while applying this
tender.
OverTenderCode The choice of ways to handle over tender (Change, Tip,
Breakage, or No Overtender).
PostAccountNumber For future use.
TenderPostings
PostSiteId Enterprises with multiple properties labels an identifying Post
Site ID# (0-99) for the tender to post to. The Post Site ID# is
included with the PMS posting information.
DestinationPropertyCode Denotes the code of the property that receives the cross-
property charge.
PostToPms ▪ True - The tender transaction data gets posted to Property
Management System (PMS).
▪ False - The tender transaction data does not get posted to
Property Management System (PMS).
PostToSystem1 Used to select a system to post to other than the standard
PMS.
PostToSystem2 Used to select a system to post to other than the standard
PMS.
PostToSystem3 Used to select a system to post to other than the standard
PMS.
PostToSystem4 Used to select a system to post to other than the standard
PMS.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 277
 IGPOS API | Reference Guide

Field Description
PostToSystem5 Used to select a system to post to other than the standard
PMS.
PostToSystem6 Used to select a system to post to other than the standard
PMS.
PostToSystem7 Used to select a system to post to other than the standard
PMS.
PostToSystem8 Used to select a system to post to other than the standard
PMS.
OverridingCheckTypeId A unique value identifying the check type override.
OverridingPriceLevelId A unique value identifying the price level override.
TaxCompCode For future use.
VerificationCode A unique code to determine the type of tender which impacts
tender verification or validation functions. For example, when
using GA tenders, the tender verification code identifies the
type of the tender as GA tender.
IsAmountRequired ▪ True - Enables cashier to enter the amount before closing
the check. Also, the POS terminal automatically calculates
and displays the balance due.
▪ False - The field remains in-active and no balance or
change due is displayed to the cashier.
AllowDuplicateReceipts ▪ True - Allows an employee to print a duplicate copy of the
check by touching the Print Last Receipt.
▪ False - Does not allow an employee to print a duplicate
copy of the check.
IsTaxAutoRemovable ▪ True - Removes tax automatically for the value of the
tender applied to the check.
▪ False - Tax gets included for the value of the tender
applied to the check.
IsRestricted ▪ True - A tender is restricted when it includes items
belonging to a restricted revenue category.
▪ False - A tender is not restricted on any basis.
IsCreditTender ▪ True - Indicates the tender is a credit.
▪ False - Indicates the tender is not a credit.
IsExclusive ▪ True - Prevents additional tenders from being used once
the tender is applied to a check.
▪ False - Becomes a non-exclusive tender where, the tender
can be used to partially pay the check. Two or more
tenders can be applied to the check to complete the
payment.
IncludeIRSReporting ▪ True - Includes sales using this tender in the IRS Tip and
IRS Tip by Profit Center reports.
▪ False - Does not include sales using this tender in the IRS
Tip and IRS Tip by Profit Center reports.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 278
 IGPOS API | Reference Guide

Field Description
IsComp ▪ True - Allows the user to use the tender with comp items
and the tender gets included on the Entertainment Tax
reports.
▪ False - User cannot use the tender with comp items.
PromptForExtraData ▪ True - A prompt appears for entering extra numerical data
at the POS terminal.
▪ False - No prompt appears for entering extra numerical
data.
PromptForAlphaData ▪ True - A prompt appears for alpha data at the POS
terminal.
▪ False - No prompt appears for alpha data at the POS
terminal.
UseSignatureCapture ▪ True - The terminal uses signature capture logic for the
tender. Guest’s card swipe and signature are recorded
using the signature capture devices attached to the POS
terminal. Currently, this feature is supported using a
VeriFone signature capture device.
▪ False - The terminal does not use signature capture logic
for the tender.
SaveToArchive ▪ True - Archives the check data with DataMagine.
Customers using DataMagine can recall check data from
the IG POS system. One or more tenders within a terminal
group is required to have this option selected.
▪ False - Does not archive the check data with DataMagine.
PromptForCVV ▪ True - A prompt to configure a tender with a credit card’s
CVV code. This option is only supported with Verification
Code 146: Credit Card via Service Manager.
▪ False - No prompt appears to configure a tender with a
credit card’s CVV code.
PromptForPostalCode ▪ True - A prompt to configure a tender with a credit card’s
postal code to ensure user authenticity. This option is only
supported with Verification Code 146: Credit Card via
Service Manager.
▪ False - No prompt appears to configure a tender with a
credit card’s postal code.
IsEarnEligible ▪ True - An additional perk while integrating with LP or
Casino Enhanced Loyalty based on the requirements.
▪ False - Earn Eligible remains off.
CanBypassCardInput ▪ True - User can bypass the external payment device and
accept the card input at the terminal’s MSR or another
device, such as an RFID reader. This option is used for
non-credit card tenders such as Gift Card, GA, Room, or
Folio tenders when the interface does not support doing
the card read on the payment device.
▪ False - User cannot bypass the external payment device.
CardTypes

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 279
 IGPOS API | Reference Guide

Field Description
CardLength A required spinner box for setting the number length. This field
supports up to 99.
PrefixLength If the prefix length (1-9) is modified, it must be validated against
the Prefix Low and Prefix High fields in the Ranges tab at the
save time.
PrefixHigh This field must have the number of digits specified in the prefix
length field.
PrefixLow This field must have the number of digits specified in the prefix
length field.
GAType Indicates one of the nine (1/9) GA types that are set up to track
various internal charge payment types, including employee
meals, manager, executive, entertainment, and more.
CMSType Indicates the type of the Casino Management System.
CMSSubType Indicates the sub type under the Casino Management System.
PMSType Indicates the type of the Property Management System.
PMSSubType Indicates the sub type under the Property Management
System.
AdapterConfigurationId A unique value identifying the adapter configuration.
RequestForwardType For future use.
IsSecondarySystem For future use.
IsLookupOnly ▪ True - The tender can be used for lookup only and cannot
post charges to this tender.
▪ False - The tender is not a lookup-only tender and it can
post charges.
IsShowAddtionalGuestInfo ▪ True - The additional guest information is collected and
displayed for this tender.
▪ False - The additional guest information is not collected.
IsShowGuestGroup For future use.
IsOfflineSupported ▪ True - The tender is supported when the POS terminal is
offline.
▪ False - The tender is not supported when the POS terminal
is offline.
IsChargingOnly ▪ True - This tender can be used for charging only and
lookup cannot be done.
▪ False - This tender can be used for charging and lookup.
IsTricklePostingSupported ▪ True - Supports trickle posts of PMS transactions.
▪ False - Does not support trickle posts of PMS transactions.
SupportedVendor For future use.
IsTenderReducesDiscount ▪ True - Allows user to configure a pro-rata tender. When a
pro-rata tender is applied to a check, the discount, if any,
that is already applied to the tender changes accordingly.
Both the tender and the discount that is already applied to
the check must have the tender reduces discount
checkbox enabled for this to occur.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 280
 IGPOS API | Reference Guide

Field Description
▪ False - User cannot configure such a pro-rata tender.

GetDiscountDetails
This API is called to get discount information.
Method: POST
URL: https://<environment>/GetDiscountDetails

Sample Request
{
"discountId": 0
}

□ Refer to the following table for field description.

Field Description
discountId A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.

Sample Response
{
"Id": 0,
"Level": 0,
"DiscountSKUCode": "string",
"SecurityId": 0,
"ProfitCenterGroupId": 0,
"IsFixed": true,
"IsPercentage": true,
"IsExclusive": true,
"AffectTax": true,
"Value": 0,
"MaxValue": 0,
"PromptExtraCode": 0,
"PromptOpen": true,
"AllowedRevenueGroup": [
0
],
"DiscountRule": {
"RuleId": 0,
"RuleDateFrom": "string",
"RuleDateTo": "string",
"RuleStartTimeMinutes": 0,
"RuleEndTimeMinutes": 0,
"RuleRecurrenceType": 0,
"RuleDayofweekMask": 0,
"RuleDayofmonth": 0,
"RuleOrdinalDay": 0,
"RuleMonthofyear": 0,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 281
 IGPOS API | Reference Guide

"RuleRevenueGroup": 0,
"RuleConstraintJoin": [
{
"RuleConstraintId": "string",
"RelevantIds": [
{
"Id": 0,
"ItemFlag": 0
}
]
}
]
},
"Tier": {
"TierId": 0,
"TierName": "string",
"CMSId": 0,
"MaxLimit": 0,
"RewardValue": "string"
},
"IsTenderReducesDisc": true,
"splitDiscFlag": true,
"IsAffectGratuity": true,
"IsAffectServiceCharge": true
}

□ Refer to the following table for field descriptions:

Field Description
Id A system generated or manually entered value within the range
[1-9999] that identifies the discount at the POS terminal.
Level Denotes whether it is an item level discount or a check level
discount.
DiscountSKUCode An alphanumeric discount code (printed on receipts) with a
maximum of 30 characters that enables users to apply a
discount to the check by scanning the barcode.
SecurityId Security Level ID. The discount can be applied only by
employees above this security level
ProfitCenterGroupId A system generated or manually entered unique numerical
value within the range of [1-999] assigned to the profit center
group. With some of the Property Management System (PMS)
interfaces, only up to two-digit numbers (99) are usable.
IsFixed ▪ True - Denotes that the discount is for a fixed percentage
or amount.
▪ False - Denotes it is an open discount that varies in
percentage or amount.
IsPercentage ▪ True - Calculates discount on a percent basis.
▪ False - Calculates discount on an amount basis.
IsExclusive ▪ True - The check can have only one discount and it cannot
be clubbed with any other discounts.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 282
 IGPOS API | Reference Guide

Field Description
▪ False - The discount can be applied in conjunction with
any other discounts.
AffectTax ▪ True - The discount does not impact the taxes available in
the check.
▪ False - The taxes get adjusted according to the discount
applied.
Value The value of the discount.
MaxValue The maximum value till which the discount can be applied. This
is used in case of percentage or open discounts.
PromptExtraCode A prompt to provide additional information for a chosen
discount. User can enter the text manually using the on-screen
keyboard or by using the card swipe.
PromptOpen ▪ True - The extra data is collected while applying the
discount.
▪ False - The extra data is not collected while applying the
discount.
AllowedRevenueGroup All the four revenue groups in the Main tab are selected by
default. If none is selected, the Eligibility tab is disabled. The
Product Classes, Items, Store Items, Check Types, and
Packages on the Eligibility tab are populated based on the
Revenue Group selection
DiscountRule
RuleId A system generated or manually entered number for the
coupon or discount.
RuleDateFrom Indicates the start day (in DD/MM/YY format) from which the
discount rule will be applied.
RuleDateTo Indicates the last day (in DD/MM/YY format) to which the
discount rule will be applied.
RuleStartTimeMinutes Indicates the discount rule start time in minutes.
RuleEndTimeMinutes Indicates the discount rule end time in minutes.
RuleRecurrenceType Indicates the frequency of the same discount rule to come into
effective. Eg: Daily, Weekly, Monthly, and Yearly.
RuleDayofweekMask Discount rule recurrence setting to indicate the day of the week
when the rule can be applied.
RuleDayofmonth Discount rule recurrence setting to indicate the day of the
month when the rule can be applied.
RuleOrdinalDay Discount rule recurrence setting to indicate the ordinal day in a
month/year when the rule can be applied.
RuleMonthofyear Discount rule recurrence setting to indicate the month of the
year when the rule can be applied.
RuleRevenueGroup Indicates the discount on the selected revenue group - Product
Classes, Items, Store Items, Check Types, and Package. By
default, all the four categories in the revenue groups are
selected.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 283
 IGPOS API | Reference Guide

Field Description
RuleConstraintJoin
RuleConstraintId For future use.
RelevantIds
Id For future use.
ItemFlag ▪ True - Indicates it is an item.
▪ False - Indicates it is not an item.
Tier
TierId It is a unique system generated value that falls within a range
of [1-999].
TierName An alphanumeric value with a maximum limit of 50 characters
indicates the player’s tier level.
CMSId Denotes the Casino Management System ID.
MaxLimit The maximum discount limit applicable for a tier.
RewardValue The value of the tier rewards applicable to the guest.
IsTenderReducesDisc ▪ True - The discount gets re-calculated in proportion to the
tender, thereby enabling users to apply discounts even in a
partially tendered check.
▪ False - The discount does not get re-calculated.
splitDiscFlag For internal purpose.
IsAffectGratuity ▪ True - The discount does not impact the gratuity.
▪ False - The gratuity gets adjusted based on the applied
discount.
IsAffectServiceCharge ▪ True - The discount does not impact the service charge.
▪ False - The service charge gets adjusted based on the
applied discount.

GetTaxDetails
This API is called to get tax details.
Method: POST
URL: https://<environment>/GetTaxDetails

Sample Request
No Parameters

Sample Response
[
{
"UpdatedTaxRate": 0,
"Id": 0,
"IsTaxByPercent": true,
"TaxValue": 0,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 284
 IGPOS API | Reference Guide

"IsExclusive": true,
"IsTaxRemoved": true,
"CanRemoveAtTerminal": true,
"CategoryId": 0,
"RoundingConfiguration": {
"RoundType": 0,
"RoundBasis": 0
}
}
]

□ Refer to the following table for field descriptions:

Field Description
UpdatedTaxRate For future use.
Id A unique number within a range of [1-255] to identify the tax
levied on the check.
IsTaxByPercent ▪ True - Calculates tax on a Percent basis.
▪ False - Calculates tax on an Amount basis.
TaxValue Indicates the tax amount levied in a check.
IsExclusive ▪ True - The tax is not applied to the check.
▪ False - The tax is applied to the check.
IsTaxRemoved ▪ True - POS operators can remove the tax associated with
the item.
▪ False - POS operators cannot remove the tax associated
with the item.
CanRemoveAtTerminal ▪ True - Tax can be removed from the check at the POS
terminal.
▪ False - Tax cannot be removed from the check at the POS
terminal.
CategoryId A numerical value to denote the preferred tax category.
RoundingConfiguration
RoundType Round off the value of the check to the nearest unit.
RoundBasis A desired value in the range of [1-50000] to round the check.
For example, in the US, typing 50000 rounds to $500.00.

GetGratuityServiceCharge
API to get gratuity service charge.
Method: POST
URL: https://<environment>/GetGratuityServiceCharge

Sample Request
No Parameters

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 285
 IGPOS API | Reference Guide

Sample Response
[
{
"Id": 0,
"GratuityCategory": {
"Id": 0,
"GratuityType": 0,
"IsEarnEligible": true,
"IsRedeemEligible": true,
"GratuityCategoryName": "string"
},
"Recipient": 0,
"EmployeeId": 0,
"CanPayoutAtTerminal": true,
"CanRemovalAtTerminal": true,
"Amount": {
"AmountPerCheck": 0,
"AmountPerCover": 0,
"CoverThresholdMin": 0,
"CoverThresholdMax": 0
},
"Percentage": {
"AppliedOn": 0,
"Percent": 0,
"RoundingConfiguration": {
"RoundType": 0,
"RoundBasis": 0
},
"IsInclusive": true
}
}
]

□ Refer to the following table for field descriptions:

Field Description
Id ID of the Gratuity/Service Charge whose details were
requested.
GratuityCategory
Id A system generated or manually entered unique value within
the range [1-255] identifies the gratuity category. This value is
unique at the enterprise level.
GratuityType Denotes the type. User can select Gratuity or Service Charge
depending on their requirements.
IsEarnEligible ▪ True - Customers earn loyalty points as rewards when the
system is integrated with Casinos or others.
▪ False - No loyalty points are rewarded to the customers.
IsRedeemEligible ▪ True - Customers can redeem their loyalty points.
▪ False - Loyalty points cannot be redeemed.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 286
 IGPOS API | Reference Guide

Field Description
GratuityCategoryName A string value with a maximum of 20 characters indicate the
name of the gratuity category.
Recipient Indicates a server, cashier, or specific employee. The gratuity
or service charge may be given to the server, cashier, or to a
designated employee. The designated employee can be an
individual (maître d’) or a group of employees (bus persons,
valet, and so on.)
EmployeeId If the recipient is an employee, this unique value indicates the
ID of that particular employee who claims the gratuity or
service charge. At times, the employee can also be a business
entity such as a casino, hotel, or other profit centers and it can
be configured in the Employee Main Form.
CanPayoutAtTerminal ▪ True - Gratuity or service charge accumulates along with
other tips to be paid out in cash at the terminal. A tip
payout can be performed at the terminal via the terminal’s
Shift Reset report (activate terminal option 210 to
automatically prompt for tip payout) or by selecting the Tip
Payout button. Running the Shift Reset report also updates
the Server Shift Sales, Tips and Gratuities report, the
Server Shift Sales, Tips, and the Grats Summary report.
▪ False - When user selects not to pay out this gratuity at the
terminal, it is still reported on back-office reports, so the
gratuity is paid by alternative means (i.e., payroll).
CanRemovalAtTerminal ▪ True - The gratuity or service charge gets removed from
the check. This option is accessible only by employees
with higher job security levels. They can remove or restore
a gratuity (job code function 191) or a service charge (job
code function 225).
▪ False - The employees cannot remove the gratuities or
service charge from the check.
Amount
AmountPerCheck Indicates the amount per check and supports decimal points
with up to 2 places. The maximum digits that the field can
accommodate is 7 (i.e., up to 9,999,999).
AmountPerCover Indicates the amount per cover and supports decimal points
with up to 2 places. The maximum digits that the field can
accommodate is 7 (i.e., up to 9,999,999).
CoverThresholdMin Indicates the minimum number of covers needed for a cover-
based service charge or gratuity that must be applied to the
check (0-30,000). The POS terminal automatically applies this
gratuity when the cover count is equal to or greater than the
minimum.
For example, if a service charge is based only on a $2 charge
per cover, the least service charge fees can be set to $4 for a
minimum of 2 for the cover threshold.
CoverThresholdMax Indicates the maximum number of covers needed for a cover-
based service charge or gratuity that must be applied to the

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 287
 IGPOS API | Reference Guide

Field Description
check (0-30,000). The POS terminal automatically applies this
gratuity when the cover count is equal to or lesser than the
maximum.
For example, if a service charge is based only on a $2 charge
per cover, the service charge fees can be limited to $20 for a
maximum of 10 for the cover threshold.
Percentage
AppliedOn Indicates whether the gratuity is fixed or applied on a
percentage basis.
Percent Indicates the percentage of gratuity applied on the check.
RoundingConfiguration
RoundType Round off the value of the check to the nearest unit.
RoundBasis A desired value in the range of [1-50000] to round the check.
For example, in the US, typing 50000 rounds to $500.00.
IsInclusive ▪ True - The gratuities get included in the price of the items.
So, gratuities and service charges do not appear on the
receipt.
▪ False - The gratuities are not included in the price of items
and appear separately on the receipt.

GetItemPriceByPriceLevel
This API is called to get item price by price level.
Method: POST
URL: https://<environment>/GetItemPriceByPriceLevel

Sample Request
{
"objectType": 0,
"ScheduleTime": "string"
}

□ Refer to the following table for field descriptions:

Field Description
objectType For future use.
ScheduleTime The time schedule for which the item price for the mapped
price level is returned.

Sample Response
[
{
"ObjectType": "string",
"ItemId": 0,
"ObjectId": 0,

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 288
 IGPOS API | Reference Guide

"TerminalGroupId": 0,
"PriceLevelId": 0,
"Price": 0
}
]

□ Refer to the following table for field descriptions:

Field Description
ObjectType For future use.
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
ObjectId For future use.
TerminalGroupId A unique value in the enterprise level that identifies a terminal.
PriceLevelId A unique value that identifies the assigned price level.
Price Indicates the price of listed items on the check.

GetModifierPriceByPriceLevel
This API is called to get modifier price by price level.
Method: POST
URL: https://<environment>/GetModifierPriceByPriceLevel

Sample Request
{
"objectType": 0,
"ScheduleTime": "string"
}

□ Refer to the following table for field descriptions:

Field Description
objectType For future use.
ScheduleTime The time schedule for which the item price for the mapped
price level is returned.

Sample Response
[
{
"ObjectType": "string",
"ItemId": 0,
"ObjectId": 0,
"TerminalGroupId": 0,
"PriceLevelId": 0,
"Price": 0
}
]

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 289
 IGPOS API | Reference Guide

□ Refer to the following table for field descriptions:

Field Description
ObjectType For future use.
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
ObjectId For future use.
TerminalGroupId A unique value in the enterprise level that identifies a terminal.
PriceLevelId A unique value that identifies the assigned price level.
Price Indicates the price of listed items on the check.

GetChoiceGroup
This API is called to get choice group by ID or to get all choice group.
Method: POST
URL: https://<environment>/GetChoiceGroup

Sample Request
{
"choiceGroupId": "string"
}

□ Refer to the following table for field descriptions:

Field Description
choiceGroupId A unique numerical value within a range of [1-99999] to identify
a choice group.

Sample Response
{
"Id": 0,
"Name": "string",
"MinChoice": 0,
"MaxChoice": 0,
"Mods": [
{
"Id": 0
}
],
"ModifierSeq": [
0
]
}

□ Refer to the following table for field descriptions:

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 290
 IGPOS API | Reference Guide

Field Description
Id A unique numerical value within a range of [1-99999] to identify
a choice group.
Name A string value that indicates the name of the choice group.
MinChoice Indicates the minimum number (up to 20) of modifiers that can
be selected within the choice group.
MaxChoice Indicates the maximum number (up to 20) of modifiers that can
be selected within the choice group.
Mods
Id Represents a unique identity value for the modifier.
ModifierSeq The sequence of modifiers.

GetVoidReason
This API is called to get void reason.
Method: POST
URL: https://<environment>/GetVoidReason

Sample Request
No Parameters.

Sample Response
[
{
"Id": 0,
"SecurityId": 0,
"AffectsInventory": true,
"PrintToKitchen": true,
"ReasonType": 0
}
]

□ Refer to the following table for field descriptions:

Field Description
Id A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check
SecurityId Security Level ID. The item can be voided only by employees
above this security level
AffectsInventory ▪ True - When an item is voided using this reason, the item
is considered as not consumed and returned to inventory.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 291
 IGPOS API | Reference Guide

Field Description
▪ False - When an item is voided using this reason the
inventory count is affected.
PrintToKitchen ▪ True - Notifies the kitchen when an item is voided using
this reason.
▪ False - The kitchen does not get notified about the item
void.
ReasonType Denotes one of the two reason types - Void or Refund.

GetProfitCenters
This API is called to get profit center details.
Method: POST
URL: https://<environment>/GetProfitCenters

Sample Request
No Parameters.

Sample Response
[
{
"Id": "string",
"ObjectType": "string",
"Content": "string",
"Action": "string",
"CreatedDate": "2023-12-07T10:52:03.442Z",
"EmployeeId": 0,
"EmployeeName": "string",
"Guid": "string",
"ProfitCenter": "string",
"TableNumber": "string",
"Amount": 0,
"IsCheckLabel": true,
"IsHoldCheck": true,
"CheckType": 0,
"BackColor": 0,
"ForeColor": 0,
"SplitSeatId": 0
}
]

□ Refer to the following table for field descriptions:

Field Description
Id Profit center ID.
ObjectType For future use.
Content For future use.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 292
 IGPOS API | Reference Guide

Field Description
Action For future use.
CreatedDate Displays the date of the created check.
EmployeeId A unique number [1 to 999,999,999] assigned for an employee.
EmployeeName Indicates the name of the employee.
Guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
ProfitCenter A string value that denotes the name of the profit center to
which the check belongs to.
TableNumber A unique number labelled for a table.
Amount Indicates the total amount of the check.
IsCheckLabel ▪ True - A label is assigned to the check with a maximum of
20 alphanumeric characters.
▪ False - No label is assigned to the check.
IsHoldCheck ▪ True - Holds all the items in the check from being sent to
the kitchen printer.
▪ False - All Items in the check will be sent to the kitchen
printers.
CheckType A numerical value representing the type of the check. The type
defines the characteristics of a check - the taxes, price levels,
gratuities, and service charges applied to transactions in profit
centers as well as the prompts displayed, i.e., table, covers, or
room.
BackColor Displays the background color of the selected button. Multiple
buttons can be selected, and the background color can be
changed in one-go by choosing the desired color available in
the drop-down menu.
NOTE: The available colors vary according to the selected
theme.
ForeColor Displays the font color of the selected button. Multiple buttons
can be selected, and the font color can be changed in one-go
by choosing the desired color available in the drop-down menu.
NOTE: The available colors vary according to the selected
theme.
SplitSeatId A unique value identifying the seat of a split check. When a
check is split, all the items in the check can be divided into
separate checks and assigned to a particular seat.

GetQuickTenderDetails
This API is called to get quick tender details.
Method: POST
URL: https://<environment>/GetQuickTenderDetails

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 293
 IGPOS API | Reference Guide

Sample Request
No Parameters.

Sample Response
[
{
"Id": 0,
"Amount": 0,
"TenderId": 0
}
]

□ Refer to the following table for field descriptions:

Field Description
Id ID of the quick tender whose details were requested.
Amount Indicates the amount to be tendered.
TenderId A unique and modifiable value in the enterprise level within a
range of [1-255] identifying a tender. Some of the PMS
interfaces will not permit users to use the check types whose
ID is greater than nine [9] when Tender ID number is higher
than ninety-nine [99].

GetMealPeriod
This API is called to get meal period details.
Method: POST
URL: https://<environment>/GetMealPeriod

Sample Request
No Parameters.

Sample Response
{
"Id": 0,
"PriceLevelId": 0,
"CheckTypeId": 0,
"ItemReceiptPrefix": "string",
"AllowTaxReporting": true,
"SecurityId": 0,
"ScreensCalendarMap": {
"additionalProp1": {
"code": 0,
"text": 0
},
"additionalProp2": {

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 294
 IGPOS API | Reference Guide

"code": 0,
"text": 0
},
"additionalProp3": {
"code": 0,
"text": 0
}
},
"StartTimeDayOfWeekMap": {
"additionalProp1": {
"code": 0,
"text": 0
},
"additionalProp2": {
"code": 0,
"text": 0
},
"additionalProp3": {
"code": 0,
"text": 0
}
}
}

□ Refer to the following table for field descriptions:

Field Description
Id ID of the Meal Period whose details were requested.
PriceLevelId A unique value that identifies the assigned price level.
CheckTypeId A unique identification number for the check type.
ItemReceiptPrefix Indicates the prefix designated for the meal period. This prefix
gets displayed on the guest’s receipt next to items. For
example, an E could denote Entertainment
AllowTaxReporting ▪ True - Reports entertainment tax. For this feature to get
enabled, it is mandatory to check the tax form’s Limit Tax
to Meal Period Tax Reporting box.
▪ False - Entertainment tax is not included in the report.
SecurityId A unique value identifying the security level needed to switch to
this meal period.
ScreensCalendarMap
additionalProp1
code For future use.
text For future use.
additionalProp2
code For future use.
text For future use.
additionalProp3
code For future use.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 295
 IGPOS API | Reference Guide

Field Description
text For future use.
StartTimeDayOfWeekMap
additionalProp1
code For future use.
text For future use.
additionalProp2
code For future use.
text For future use.
additionalProp3
code For future use.
text For future use.

GetEmployeeInfo
This API is called to get employee details.
Method: POST
URL: https://<environment>/GetEmployeeInfo

Sample Request
{
"employeeId": "string",
"cardNumber": "string",
"isDataByMSR": true
}

□ Refer to the following table for field descriptions:

Field Description
employeeId A unique number [1 to 999,999,999] assigned for an employee.
cardNumber Indicates the card number to which the employee ID is
assigned to. All employee IDs are assigned to their card
number by default. However, being an editable field, card
number can be altered if required.
isDataByMSR ▪ True - Supports card swipe to read all data of the
employee.
▪ False - Does not support card swipe.

Sample Response
{
"IsEmpValid": true,
"Employee": {
"EmployeeId": "string",
"Password": "string",

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 296
 IGPOS API | Reference Guide

"CardNumber": "string",
"DefaultJobCode": 0,
"JobCodes": [
0
],
"HasPassword": true,
"KeyPadLocation": 0,
"DefaultLanguage": "string",
"EmpLangId": "string"
}
}

□ Refer to the following table for the field descriptions:

Field Description
IsEmpValid ▪ True - The employee is valid and active.
▪ False - The employee is not valid.
Employee
EmployeeId A unique number [1 to 999,999,999] assigned for an employee.
Password A four-digit numerical value that allows employees to sign-in to
the POS terminal. Employees can sign-in without typing the
password if it is set to zero.
CardNumber The same employee ID is assigned to the card number by
default. However, being an editable field, card number can be
altered if required.
DefaultJobCode The default Job Code for the employee is always blank. An
offline job code is mandatory as the employee’s record cannot
be saved until a job code is assigned.
JobCodes Represents the designated Job Codes to the employee.
HasPassword ▪ True - The employee has the password to login.
▪ False - The employee does not have the password to
login.
KeyPadLocation A desired location (left-hand side or right-hand side) to place
the keypad and order display in the POS terminal.
DefaultLanguage The default language set for the employee. The POS terminal
will display this language right from the employee’s sign-in
page.
EmpLangId A unique value assigned to indicate the primary language of
the employee.

GetTerminalState
This API is called to get terminal status.
Method: POST
URL: https://<environment>/GetTerminalState

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 297
 IGPOS API | Reference Guide

Sample Request
No Parameters.

Sample Response
{
"TermID": 0,
"ProfitCenter": 0,
"MealPeriod": 0,
"iLogOnIdDrawer1": 0,
"iLogOnIdDrawer2": 0,
"StaticIpPrinterId": "string",
"LastReloadTime": "2023-12-07T10:30:11.689Z",
"EmployeeSettings": [
{
"Id": "string",
"ButtonSize": "string",
"Theme": "string",
"ScreenType": true,
"FontSize": "string"
}
],
"IsAutoDetect": true
}

□ Refer to the following table for the field descriptions:

Field Description
TermID A numerical value within a range of [1-9999] that gives a
unique identity to the POS terminal.
ProfitCenter Denotes a profit center to which the terminal belongs to.
MealPeriod A particular period in a day to categorize specific items, price
levels, and others. Also, Meal Period is used to generate
reports, such as sales performance report, product mix report,
etc., for that particular period of the day.
iLogOnIdDrawer1 ▪ True - A logon ID must be requested to operate cash
drawer 1.
▪ False - A logon ID is not required to operate cash drawer
1.
iLogOnIdDrawer2 ▪ True - A logon ID must be requested to operate cash
drawer 2.
▪ False - A logon ID is not required to operate cash drawer
2.
StaticIpPrinterId A unique string value identifying the static IP printer.
LastReloadTime Displays the last reloaded date and time of the terminal.
EmployeeSettings
Id A unique number [1 to 999,999,999] assigned for an employee.
ButtonSize Denotes the size for the button

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 298
 IGPOS API | Reference Guide

Field Description
Theme Denotes the selected theme for the terminal
ScreenType Indicates the mode of homescreen display. It can be either
modern or traditional layout.
FontSize Denotes the size of the font.
IsAutoDetect For future use.

GetSelectionGroup
This API is called to get selection group information.
Method: POST
URL: https://<environment>/GetSelectionGroup

Sample Request
No Parameters.

Sample Response
[
{
"Id": 0,
"Items": [
{
"ItemId": 0,
"Sequence": 0,
"Amount": 0
}
]
}
]

□ Refer to the following table for the field descriptions:

Field Description
Id A unique number that identifies a selection group.
Items
ItemId A system generated or manually entered unique value within a
range of [1-999,999,999] characters representing items.
Sequence Sequence in which an item will be displayed while ordering
from this selection group.
Amount The amount of the items listed on the check.

GetSpecialInstructions
This API is called to get special instructions.
Method: POST

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 299
 IGPOS API | Reference Guide

URL: https://<environment>/GetSpecialInstructions

Sample Request
No Parameters.

Sample Response
[
{
"Id": 0,
"Text": "string",
"Index": 0,
"IsVoid": true,
"VoidReasonId": 0,
"IsSaved": true,
"KPStatus": 0,
"KVStatus": 0,
"ChildItemIndex": 0,
"KitchenItemIndex": 0,
"ItemCheckNumber": 0
}
]

□ Refer to the following table for the field descriptions:

Field Description
Id A unique numerical value within a range of [1-9999] to identify
the special instruction.
Text Represents the name of the special instruction with a maximum
of 20 characters.
Index For future use.
IsVoid ▪ True - The special instruction is voided with appropriate
security levels.
▪ False - The special instruction is not voided.
VoidReasonId A unique number in the range [2-253] that identifies the reason
for the void. The void reasons ID = 1, 254, 255 are already
predefined and cannot be deleted.
▪ Void Reason 1 = Refund
▪ Void Reason 254 = Item Return
▪ Void Reason 255 = Reopen Check
IsSaved For future use.
KPStatus For future use.
KVStatus For future use.
ChildItemIndex For future use.
KitchenItemIndex For future use.
ItemCheckNumber For future use.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 300
 IGPOS API | Reference Guide

VoidMultipleDiscounts
This API is called to void multiple discounts applied to a check at once.
Method: POST
URL: https://<environment>/VoidMultipleDiscounts

Sample Request
{
"CheckNumber": "string",
"Guid": "string",
"checkDiscountIndex": [
0
],
"itemDiscount": [
{
"index": 0,
"discountIndex": [
0
]
}
]
}

□ Refer to the following table for the field descriptions:

Field Description
CheckNumber A numerical value that gives unique identification to every
check generated in the POS terminal. This value is an
amalgamation of terminal ID and sequential number.
Guid Represents the GUID of the check. When a check is created, it
is given a GUID which is used in all the subsequent check
operations as its identifier.
checkDiscountIndex The index of the check discount that is being voided.
itemDiscount
index The index of the item whose discounts are being voided.
discountIndex The index of the item level discounts that are being voided.

Sample Response
Refer to the Check Data Sample Response section for more information.

GetTierDiscounts
This API is called to get the discounts associated with a tier level.
Method: POST
URL: https://<environment>/GetTierDiscounts

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 301
 IGPOS API | Reference Guide

Sample Request
{
"tierName": "string"
}

□ Refer to the following table for the field description.

Field Description
tierName A string value that indicates the tier name.

Sample Response
"string"

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 302
 IGPOS API | Reference Guide

Store
OpenStore
API to open a store. Orders can be created only when the store is open.
Method: POST
URL: https://<environment>/OpenStore
Headers:
Field Description
CustomerId (string) A unique value assigned to the customer using POS API.
EnterpriseId (string) A unique value assigned to the enterprise.
DivisionId (string) A unique value assigned to the division.
StoreId (string) A unique value assigned to the store.
ClientId (string) A unique value assigned to the client using POS API

Sample Request
{
"ClientCertificateId": "string"
}

□ Refer to the following table for the field description.

Field Description
ClientCertificateId Indicates the certificate ID of the POS API client. It
authenticates the source of requests.

Sample Response
"string"

CloseStore
API to close a store. Orders cannot be created after a store is closed.
Method: POST
URL: https://<environment>/CloseStore
Headers:
Field Description
CustomerId (string) A unique value assigned to the customer using POS API.
EnterpriseId (string) A unique value assigned to the enterprise.
DivisionId (string) A unique value assigned to the division.
StoreID (string) A unique value assigned to the store.

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 303
 IGPOS API | Reference Guide

Field Description
ClientID (string) A unique value assigned to the client using POS API

Sample Request
{
"ClientCertificateId": "string"
}

□ Refer to the following table for the field description.

Field Description
ClientCertificateId Indicates the certificate ID of the POS API client. It
authenticates the source of requests.

Sample Response
"string"

February 12, 2024 | Copyright © 2024 by Agilysys NV, LLC. All rights reserved | Scope: Customer Page 304