Settings.svc
Calls
- GetCashDrawers - Retrieve the Cash Drawers for this location.
- GetDayParts - Retrieve the Day Parts for this location.
- GetDestinations - Retrieve the Destinations for my orders.
- GetDiscounts - Retrieve the Discounts at this location.
- **GetEmployees - Retrieve the Employees for this location.
- GetItemGroups - Retrieve the Item Groups for this location.
- GetItems - Retrieve the Items for this location.
- **GetJobs - Retrieve the Jobs employees can clock in under for this location.
- GetLoyaltyRewards - Retrieve the Loyalty Rewards at this location.
- GetModifierCodes - Retrieve the Modifier Codes for this location.
- GetModifierGroups - Retrieve the Modifier Groups for this location.
- GetOptions - Retrieve the Options for this location.
- GetPettyAccounts - Retrieve the Petty Accounts for this location.
- GetPromotions - Retrieve the Promotions at this location.
- GetRegisters - Retrieve the Registers for this location.
- GetRevenueCenters - Retrieve the Revenue Centers for this location.
- GetSections - Retrieve the Sections for this location.
- GetSurcharges - Retrieve the Surcharges at this location.
- GetTaxes - Retrieve the Taxes at this location.
- GetTenders - Retrieve the Tenders for this location.
- GetVoidReasons - Retrieve the Void Reasons for this location.
**We recommend using Settings2.svc for the GetEmployees and GetJobs calls, as they are deprecated in Settings.svc.
Sending a Request to Settings.svc
All calls to Settings.svc require the AccessToken and the LocationToken in the request body. No other
parameters in the body or headers are necessary.
Settings.svc Endpoint
Endpoint
https://{{server}}.brinkpos.net/Settings.svc
Settings.svc Request Body
Data Name
Data Type
Data Description
AccessToken
string
Specify the AccessToken for your API account
LocationToken
string
Specify the LocationToken for the location you want to retrieve Settings from
Customfield Type
Data Name
Data Type
Data Description
Id
int
Unique Id of this customfield
FieldName
string
Name of the customfield
Value
string
Value for the customfield
This call is to retrieve an array of CashDrawer objects for the location.
CashDrawer Type
Data Name
Data Type
Data Description
CashInDrawerLimit
double
Amount in cash drawer above which register warning is triggered.
CashLimitWarningEnabled
bool
True if you would like register warning to come when cash in drawer limit is reached, False if not
DefaultBank
decimal
Default amount of cash for this CashDrawer
DrawerNumber
byte
Number of this CashDrawer
Id
int
Unique Id of this CashDrawer
IsCompulsory
bool
True if CashDrawer is compulsory, False if not
IsPublic
bool
True if CashDrawer is public, False if not
Name
string
Name of this CashDrawer
TerminalId
int
Id of the Terminal
TransactionFrequency
int
Number of transactions against the cash drawer post which the register warning is re-triggered.
Type
int
Returns one of the following:
- 0 = None
- 1 = Printerinterface
- 2 = OPOS
- 3 = Serial
- 4 = PosForDotNet
This call is to retrieve an array of DayPart objects for the location.
DayPart Type
Data Name
Data Type
Data Description
Id
int
Unique Id of this DayPart
Name
string
Name of this DayPart
StartTime
DateTime
Start time of this DayPart in the location's local time
This call is to retrieve an array of Destination objects for the location.
Destination Type
Data Name
Data Type
Data Description
Id
int
Unique Id of this Destination
Description
string
Description of this Destination
KitchenDescription
string
Kitchen description of this Destination
Name
string
Name of this Destination
This call is to retrieve an array of Discount objects at the location.
Discount Type
Data Name
Data Type
Data Description
Active
bool
True if this Discount is active, False if inactive
AllowLaterDiscounts
bool
True if this Discount can be applied to orders that have already been sent, False if not
AllowPriorDiscounts
bool
True if this Discount can be applied before items are populated on the order, False if not
Amount
decimal
New amount for the item this Discount is applied to
DiscountedItemsEligible
bool
True if already discounted items will be eligible for this Discount, False if not
EndDate
DateTime
End date after which this Discount will be discontinued
EnforceMaximumAmount
bool
True if this Discount amount will not be able to exceed MaximumAmount value, False if not enforced
EnforceMaximumItems
bool
True if this Discount will not be applied to items exceeding MaximumItems value, False if not enforced
EndTime
DateTime
End time after which this Discount will be discontinued
EnforceMaximumPerOrder
bool
True if this Discount per order will not be able to exceed MaximumPerOrder value, False if not enforced
ExcludeItemsFromProductMix
bool
True if items will be excluded from product mix, False if not
ExternalId
string
Stores the external identifier of a loyalty reward created via a loyalty provider outside the Brink System
Friday
bool
True if this Discount can be applied on Fridays, False if not
Granularity
DiscountGranularity
Returns one of the following:
- Order
- Items
Id
int
Unique Id of this Discount
IsEmployeeDiscount
bool
True if this Discount is an employee discount, False if not
IsLoyaltyDiscount
bool
True if this discount can only be applied via the redemption of a loyalty reward, False if not
ManagerNeeded
bool
True if this Discount requires manager approval, False if not
MaximumAmount
decimal
Maximum amount allowed for this Discount, 0 if null
MaximumItems
int
Maximum number of items Discount can be applied to, 0 if null
MaximumPerOrder
int
Maximum amount per order this Discount can be applied for, 0 if null
Monday
bool
True if this Discount can be applied on Mondays, False if not
MustEnterAmount
bool
True if entering an amount for this Discount is required, False if not
MustEnterName
bool
True if entering a name for this Discount is required, False if not
MustEnterPercent
bool
True if entering a percentage for this Discount is required, False if not
Name
string
Name of this Discount
OpenDrawer
bool
If True, drawer will open, False if not
PrintedName
string
Name of Discount printed on receipt
PrintOrder
bool
True if the order will be printed, False if not
Rate
decimal
Percentage of the Discount to be applied
Saturday
bool
True if this Discount can be applied on Saturdays, False if not
Sunday
bool
If True, Discount can be applied on Sundays, False if not
StartDate
DateTime
Start date of when this Discount can be applied
StartTime
DateTime
Start time of when this Discount can be applied
Thursday
bool
True if this Discount can be applied on Thursdays, False if not
Tuesday
bool
True if this Discount can be applied on Tuesdays, False if not
Type
DiscountType
Returns one of the following:
- None
- Comp
- New Price
- Max
UseDateRangeFilter
bool
True if this Discount can only be applied between StartDate and EndDate, False if not enforced
UseDayFilter
bool
True if this Discount can only be applied on specific days, False if not enforced
UseItemFilter
bool
True if this Discount can only be applied on designated item with EligibleItemId, False if not enforced
UseItemGroupFilter
bool
True if this Discount can only be applied on designated items within EligibleItemGroupIds, False if not enforced
UseTimeRangeFilter
bool
True if this Discount can only be applied between StartTime and EndTime, False if not enforced
Wednesday
bool
True if this Discount can be applied on Wednesdays, False if not
This call is to retrieve an array of Employee objects for the location.
Employee Type
Data Name
Data Type
Data Description
Address1
string
Employee's address
Address2
string
Employee's address
BirthDate
DateTime
Employee's birth date (the time component will always return as 00:00:00)
CellPhone
string
Employee's cell phone
City
string
Employee's city of residence
EmailAddress
string
Employee's email address
EmployeeUniqueId
Guid
Primary Key for Employee
FirstName
string
Employee's first name
HireDate
DateTime
Employee's hire date (the time component will always return as 00:00:00)
HomePhone
string
Employee's home phone
Id
int
Unique Id in Brink for this Employee
IdentificationVerified
bool
True if Employee's identity has been verified, False if not
LastName
string
Employee's last name
MaritalStatus
MaritalStatus
Returns one of the following:
- None
- Single
- Married
MiddleName
string
Employee's middle name
Name
string
Unique name for this Employee
Notes
string
Notes about this Employee
PayrollId
string
Unique payroll Id for this Employee
SSN
string
Employee's social security number
State
string
Employee's state of residence
TaxWithholdingAllowance
int
Number of withholding allowances claimed
Terminated
bool
True if Employee has been terminated, False if not
TerminationDate
DateTime
Employee's termination date, if applicable
Zip
string
Employee's zip code
EmployeeJob Type
Data Name
Data Type
Data Description
JobUniqueId
Guid
Primary Key for Job in
PayRate
decimal
Pay rate for the employee clocked in under this EmployeeJob
SecurityLevelUniqueId
Guid
Primary Key for SecurityLevel
This call is to retrieve an array of ItemGroup objects for the location.
ItemGroup Type
Data Name
Data Type
Data Description
AlternateId
string
Alternate or external Id for this ItemGroup, if applicable
Id
int
Unique Id of this ItemGroup
IsDeleted
bool
True if this ItemGroup has been deleted, False if not deleted
Name
string
Name of this ItemGroup
ItemGroupItem Type
Data Name
Data Type
Data Description
This call is to retrieve an array of Item objects for the location.
Item Type
Data Name
Data Type
Data Description
Active
bool
True if this Item is active, False if inactive
AskName
bool
True if this Item's name will be prompted for, False if not
AskPrice
bool
True if this Item's price will be prompted for, False if not
AvailableFriday
bool
Applies if AvailableSelectDays is true: True if this Item is available on Fridays, False if not
AvailableMonday
bool
Applies if AvailableSelectDays is true: True if this Item is available on Mondays, False if not
AvailableSaturday
bool
Applies if AvailableSelectDays is true: True if this Item is available on Saturdays, False if not
AvailableSelectDates
bool
True if this Item is available on select dates, False if not
AvailableSelectDays
bool
True if this Item is available on select days of the week, False if not
AvailableSunday
bool
Applies if AvailableSelectDays is true: True if this Item is available on Sundays, False if not
AvailableThursday
bool
Applies if AvailableSelectDays is true: True if this Item is available on Thursdays, False if not
AvailableTuesday
bool
Applies if AvailableSelectDays is true: True if this Item is available on Tuesdays, False if not
AvailableWednesday
bool
Applies if AvailableSelectDays is true: True if this Item is available on Wednesdays, False if not
Cost
decimal
Cost of this Item
CreatedTime
DateTime
Date and time of when this Item was created
DatesAvailable
DateRange
Applies if AvailableSelectDates is true: Start and end dates of when this Item is available
GiftCardItemType
GiftCardItemType
Returns one of the following:
- None
- CashOut
- Issue
- Reload
Id
int
Unique Id of this Item
IsCombo
bool
True if this Item is a combo item, False if not
IsDeleted
bool
True if this Item has been deleted, False if not
IsGiftCard
bool
True if this Item is a Gift Card, False if not
IsQuantityCounted
bool
True if this Item quantity is counted, False if not
ItemType
ItemType
Returns one of the following:
- Normal
- Pizza
- Chicken
- GiftCard
- Composite
- LoyaltyItem
- Prepaid
- CompCard
KitchenName
string
Display name in the Kitchen for this Item
LastEditedTime
DateTime
Date and time of when this Item was most recently edited
ModifierGroupIds
IdList
Maps to the Id(s) of the ModifierGroup(s) that are to be available when the item is ordered or modified.
ModifierTierId
int
Modifier Tier Id, or 0 if null
ModifierWeight
byte
Modifier weight
Name
string
Name of this Item
NonRevenueItem
bool
True if this Item is a non-revenue Item, bold if not
PLU
string
Price look-up code of this Item
Price
decimal
Price of this Item
PriceLevel
byte
Price Level, or 0 if null
PricePer
PricePer
Returns one of the following:
- Ounce
- Pound
PrinterGroupId
int
Printer group Id for this Item, or 0 if null
SortPriority
byte
Sort priority of this Item
TareId
int
Tare Id of this Item
UnitName
string
Unit name for this Item
UnitPrecision
byte
Unit precision for this Item
VideoGroupId
int
Video group Id for this Item, or 0 if null
ItemBrandAllocation Type
Data Name
Data Type
Data Description
BrandId
int
Id of the brand for this ItemBrandAllocation
Id
int
Unique Id of this ItemBrandAllocation
Weight
decimal
Weight of this ItemBrandAllocation
ItemCompositeComponent Type
Data Name
Data Type
Data Description
Id
int
Unique Id of this ItemCompositeComponent
Name
string
Name of this ItemCompositeComponent
Price
decimal?
Price of this ItemCompositeComponent
RollupPrice
bool
True if the price of this ItemCompositeComponent should be rolled up, False if not
ItemCompositeComponentItem Type
Data Name
Data Type
Data Description
Id
int
Unique Id of this ItemCompositeComponentItem
IsDefault
bool
True if this ItemCompositeComponentItem is the default, False if not
Price
decimal?
Price of this ItemCompositeComponentItem
ItemIncludedModifier Type
Data Name
Data Type
Data Description
AutomaticallyAdd
bool
True if this Modifier is automatically added to the order, False if not
IsIncluded
bool
True if this Modifier is included on the order, False if not
Position
short
Ordering position of the Modifier within the Modifier Group
PrintInKitchen
bool
True if this Modifier will print on the kitchen chits, False if not
This call is to retrieve an array of Job objects for the location.
Job Type
Data Name
Data Type
Data Description
Id
int
Unique Id of this Job
JobUniqueId
Guid
Primary Key for Job
Name
string
Name of this Job
This call is to retrieve an array of LoyaltyReward objects for the location. There are four types of
LoyaltyRewards: DiscountReward, GiftCardReward, PromotionReward, VoucherReward.
LoyaltyReward - DiscountReward Type
Data Name
Data Type
Data Description
IsActive
bool
True if this DiscountReward is active, False if not
Id
int
Unique Id of this DiscountReward
IsDeleted
bool
True if this DiscountReward is deleted, False if not
Name
string
Name of this DiscountReward
Type
byte
Returns: 0 = DiscountReward
DiscountId
int
Maps to the Id of the Discount of this DiscountReward
LoyaltyReward - GiftCardReward Type
Data Name
Data Type
Data Description
IsActive
bool
True if this GiftCardReward is active, False if not
Id
int
Unique Id of this GiftCardReward
IsDeleted
bool
True if this GiftCardReward is deleted, False if not
Name
string
Name of this GiftCardReward
Type
byte
Returns: 2 = GiftCard
Amount
decimal
Amount of this GiftCardReward
LoyaltyReward - PromotionReward Type
Data Name
Data Type
Data Description
IsActive
bool
True if this PromotionReward is active, False if not
Id
int
Unique Id of this PromotionReward
IsDeleted
bool
True if this PromotionReward is deleted, False if not
Name
string
Name of this PromotionReward
Type
byte
Returns: 1 = Promotion
LoyaltyReward - VoucherReward Type
Data Name
Data Type
Data Description
IsActive
bool
True if this VoucherReward is active, False if not
Id
int
Unique Id of this VoucherReward
IsDeleted
bool
True if this VoucherReward is deleted, False if not
Name
string
Name of this VoucherReward
Type
byte
Returns: 4 = Voucher
This call is to retrieve an array of ModifierCode objects for the location.
ModifierCode Type
Data Name
Data Type
Data Description
Abbreviation
string
Abbreviation for this ModifierCode
Active
boolean
True if this ModifierCode is active, False if inactive
AppliesTo
ModCodeIngredientType
Returns one of the following:
- Ingredients
- NonIngredients
- Both
Id
int
Unique Id of this ModifierCode
IsDeleted
boolean
True if ModifierCode is deleted, False if not
IsSystem
boolean
Default is False (deprecated)
Name
string
Name of this ModifierCode
Type
ModCodeType
Returns one of the following:
- Normal
- No
- For
- Sub
- OnSide
This call is to retrieve an array of ModifierGroup objects for the location.
ModifierGroup Type
Data Name
Data Type
Data Description
Description
string
Description of this ModifierGroup
DisplayName
string
Display name for this ModifierGroup
Free
byte
Number of free modifiers within this ModifierGroup allowed before charged
Id
int
Unique Id of this ModifierGroup
IsDeleted
bool
True if ModifierGroup is deleted, False if not
FlowRequired
bool
True if flow required, False if not
Maximum
byte
Maximum number of modifiers allowed from this ModifierGroup
Minimum
byte
Minimum number of modifiers allowed from this ModifierGroup
Name
string
Name of this ModifierGroup
PanelId
int
Panel Id for this ModifierGroup
ModifierGroupItem Type
Data Name
Data Type
Data Description
Position
short
Position of this ModifierGroupItem
Price
decimal
Price of this ModifierGroupItem
PriceMethod
byte
Returns one of the following:
- 0 = ItemPrice
- 1 = ModifierPrice
This call is to retrieve a LocationOptions object for the location.
GetOptions Response
Data Name
Data Type
Data Description
Accounting
Contains tabs with settings that pertain to how various accounting activities are recorded and calculated.
Printing
Contains tabs with controls that pertain to how the system prints receipts, chits, credit drafts, and other related items.
AccountingOptions Type
Data Name
Data Type
Data Description
GLExport
Defines how sales data is to be mapped to general ledger account numbers in the various export formats.
LocationOptions Type
Data Name
Data Type
Data Description
Address1
string
Location address
Address2
string
Location address
City
string
Location city
Country
string
Location country
Fax
string
Location fax
Latitude
decimal
Location latitude
Longitude
decimal
Location longitude
Name
string
Location name
Phone
string
Location phone
State
string
Location state
TimeZone
TimeZone
Returns the name of the TimeZone of the location
Zip
string
Location zip code
PrintingOptions Type
Data Name
Data Type
Data Description
GLExport Type
Data Name
Data Type
Data Description
Name
string
Name of the GLExport
RevenueCenters
Array of GLExportRevenueCenter Account
Contains details about GLExportRevenueCenterAccount
CreditOptions Type
Data Name
Data Type
Data Description
IsSuggestedTipActive
bool
True if prints suggested tip calculations on the credit drafts, False if not
SuggestedTipOne
short?
Prints suggested tip 1 on the credit drafts as a percent of the order total
SuggestedTipThree
short?
Prints suggested tip 2 on the credit drafts as a percent of the order total
SuggestedTipTwo
short?
Prints suggested tip 3 on the credit drafts as a percent of the order total
GLExportDiscountAccount Type
Data Name
Data Type
Data Description
Class
string
Class corresponding to GLExport record which maybe included in various sales export formats
CreditAccount
string
GL account to be credited.
DebitAccount
string
GL account to be debited.
Memo
string
Memo corresponding to GLExport record which maybe included in various sales export formats
Name
string
Name corresponding to GLExport record which maybe included in various sales export formats
DiscountId
int
Id of the GLExportDiscount
GLExportOtherAccount Type
Data Name
Data Type
Data Description
Class
string
Class corresponding to GLExport record which maybe included in various sales export formats
CreditAccount
string
GL account to be credited.
DebitAccount
string
GL account to be debited.
Memo
string
Memo corresponding to GLExport record which maybe included in various sales export formats
Name
string
Name corresponding to GLExport record which maybe included in various sales export formats
Type
int
Type of the GLExportOtherAccount
GLExportPettyAccount Type
Data Name
Data Type
Data Description
Class
string
Class corresponding to GLExport record which maybe included in various sales export formats
CreditAccount
string
GL account to be credited.
DebitAccount
string
GL account to be debited.
Memo
string
Memo corresponding to GLExport record which maybe included in various sales export formats
Name
string
Name corresponding to GLExport record which maybe included in various sales export formats
PettyAccountId
int
Id of the GLExportPettyAccount
GLExportPromotionAccount Type
Data Name
Data Type
Data Description
Class
string
Class corresponding to GLExport record which maybe included in various sales export formats
CreditAccount
string
GL account to be credited.
DebitAccount
string
GL account to be debited.
Memo
string
Memo corresponding to GLExport record which maybe included in various sales export formats
Name
string
Name corresponding to GLExport record which maybe included in various sales export formats
PromotionId
int
Id of the GLExportPromotion
GLExportRevenueCenterAccount Type
Data Name
Data Type
Data Description
Class
string
Class corresponding to GLExport record which maybe included in various sales export formats
CreditAccount
string
GL account to be credited.
DebitAccount
string
GL account to be debited.
Memo
string
Memo corresponding to GLExport record which maybe included in various sales export formats
Name
string
Name corresponding to GLExport record which maybe included in various sales export formats
RevenueCenterId
int
Id of the GLExportRevenueCenters
GLExportSurchargeAccount Type
Data Name
Data Type
Data Description
Class
string
Class corresponding to GLExport record which maybe included in various sales export formats
CreditAccount
string
GL account to be credited.
DebitAccount
string
GL account to be debited.
Memo
string
Memo corresponding to GLExport record which maybe included in various sales export formats
Name
string
Name corresponding to GLExport record which maybe included in various sales export formats
SurchargeId
int
Id of the GLExportSurcharges
GLExportTaxAccount Type
Data Name
Data Type
Data Description
Class
string
Class corresponding to GLExport record which maybe included in various sales export formats
CreditAccount
string
GL account to be credited.
DebitAccount
string
GL account to be debited.
Memo
string
Memo corresponding to GLExport record which maybe included in various sales export formats
Name
string
Name corresponding to GLExport record which maybe included in various sales export formats
TaxId
int
Id of the GLExportTax
GLExportTenderAccount Type
Data Name
Data Type
Data Description
Class
string
Class corresponding to GLExport record which maybe included in various sales export formats
CreditAccount
string
GL account to be credited.
DebitAccount
string
GL account to be debited.
Memo
string
Memo corresponding to GLExport record which maybe included in various sales export formats
Name
string
Name corresponding to GLExport record which maybe included in various sales export formats
TenderId
int
Id of the GLExportTender
This call is to retrieve an array of PettyAccount objects for the location.
PettyAccount Type
Data Name
Data Type
Data Description
AccountType
PettyAccountType
Returns one of the following:
- CashIn
- CashOut
Id
int
Unique Id of this PettyAccount
Name
string
Name of this PettyAccount
This call is to retrieve an array of Promotion objects at the location.
Promotion Type
Data Name
Data Type
Data Description
Active
bool
True if this Promotion is active, False if inactive
AlternateId
string
AlternateId for this Promotion provided for customer integration
CustomFields
Array of CustomFields
Dictionary of User Defined key value pair.(Save of this field from API is in future scope)
Id
int
Unique Id of this Promotion
Name
string
Unique name of this Promotion
Type
PromotionType
Returns one of the following:
- Bogo
- OrderReduction
- Coupon
- GiftCard
- Combo
This call is to retrieve an array of Register objects for the location.
Register Type
Data Name
Data Type
Data Description
Id
int
Unique Id of this Register
Name
string
Name of this Register
Number
int
Number of this Register
This call is to retrieve an array of RevenueCenter objects for the location.
RevenueCenter Type
Data Name
Data Type
Data Description
Active
bool
True if this RevenueCenter is active, False if inactive
Id
int
Unique Id of this RevenueCenter
Name
string
Name of this RevenueCenter
This call is to retrieve an array of Section objects for the location.
Section Type
Data Name
Data Type
Data Description
Id
int
Unique Id of this Section
Name
string
Name of this Section
This call is to retrieve an array of Surcharge objects at the location.
Surcharge Type
Data Name
Data Type
Data Description
Amount
decimal
Amount of this Surcharge
AutomaticallyApply
boolean
True if this Surcharge is automatically applied, False if not
Days
int
Returns an int describing the days this Surcharge applies:
If multiple days are selected, binary addition is used in determining this value.
- 0 = None
- 1 = Sunday
- 2 = Monday
- 4 = Tuesday
- 8 = Wednesday
- 16 = Thursday
- 32 = Friday
- 64 = Saturday
If multiple days are selected, binary addition is used in determining this value.
EndDate
DateTime
Applies if EnforceDateRanges is true: End date for when this Surcharge is enforced
EndTime
DateTime
Applies if EnforceTimeRanges is true: End time for when this Surcharge is enforced
EnforceDateRanges
boolean
True if this Surcharge is enforced within a specified date range, False if not
EnforceDays
boolean
True if this Surcharge is enforced on specific days, False if not
EnforcePartySize
boolean
True if this Surcharge is enforced within a specified date range, False if not
EnforceTimeRanges
boolean
True if this Surcharge is enforced within a specified time range, False if not
Id
int
Unique Id of this Surcharge
LimitDestinations
boolean
True if this Surcharge is limited to ValidDestinationIds, False if not
LimitSections
boolean
True if this Surcharge is limited to ValidSectionIds, False if not
MaximumPartySize
int
Applies if EnforcePartySize is true: Maximum party size for which this Surcharge is enforced, 0 if null
Method
int
-
Returns one of the following:
- 0 = Fixed Per Order
- 1 = Percentage Per Order
- 2 = Fixed Per Item
- 3 = Percentage Per Item
MinimumPartySize
int
Applies if EnforcePartySize is true: Minimum party size for which this Surcharge is enforced, 0 if null
Name
string
Name of this Surcharge
Prompt
boolean
True if this Surcharge is prompted, False if not
StartDate
DateTime
Applies if EnforceDateRanges is true: Start date for when this Surcharge is enforced
StartTime
DateTime
Applies if EnforceTimeRanges is true: Start time for when this Surcharge is enforced
TerminalTypes
int
Returns a byte describing the terminal the values this Surcharge applies to:
- 0 = None
- 1 = Register
- 2 = Web Ordering
- 8 = Web Mobile Ordering
- 16 = Web-Service
- 32 = Mobile App
Type
Int
Returns one of the following:
- 0 = ServiceCharge
- 1 = Gratuity
- 2 = NonCashAdjustment
ValidDestinationIds
IdList
Applies if LimitDestinations is true: Maps to the Id(s) of the Destination(s) this Surcharge is limited to
ValidSectionIds
IdList
Applies if LimitDestinations is true: Maps to the Id(s) of the Section(s) this Surcharge is limited to
This call is to retrieve an array of Tax objects at the location.
Tax Type
Data Name
Data Type
Data Description
Amount
decimal
Amount of this Tax
Id
int
Unique Id of this Tax
Name
string
Name of this Tax
Type
int
Returns one of the following:
- 0 = None
- 1 = Percentage
- 2 = FlatFee
This call is to retrieve an array of Tender objects for the location.
Tender Type
Data Name
Data Type
Data Description
Active
bool
True if this Tender is active, False if inactive
AllowChange
bool
True if change is allowed for this Tender, False if not
AllowTips
bool
True if tips are allowed for this Tender, False if not
CardType
CardType
Returns one of the following:
- 0 = None
- 1 = MasterCard
- 2 = Visa
- 3 = American Express
- 4 = Diners Club
- 5 = Discover
- 6 = enRoute
- 7 = JCB
- 8 = Private
- 9 = CashBenefit
- 10 = FoodBenefit
DefaultAmount
decimal
Default amount for this Tender
Id
int
Unique Id of this Tender
MaximumAccountDigits
sbyte
Maximum amount of digits for this Tender's account number, if applicable
MaxTipPercent
decimal
Maximum tip percentage allowed for this Tender
MinimumAccountDigits
sbyte
Minimum amount of digits for this Tender's account number, if applicable
Name
string
Name of this Tender
OpenDrawer
boolean
True if drawer will open for this Tender, False if not
ReconciliationMethod
ReconciliationMethod
Returns one of the following:
- Details
- Totals
RequiresAuthorization
bool
True if this Tender's use requires authorization, False if not
SignatureCapture
bool
True if this Tender's use requires signature capture, False if not
TenderType
TenderType
Returns one of the following:
- None
- Cash
- CreditCard
- GiftCard
- GiftCertificate
- Check
- HouseAccount
- External
- Debit
- EBT
VarianceAmount
decimal
Variance amount for this Tender
This call is to retrieve an array of VoidReason objects for the location.
VoidReason Type
Data Name
Data Type
Data Description
Id
int
Unique Id of this VoidReason
Name
string
Name of this VoidReason
GetCashDrawers Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetCashDrawers.SettingsServiceReference;
namespace Settings_GetCashDrawers
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetCashDrawers call
var response = client.GetCashDrawers(accessToken, locationToken);
//If call is successful, loop through collection of CashDrawer objects returned
foreach (var item in response)
{
Console.WriteLine("Cash Drawer #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("TerminalId: " + item.TerminalId);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("CashInDrawerLimit: " + item.CashInDrawerLimit);
Console.WriteLine("CashLimitWarningEnabled: " + item.CashLimitWarningEnabled);
Console.WriteLine("DefaultBank: " + item.DefaultBank);
Console.WriteLine("DrawerNumber: " + item.DrawerNumber);
Console.WriteLine("IsCompulsory: " + item.IsCompulsory);
Console.WriteLine("IsPublic: " + item.IsPublic);
Console.WriteLine("TransactionFrequency: " + item.TransactionFrequency);
Console.WriteLine("Type: " + item.Type);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetDayParts Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetDayParts.SettingsServiceReference;
namespace Settings_GetDayParts
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetDayParts call
var response = client.GetDayParts(accessToken, locationToken);
//If call is successful, loop through collection of DayPart objects returned
foreach (var item in response)
{
Console.WriteLine("DayPart #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("StartTime: " + item.StartTime);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetDestinations Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetDestinations.SettingsServiceReference;
namespace Settings_GetDestinations
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetDestinations call
var response = client.GetDestinations(accessToken, locationToken);
//If call is successful, loop through collection of Destination objects returned
foreach (var item in response)
{
Console.WriteLine("Destination #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Description: " + item.Description);
Console.WriteLine("KitchenDescription: " + item.KitchenDescription);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetDiscounts Minified Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetDiscounts.SettingsServiceReference;
namespace Settings_GetDiscounts
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetDiscounts call
var response = client.GetDiscounts(accessToken, locationToken);
//If call is successful, loop through collection of Discount objects returned
foreach (var item in response)
{
Console.WriteLine("Discount #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Amount: " + item.Amount);
Console.WriteLine("Rate: " + item.Rate);
Console.WriteLine("Type: " + item.Type);
Console.WriteLine("Active: " + item.Active);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetEmployees Minified Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetEmployees.SettingsServiceReference;
namespace Settings_GetEmployees
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetEmployees call
var response = client.GetEmployees(accessToken, locationToken);
//If call is successful, loop through collection of Employee objects returned
foreach (var item in response)
{
Console.WriteLine("Employee #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Jobs:");
//Loop through collection of EmployeeJob objects returned
if (item.Jobs.Count > 0)
{
foreach (var job in item.Jobs)
{
Console.WriteLine("\tJobId: " + job.JobId);
Console.WriteLine("\tPayRate: " + job.PayRate);
Console.WriteLine("\tSecurityLevelId: " + job.SecurityLevelId);
Console.WriteLine("\t------------");
}
}
Console.WriteLine("PayrollId: " + item.PayrollId);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetItemGroups Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetItemGroups.SettingsServiceReference;
namespace Settings_GetItemGroups
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetItemGroups call
var response = client.GetItemGroups(accessToken, locationToken);
//If call is successful, loop through collection of ItemGroup objects returned
foreach (var item in response)
{
Console.WriteLine("Item Group #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("AlternateId: " + item.AlternateId);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("IsDeleted: " + item.IsDeleted);
Console.WriteLine("Items:");
//Loop through ItemGroupItems objects returned
if (item.Items.Length > 0)
{
foreach (var groupItem in item.Items)
{
Console.WriteLine("\tItemId: " + groupItem.ItemId);
}
}
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.Read();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetItems Minified Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetItems.SettingsServiceReference;
namespace Settings_GetItems
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetItems call
var response = client.GetItems(accessToken, locationToken);
//If call is successful, loop through collection of Item objects returned
foreach (var item in response)
{
Console.WriteLine("Item #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("PLU: " + item.PLU);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Price: " + item.Price);
Console.WriteLine("Active: " + item.Active);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetJobs Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetJobs.SettingsServiceReference;
namespace Settings_GetJobs
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetJobs call
var response = client.GetJobs(accessToken, locationToken);
//If call is successful, loop through collection of Job objects returned
foreach (var item in response)
{
Console.WriteLine("Job #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("JobUniqueId: " + item.JobUniqueId);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetLoyaltyRewards Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using System.ServiceModel.Channels;
using Settings_GetLoyaltyRewards.SettingsServiceReference;
namespace Settings_GetLoyaltyRewards
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetLoyaltyRewards call
var response = client.GetLoyaltyRewards(accessToken, locationToken);
//If call is successful, loop through collection of LoyaltyReward objects returned
foreach (var item in response.OfType<DiscountReward>())
{
Console.WriteLine("Loyalty Reward #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Type: " + item.Type);
Console.WriteLine("IsActive: " + item.IsActive);
Console.WriteLine("IsDeleted: " + item.IsDeleted);
Console.WriteLine("---------------------------");
count++;
}
foreach (var item in response.OfType<GiftCardReward>())
{
Console.WriteLine("Loyalty Reward #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Type: " + item.Type);
Console.WriteLine("IsActive: " + item.IsActive);
Console.WriteLine("IsDeleted: " + item.IsDeleted);
Console.WriteLine("Amount: " + item.Amount);
Console.WriteLine("---------------------------");
count++;
}
foreach (var item in response.OfType<PromotionReward>())
{
Console.WriteLine("Loyalty Reward #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Type: " + item.Type);
Console.WriteLine("IsActive: " + item.IsActive);
Console.WriteLine("IsDeleted: " + item.IsDeleted);
Console.WriteLine("PromotionId: " + item.PromotionId);
Console.WriteLine("---------------------------");
count++;
}
foreach (var item in response.OfType<VoucherReward>())
{
Console.WriteLine("Loyalty Reward #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Type: " + item.Type);
Console.WriteLine("IsActive: " + item.IsActive);
Console.WriteLine("IsDeleted: " + item.IsDeleted);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetModifierCodes Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetModifierCodes.SettingsServiceReference;
using Exception = System.Exception;
namespace Settings_GetModifierCodes
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetModifierCodes call
var response = client.GetModifierCodes(accessToken, locationToken);
//If call is successful, loop through collection of ModifierCode objects returned
foreach (var item in response)
{
Console.WriteLine("Modifier Code #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Abbreviation: " + item.Abbreviation);
Console.WriteLine("Type: " + item.Type);
Console.WriteLine("AppliesTo: " + item.AppliesTo);
Console.WriteLine("Active: " + item.Active);
Console.WriteLine("IsSystem: " + item.IsSystem);
Console.WriteLine("IsDeleted: " + item.IsDeleted);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetModifierGroups Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetModifierGroups.SettingsServiceReference;
namespace Settings_GetModifierGroups
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetModifierGroups call
var response = client.GetModifierGroups(accessToken, locationToken);
//If call is successful, loop through collection of ModifierGroup objects returned
foreach (var item in response)
{
Console.WriteLine("Modifier Group #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Description: " + item.Description);
Console.WriteLine("DisplayName: " + item.DisplayName);
Console.WriteLine("Items:");
//Loop through collection of ModifierGroupItem objects returned
if (item.Items != null)
{
foreach (var modifierGroupItem in item.Items)
{
Console.WriteLine("\tPosition: " + modifierGroupItem.Position);
Console.WriteLine("\tItemId: " + modifierGroupItem.ItemId);
Console.WriteLine("\tPrice: " + modifierGroupItem.Price);
Console.WriteLine("\tPriceMethod: " + modifierGroupItem.PriceMethod);
Console.WriteLine("\t------------");
}
}
Console.WriteLine("Minimum: " + item.Minimum);
Console.WriteLine("Maximum: " + item.Maximum);
Console.WriteLine("Free: " + item.Free);
Console.WriteLine("PanelId: " + item.PanelId);
Console.WriteLine("FlowRequired: " + item.FlowRequired);
Console.WriteLine("IsDeleted: " + item.IsDeleted);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetOptions Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetOptions.SettingsServiceReference;
namespace Settings_GetOptions
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetOptions call
var response = client.GetOptions(accessToken, locationToken);
var location = response.Location;
//If call is successful, list Location details
Console.WriteLine("Name: " + location.Name);
Console.WriteLine("Address1: " + location.Address1);
Console.WriteLine("Address2: " + location.Address2);
Console.WriteLine("City: " + location.City);
Console.WriteLine("State: " + location.State);
Console.WriteLine("Zip: " + location.Zip);
Console.WriteLine("Country: " + location.Country);
Console.WriteLine("Latitude: " + location.Latitude);
Console.WriteLine("Longitude: " + location.Longitude);
Console.WriteLine("Phone: " + location.Phone);
Console.WriteLine("Fax: " + location.Fax);
Console.WriteLine("TimeZone: " + location.TimeZone);
Console.WriteLine("---------------------------");
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetPettyAccounts Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetPettyAccounts.SettingsServiceReference;
namespace Settings_GetPettyAccounts
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetPettyAccounts call
var response = client.GetPettyAccounts(accessToken, locationToken);
//If call is successful, loop through collection of PettyAccount objects returned
foreach (var item in response)
{
Console.WriteLine("Petty Account #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("AccountType: " + item.AccountType);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetPromotions Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetPromotions.SettingsServiceReference;
namespace Settings_GetPromotions
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetPromotions call
var response = client.GetPromotions(accessToken, locationToken);
//If call is successful, loop through collection of Promotion objects returned
foreach (var item in response)
{
Console.WriteLine("Promotion #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("AlternateId: " + item.AlternateId);
if (item.CustomFields != null)
{
foreach (var customfield in item.CustomFields)
{
Console.WriteLine("customfield: ");
Console.WriteLine("\tId: " + customfield.Id);
Console.WriteLine("\tFieldName: " + customfield.FieldName);
Console.WriteLine("\tValue: " + customfield.Value);
Console.WriteLine("\t-----------------------");
}
}
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Active: " + item.Active);
Console.WriteLine("Type: " + item.Type);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetRegisters Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetRegisters.SettingsServiceReference;
namespace Settings_GetRegisters
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetRegisters call
var response = client.GetRegisters(accessToken, locationToken);
//If call is successful, loop through collection of Register objects returned
foreach (var item in response)
{
Console.WriteLine("Register #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Number: " + item.Number);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetRevenueCenters Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetRevenueCenters.SettingsServiceReference;
namespace Settings_GetRevenueCenters
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetRevenueCenters call
var response = client.GetRevenueCenters(accessToken, locationToken);
//If call is successful, loop through collection of RevenueCenter objects returned
foreach (var item in response)
{
Console.WriteLine("Revenue Center #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("TaxIds:");
//Loop through TaxIds returned
if (item.TaxIds != null)
{
foreach (var id in item.TaxIds)
{
Console.WriteLine("\tId: " + id);
}
}
Console.WriteLine("Active: " + item.Active);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetSections Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetSections.SettingsServiceReference;
namespace Settings_GetSections
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetSections call
var response = client.GetSections(accessToken, locationToken);
//If call is successful, loop through collection of Section objects returned
foreach (var item in response)
{
Console.WriteLine("Section #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetSurcharges Minified Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetSurcharges.SettingsServiceReference;
namespace Settings_GetSurcharges
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetSurcharges call
var response = client.GetSurcharges(accessToken, locationToken);
//If call is successful, loop through collection of Surcharge objects returned
foreach (var item in response)
{
Console.WriteLine("Surcharge #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Amount: " + item.Amount);
Console.WriteLine("AutomaticallyApply: " + item.AutomaticallyApply);
Console.WriteLine("Method: " + item.Method);
Console.WriteLine("Type: " + item.Type);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetTaxes Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetTaxes.SettingsServiceReference;
namespace Settings_GetTaxes
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetTaxes call
var response = client.GetTaxes(accessToken, locationToken);
//If call is successful, loop through collection of Tax objects returned
foreach (var item in response)
{
Console.WriteLine("Tax #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("Amount: " + item.Amount);
Console.WriteLine("Type: " + item.Type);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetTenders Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetTenders.SettingsServiceReference;
namespace Settings_GetTenders
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetTenders call
var response = client.GetTenders(accessToken, locationToken);
//If call is successful, loop through collection of Tender objects returned
foreach (var item in response)
{
Console.WriteLine("Tender #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("DefaultAmount: " + item.DefaultAmount);
Console.WriteLine("Active: " + item.Active);
Console.WriteLine("TenderType: " + item.TenderType);
Console.WriteLine("CardType: " + item.CardType);
Console.WriteLine("ReconciliationMethod: " + item.ReconciliationMethod);
Console.WriteLine("MinimumAccountDigits: " + item.MinimumAccountDigits);
Console.WriteLine("MaximumAccountDigits: " + item.MaximumAccountDigits);
Console.WriteLine("MaxTipPercent: " + item.MaxTipPercent);
Console.WriteLine("VarianceAmount:" + item.VarianceAmount);
Console.WriteLine("AllowChange: " + item.AllowChange);
Console.WriteLine("AllowTips: " + item.AllowTips);
Console.WriteLine("OpenDrawer: " + item.OpenDrawer);
Console.WriteLine("RequiresAuthorization: " + item.RequiresAuthorization);
Console.WriteLine("SignatureCapture: " + item.SignatureCapture);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}
GetVoidReasons Sample Code
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;
using Settings_GetVoidReasons.SettingsServiceReference;
namespace Settings_GetVoidReasons
{
class Program
{
static void Main(string[] args)
{
//Connect to Settings service client
var client = new SettingsWebServiceClient();
//Set security protocol to TLS 1.2
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
using (var scope = new OperationContextScope(client.InnerChannel))
{
//Include tokens in request body
String accessToken = @"AccessToken";
String locationToken = @"LocationToken";
int count = 1;
try
{
//Make GetVoidReasons call
var response = client.GetVoidReasons(accessToken, locationToken);
//If call is successful, loop through collection of VoidReason objects returned
foreach (var item in response)
{
Console.WriteLine("Void Reason #" + count);
Console.WriteLine("---------------------------");
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("Name: " + item.Name);
Console.WriteLine("---------------------------");
count++;
}
Console.WriteLine("End");
Console.ReadKey();
}
catch (Exception e)
{
Console.WriteLine("Error Message: " + e.Message);
Console.ReadKey();
}
}
}
}
}