GetSettings

​

This call is to retrieve multiple Settings for the location.

Note: Our recommended approach to obtain settings (currently only supports Settings2.svc) is using GetSettings call so that you can grab all the newly upgraded settings.

Request Parameters
  • DataTypes Array of DataType — See DataType field for more information. Depending on the DataType(-s) inserted the response will return that (those) setting(-s)
DataType Properties
  • DataType DataType — Specify one or more DataType you would like to retrieve. You can choose one of the following:
    • Employee
    • Job
    • Permission
    • SecurityLevel
    • KitchenQueue
    • FutureOrderingOptions
    • Menu
    • OnlineOrderingMenuOptions
    • PriceChange
    • Promotion
    • Table
    • Brand
    • Printer
    • MenuItem
    • PaymentOptions
    • PrinterGroup
    • PriceLevel
    • ModifierTiers
    • KitchenVideoGroups
    • Panels
    • Screens
    • Tares
    • MarketingCampaigns
Response Parameters

  • Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.

  • ResultCode int — Returns one of the following:

    • 0 = Request went through successfully
    • 1 = Request returned an unknown error
    • 2 = Request was not valid
    • 3 = Server is currently unavailable and unable to receive the request
    • 4 = Access Denied

  • Settings Settings object — Settings with the DataType you spefified

    Settings Properties

    • Employees Array of Employee — Employees for the location if specified

      Employee Properties

      • Address1 string — Employee's address

      • Address2 string — Employee's address

      • AlternateId string — Alternate external Id for this Employee

      • BirthDate DateTime? — Employee's birth date

      • CanLoginWithCard bool — True if Employee can login with a card, False if not

      • CanLoginWithFinger bool — True if Employee can login with their fingerprint, False if not

      • CanLoginWithPin bool — True if Employee can login with their PIN, False if not

      • CardNumber string — Employee's card number

      • CellPhone string — Employee's cell phone number

      • City string — Employee's city of residence

      • ClockedInDiscountId int? — Employee's discount Id when clocked in

      • ClockedOutDiscountId int? — Employee's discount Id when clocked out

      • DisplayName string — Employee's display name on the register

      • EmployeeUniqueId Guid — Employee's unique identifier

      • EmailAddress string — Employee's email address

      • ExportToPayroll bool — True if Employee should be exported to payroll, False if not

      • FirstName string — Employee's first name

      • HealthCardExpirationDate DateTime? — Date of expiration for the Employee's health card

      • HireDate DateTime? — Employee's hire date

      • HomeLocationId Guid? — Unique identifier of the Employee's home location

      • HomePhone string — Employee's home phone

      • Id int — Unique Id of this Employee

      • IdentificationVerified bool — True if Employee's identity has been verified, False if not

      • IsExempt bool — True if Employee is tax exempt, False if not

      • IsSalaried bool — True if Employee is salaried, False if not

      • Jobs Array of EmployeeJob — Jobs assigned to this Employee

        EmployeeJob Properties
        • JobId int — Maps to the Id of the Job assigned to this Employee
        • JobUniqueId Guid — Unique identifier of the Job assigned to this Employee
        • PayRate decimal — Pay rate for this Employee in this Job
        • SecurityLevelId int — Maps to the Id of the SecurityLevel for this EmployeeJob
        • SecurityLevelUniqueId Guid — Unique identifier of the SecurityLevel for this EmployeeJob

      • LastName string — Employee's last name

      • LimitLocations bool — True if Employee's locations are limited, False if not

      • MaritalStatus byte — 0=None, 1=Single, 2=Married

      • MaximumDailyDiscountAmount decimal — Maximum daily discount amount this Employee is allowed

      • MaximumDailyDiscountCount int — Maximum daily discount count this Employee is allowed

      • Name string — Employee's full name

      • Notes string — Notes about this Employee

      • PayrollId string — Unique payroll Id for this Employee

      • Permissions Array of EmployeePermission — Permissions assigned to this Employee

        EmployeePermission Properties
        • PermissionId int — Maps to the Id of the Permission granted to this Employee
        • PermissionUniqueId Guid — Unique identifier of the Permission granted to this Employee

      • Pin string — PIN of this Employee. This value will always be null when returned.

      • SecondaryAuthPin string — Secondary Authentication PIN of 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

      • ValidLocations Array of EmployeeLocation — Valid locations this Employee can work at

        EmployeeLocation Properties
        • LocationId Guid — Unique identifier of the Location this Employee is allowed to work at

      • Zip string — Employee's zip code

    • FutureOrderingOptions FutureOrderingOptions — FutureOrderingOptions for the location if specified

      FutureOrderingOptions Properties

      • AllowFutureDateOrdering bool — True if future ordering is allowed at this location, False if not

      • Destinations Array of OnlineOrderingDestination — Destinations that future ordering can be directed to

        OnlineOrderingDestination Properties
        • DestinationId int — Maps to the Id of the Destination available for online ordering
        • Instructions string — Instructions for this OnlineOrderingDestination
        • IsDefault bool — True if this is the default destination for online ordering, False if not

      • IsEnabled bool — True if future ordering is enabled, False if not

      • LeadTimeThresholds Array of LeadTimeThreshold — Lead time thresholds

        LeadTimeThreshold Properties
        • LeadMinutes int — Lead time in minutes for this threshold

      • MaximumDaysInAdvance short — Maximum days in advance a future order can be placed

      • MinimumLeadMinutes short — Minimum amount of time that the order pickup time needs to be from placement time

      • MinimumPrepMinutes short — Minimum amount of time before the order pickup time at which the order is opened on the register and sent to the kitchen

      • PrepTimeThresholds Array of PrepTimeThreshold — Prep time thresholds

        PrepTimeThreshold Properties
        • PrepMinutes int — Prep time in minutes for this threshold

      • RequiredDepositPercent byte — Percent amount of deposit required for a future order

    • Brands Array of Brand — Brands for the location if specified

      Brand Properties
      • Id int — Unique Id of this Brand
      • Name string — Name of this Brand

    • Jobs Array of Job — Jobs for the location if specified

      Job Properties

      • AllowAddItem bool — True if employees under this Job can add items, False if not

      • AlternateId string — Alternate external Id for this Job

      • CannotClose bool — True if employees under this Job are not allowed to close, False if not

      • CanOpenAnyOrder bool — True if employees under this Job can open any order, False if not

      • CashDrawer bool — True if employees under this Job can be assigned a cash drawer, False if not

      • CheckoutRequiresApproval bool — True if employees under this Job require approval for their checkout, False if not

      • ClockInRequiresApproval bool — True if employees under this Job require approval for their clockin, False if not

      • ClockOutRequiresApproval bool — True if employees under this Job require approval for their clockout, False if not

      • DeclareTips bool — True if employees under this Job can declare tips, False if not

      • DefaultScreenId int? — Id of this Job's default screen

      • DefaultSecurityLevelId int? — Id of this Job's default security level

      • DefaultSecurityLevelUniqueId Guid? — Unique identifier of the default SecurityLevel

      • DisplayColor int — ARGB encoded color for this Job's display

      • ExcludeOnSalesAndLaborReports bool — True if employees under this Job are excluded on sales and labor reports, False if not

      • ExemptFromLaborSchedule bool — True if employees under this Job are exempt from the labor schedule, False if not

      • ExportCode string — Export code for this Job

      • GroupItemsBySeat bool — True if employees under this Job can group items by seat, False if not

      • Id int — Unique Id of this Job

      • IsBartender bool — True if this Job is a bartender Job, False if not

      • IsDeliveryDispatcher bool — True if this Job is a delivery dispatcher Job, False if not

      • IsDeliveryDriver bool — True if this Job is a delivery driver Job, False if not

      • IsHostess bool — True if this Job is a hostess Job, False if not

      • ItemLookup bool — True if employees under this Job can perform an item lookup, False if not

      • JobUniqueId Guid — Unique identifier of this Job

      • LaneId int? — Lane Id assigned to this Job

      • LimitedDestinationId int? — Maps to the Id of the Destination this Job is limited to, if applicable

      • LimitShiftBreakTypes bool — True if employees under this Job have limited shift break types, False if not

      • LocationType byte — 0=Quick Service, 1=Table Service

      • Menus Array of JobMenu — Menus for this Job

        JobMenu Properties
        • Days byte? — Days of the week this Menu is active for this Job (binary-encoded)
        • MenuId int — Maps to the Id of the Menu assigned to this Job
        • StartTime TimeSpan? — Time of day this Menu becomes active for this Job

      • Name string — Name of this Job

      • NoCashTransactions bool — True if employees under this Job are not allowed to perform cash transactions, False if not

      • OrderEntry bool — True if employees under this Job are allowed to enter orders, False if not

      • OrderScreenId int? — Id of the order screen for this Job

      • RequireTipReporting bool — True if employees under this Job must report tips at end of shift, False if not

      • SectionId int? — Maps to the Id of the Section for this Job

      • SelfBanking bool — True if employees under this Job can be self-banking, False if not

      • SelfVoid bool — True if employees under this Job can self-void, False if not

      • ShiftBreakTypes Array of JobShiftBreakType — Shift break types allowed for this Job

        JobShiftBreakType Properties
        • ShiftBreakTypeId int — Maps to the Id of the ShiftBreakType allowed for this Job

      • Tabs bool — True if employees under this Job can open tabs, False if not

      • Training bool — True if this Job is a training Job, False if not

      • IndicateTrainingModeOnKitchenChits bool — True if training mode is indicated on kitchen chits, False if not

    • KitchenQueues Array of KitchenQueue — KitchenQueues for the location if specified

      KitchenQueue Properties
      • Id int — Unique Id of this KitchenQueue
      • Name string — Name of this KitchenQueue

    • Menus Array of Menu — Menus for the location if specified

      Menu Properties

      • Categories Array of MenuCategory — Categories on this Menu

        MenuCategory Properties

        • Description string — Description of this MenuCategory

        • Id int — Unique Id of this MenuCategory

        • Items Array of MenuItem — Items in this MenuCategory

          MenuItem Properties

          • Description string — Description of this MenuItem

          • Id int — Unique Id of this MenuItem

          • ImageId int — Maps to the Id of the Image used by this MenuItem

          • ItemId int — Maps to the Id of the underlying Item

          • ItemOptions Array of MenuItemOption — Item options for this MenuItem

            MenuItemOption Properties
            • DisplayName string — Display name of this MenuItemOption
            • ItemId int — Maps to the Id of the Item for this option
            • SortOrderId short — Sort order of this MenuItemOption

          • ModifierMethod byte — Modifier method of this MenuItem

          • Name string — Name of this MenuItem

          • Price decimal — Price of this MenuItem

          • PriceMethod byte — Price method of this MenuItem

          • ModifierGroups Array of MenuItemModifierGroup — Modifier groups for this MenuItem

            MenuItemModifierGroup Properties
            • ModifierGroupId int — Maps to the Id of the ModifierGroup
            • SortOrderId short — Sort order of this MenuItemModifierGroup

          • SortOrderId short — Sort order of this MenuItem

        • Name string — Name of this MenuCategory

        • SortOrderId int — Sort order of this MenuCategory

      • Description string — Description of this Menu

      • Id int — Unique Id of this Menu

      • ImageId int — Maps to the Id of the Image used by this Menu

      • Name string — Name of this Menu

    • Tables Array of Table — Tables for the location if specified

      Table Properties
      • Capacity int — Seating capacity of this Table
      • Id int — Unique Id of this Table
      • IsActive bool — True if this Table is active, False if not
      • Name string — Name of this Table

    • OnlineOrderingMenuOptions OnlineOrderingMenuOptions — Online ordering menu options for the location if specified

      OnlineOrderingMenuOptions Properties

      • AlternateMenus Array of AlternateMenu — Alternate menus configured for online ordering

        AlternateMenu Properties
        • Days byte? — Days of the week this AlternateMenu is active (binary-encoded)
        • EndTime TimeSpan — Time of day this AlternateMenu becomes inactive
        • MenuId int — Maps to the Id of the alternate Menu
        • StartTime TimeSpan — Time of day this AlternateMenu becomes active
        • TimeType byte — Type of time used by this AlternateMenu

      • OnlineOrderingMenuId int? — Maps to the Id of the default online ordering Menu

    • Permissions Array of Permission — Permissions for the location if specified

      Permission Properties
      • Id int — Unique Id of this Permission
      • IsActive bool — True if this Permission is active, False if not
      • Name string — Name of this Permission
      • PermissionUniqueId Guid — Unique identifier of this Permission

    • PriceChanges Array of PriceChange — Price changes for the location if specified

      PriceChange Properties

      • Days byte? — Days of the week this PriceChange is active (binary-encoded)

      • EndDate DateTime? — Date this PriceChange ends

      • EndTime TimeSpan? — Time of day this PriceChange ends

      • EnforceDateRanges bool — True if date ranges are enforced for this PriceChange, False if not

      • EnforceDays bool — True if days are enforced for this PriceChange, False if not

      • EnforceTimeRanges bool — True if time ranges are enforced for this PriceChange, False if not

      • Id int — Unique Id of this PriceChange

      • IsActive bool — True if this PriceChange is active, False if not

      • ItemPriceChanges Array of ItemPriceChange — Item-level price changes

        ItemPriceChange Properties

        • ComponentPriceChanges Array of ComponentPriceChange — Component-level price changes

          ComponentPriceChange Properties

          • ComponentId int — Maps to the Id of the Component

          • ComponentItemPriceChanges Array of ComponentItemPriceChange — Component item price changes

            ComponentItemPriceChange Properties
            • ItemId int — Maps to the Id of the Item
            • Price decimal? — New price for this ComponentItem

          • Price decimal? — New price for this Component

        • ItemId int — Maps to the Id of the Item being priced

        • Name string — Name of this ItemPriceChange

        • Price decimal? — New price for this Item

        • OriginalPrice decimal? — Original price of this Item

      • Name string — Name of this PriceChange

      • PriceChangeDestinations Array of PriceChangeDestination — Destinations this PriceChange applies to

        PriceChangeDestination Properties
        • DestinationId int — Maps to the Id of the Destination
        • DestinationName string — Name of this Destination

      • StartDate DateTime? — Date this PriceChange begins

      • StartTime TimeSpan? — Time of day this PriceChange begins

    • Printer Array of Printer — Printers for the location if specified

      Printer Properties
      • BackupPrinterId int? — Maps to the Id of the backup Printer
      • BaudRate int? — Baud rate of this Printer
      • ChitType ChitType? — Chit type for this Printer
      • ComPort byte? — COM port number for this Printer
      • DiscountChitPlacement DiscountChitPlacement? — Placement of discount chit for this Printer
      • Handshake PrinterHandshake? — Handshake setting for this Printer
      • Id int — Unique Id of this Printer
      • Interface PrinterInterface? — Interface type for this Printer
      • IsKitchen bool — True if this Printer is a kitchen printer, False if not
      • ItemLabelId int? — Maps to the Id of the item label used by this Printer
      • KeyIngredientSummaryPlacement KeyIngredientSummaryPlacement? — Placement of the key ingredient summary
      • Model PrinterModel? — Model of this Printer
      • Name string — Name of this Printer
      • Parity PrinterParity? — Parity setting for this Printer
      • Path string — Path used to communicate with this Printer
      • PrintAllItems bool? — True if this Printer prints all items, False if not
      • PrintOnlyCustomizedItems bool? — True if this Printer prints only customized items, False if not
      • PrintOnlyCustomizedItemsExceptionItemGroupId int? — Item group exception Id for printing only customized items
      • StoredImageNumber byte? — Stored image number for this Printer
      • SummaryLabelId int? — Maps to the Id of the summary label used by this Printer
      • TerminalId int — Maps to the Id of the Terminal this Printer is attached to
      • Width byte? — Print width of this Printer

    • PrinterGroup Array of PrinterGroup — Printer groups for the location if specified

      PrinterGroup Properties

      • Id int — Unique Id of this PrinterGroup

      • Name string — Name of this PrinterGroup

      • Printers Array of PrinterGroupPrinter — Printers in this PrinterGroup

        PrinterGroupPrinter Properties
        • PrinterId int — Maps to the Id of the Printer in this PrinterGroup

      • RoutingOverrides Array of PrinterGroupRoutingOverride — Routing overrides for this PrinterGroup

        PrinterGroupRoutingOverride Properties

        • Printers Array of PrinterGroupPrinter — Printers used for this routing override

          PrinterGroupPrinter Properties
          • PrinterId int — Maps to the Id of the Printer in this routing override

    • PriceLevel Array of PriceLevel — Price levels for the location if specified

      PriceLevel Properties
      • Id int — Unique Id of this PriceLevel
      • Name string — Name of this PriceLevel
      • Price decimal — Price for this PriceLevel

    • ModifierTiers Array of ModifierTier — Modifier tiers for the location if specified

      ModifierTier Properties
      • Id int — Unique Id of this ModifierTier
      • Level short — Level of this ModifierTier
      • Name string — Name of this ModifierTier

    • KitchenVideoGroups Array of KitchenVideoGroup — Kitchen video groups for the location if specified

      KitchenVideoGroup Properties

      • Id int — Unique Id of this KitchenVideoGroup

      • KitchenBackgroundColor Color — Background color used on the kitchen video display

      • Name string — Name of this KitchenVideoGroup

      • RoutingOverrides Array of KitchenVideoGroupRoutingOverride — Routing overrides for this KitchenVideoGroup

        KitchenVideoGroupRoutingOverride Properties

        • KitchenQueues Array of KitchenVideoGroupQueue — Kitchen queues used for this routing override

          KitchenVideoGroupQueue Properties
          • KitchenQueueId int — Maps to the Id of the KitchenQueue

      • KitchenQueues Array of KitchenVideoGroupQueue — Kitchen queues for this KitchenVideoGroup

        KitchenVideoGroupQueue Properties
        • KitchenQueueId int — Maps to the Id of the KitchenQueue

    • Panels Array of Panel — Panels for the location if specified

      Panel Properties

      • BackgroundColor Color — Background color of this Panel

      • BackgroundImageDisplayMode BackgroundImageDisplayMode? — Display mode for the background image

      • BorderColor Color — Border color of this Panel

      • BorderType BorderType? — Border type for this Panel

      • Controls Array of PanelControl — Controls on this Panel

        PanelControl Properties

        • BackgroundColor Color — Background color of this PanelControl

        • BackgroundOpacity double? — Background opacity (0.0-1.0)

        • BorderColor Color — Border color of this PanelControl

        • ButtonTemplate ButtonTemplate — Button template used by this PanelControl

          ButtonTemplate Properties

          • BackgroundColor Color — Background color of the button

          • Font FontInfo — Font used by the button

            FontInfo Properties
            • Bold bool — True if the font is bold, False if not
            • Italic bool — True if the font is italic, False if not
            • Name string — Name of the font family
            • Size float — Font size in points
            • Underline bool — True if the font is underlined, False if not

          • Height short — Height of the button in pixels

          • IsShadowEnabled bool — True if a shadow is rendered for this button, False if not

          • SelectedColor Color — Color of the button when selected

          • Style ButtonStyle — Style of the button

          • TextColor Color — Text color of the button

          • Width short — Width of the button in pixels

        • CornerRadius byte — Corner radius of this PanelControl

        • Font FontInfo — Font used by this PanelControl

          FontInfo Properties
          • Bold bool — True if the font is bold, False if not
          • Italic bool — True if the font is italic, False if not
          • Name string — Name of the font family
          • Size float — Font size in points
          • Underline bool — True if the font is underlined, False if not

        • Height short — Height of this PanelControl in pixels

        • Id int — Unique Id of this PanelControl

        • IsShadowEnabled bool — True if a shadow is rendered for this control, False if not

        • Left short — Left position of this PanelControl in pixels

        • Style byte — Style of this PanelControl

        • TextColor Color — Text color of this PanelControl

        • Top short — Top position of this PanelControl in pixels

        • Width short — Width of this PanelControl in pixels

        • ZOrder short — Z-order of this PanelControl

      • Font FontInfo — Font used by this Panel

        FontInfo Properties
        • Bold bool — True if the font is bold, False if not
        • Italic bool — True if the font is italic, False if not
        • Name string — Name of the font family
        • Size float — Font size in points
        • Underline bool — True if the font is underlined, False if not

      • Height short — Height of this Panel in pixels

      • Id int — Unique Id of this Panel

      • InheritBackgroundFromScreen bool — True if this Panel inherits its background from the screen, False if not

      • Left short — Left position of this Panel in pixels

      • Name string — Name of this Panel

      • Title string — Title displayed at the top of this Panel

      • TitleColor Color — Color of the title text

      • Top short — Top position of this Panel in pixels

      • Type PanelType — Type of this Panel

      • Width short — Width of this Panel in pixels

    • Screens Array of Screen — Screens for the location if specified

      Screen Properties

      • BackgroundColor Color — Background color of this Screen

      • DefaultPanelColor Color — Default panel color for this Screen

      • Height short — Height of this Screen in pixels

      • Id int — Unique Id of this Screen

      • Name string — Name of this Screen

      • Width short — Width of this Screen in pixels

      • Panels Array of ScreenPanel — Panels included on this Screen

        ScreenPanel Properties
        • PanelId int — Maps to the Id of the Panel on this Screen

    • Tares Array of Tare — Tares for the location if specified

      Tare Properties
      • Id int — Unique Id of this Tare
      • Name string — Name of this Tare
      • Weight decimal — Weight of this Tare

    • MenuItem Array of MenuItem — Top-level menu items for the location if specified

      MenuItem Properties

      • Description string — Description of this MenuItem

      • Id int — Unique Id of this MenuItem

      • ImageId int — Maps to the Id of the Image used by this MenuItem

      • ItemId int — Maps to the Id of the underlying Item

      • ItemOptions Array of MenuItemOption — Item options for this MenuItem

        MenuItemOption Properties
        • DisplayName string — Display name of this MenuItemOption
        • ItemId int — Maps to the Id of the Item for this option
        • SortOrderId short — Sort order of this MenuItemOption

      • ModifierMethod byte — Modifier method of this MenuItem

      • Name string — Name of this MenuItem

      • Price decimal — Price of this MenuItem

      • PriceMethod byte — Price method of this MenuItem

      • ModifierGroups Array of MenuItemModifierGroup — Modifier groups for this MenuItem

        MenuItemModifierGroup Properties
        • ModifierGroupId int — Maps to the Id of the ModifierGroup
        • SortOrderId short — Sort order of this MenuItemModifierGroup

      • SortOrderId short — Sort order of this MenuItem

    • PaymentOptions PaymentOptions — Payment options for the location if specified

      PaymentOptions Properties

      • CreditCard CreditCardOptions — Credit card payment options

        CreditCardOptions Properties

        • AllowUnsolicitedSwipes bool — True if unsolicited card swipes are allowed, False if not

        • ApplyCeilingToManualCards bool — True if the signature ceiling applies to manually entered cards, False if not

        • ApplyCeilingToSwipedCards bool — True if the signature ceiling applies to swiped cards, False if not

        • CardSwipePostProcessScript string — Script executed after a card swipe is processed

        • CardSwipePreProcessScript string — Script executed before a card swipe is processed

        • EnableStoredCreditCards bool — True if stored credit cards are enabled, False if not

        • FailTransactionsOnCvvMismatch bool — True if transactions should fail on CVV mismatch, False if not

        • FailTransactionsOnZipMismatch bool — True if transactions should fail on ZIP mismatch, False if not

        • ProcessorOptions CreditProcessorOptions — Options specific to the credit processor (varies by processor)

          CreditProcessorOptions Properties
          • Processor-specific properties; varies by selected Processor.

        • Processor CreditProcessor — Credit processor used for credit card transactions

        • RequireCvvForManualEntryTerminalTypes ValidTerminalTypes — Terminal types that require CVV for manual entry

        • RequireZipForManualEntryTerminalTypes ValidTerminalTypes — Terminal types that require ZIP for manual entry

        • ShowCardWindowOnUnsolicitedSwipe bool — True if the card window appears on an unsolicited swipe, False if not

        • SignatureRequiredCeiling decimal — Amount above which a signature is required

      • ExternalPayment ExternalPaymentOptions — External payment options

        ExternalPaymentOptions Properties

        • Processor ExternalPaymentProcessor — External payment processor used for transactions

        • ProcessorOptions ExternalPaymentProcessorOptions — Options specific to the external payment processor (varies by processor)

          ExternalPaymentProcessorOptions Properties
          • Processor-specific properties; varies by selected Processor.

      • GiftCard GiftCardOptions — Gift card payment options

        GiftCardOptions Properties

        • DisplayCvvForManualEntry bool — True if CVV is displayed for manual entry, False if not

        • DisplaySecurityCodeForManualEntry bool — True if security code is displayed for manual entry, False if not

        • EnforceIssueReloadManualGiftCardMaximum bool — True if the issue/reload maximum is enforced for manual entry, False if not

        • EnforceIssueReloadSwipedGiftCardMaximum bool — True if the issue/reload maximum is enforced for swiped cards, False if not

        • EnforceTenderManualGiftCardMaximum bool — True if the tender maximum is enforced for manual entry, False if not

        • EnforceTenderSwipedGiftCardMaximum bool — True if the tender maximum is enforced for swiped cards, False if not

        • IssueReloadManualGiftCardMaximum decimal — Maximum issue/reload amount for manually entered gift cards

        • IssueReloadSwipedGiftCardMaximum decimal — Maximum issue/reload amount for swiped gift cards

        • PromptForCashoutAmount bool — True if the user is prompted for the cashout amount, False if not

        • ProcessorOptions GiftProcessorOptions — Options specific to the gift processor (varies by processor)

          GiftProcessorOptions Properties
          • Processor-specific properties; varies by selected Processor.

        • Processor GiftProcessor — Gift processor used for gift card transactions

        • RequireCvvForManualEntry bool — True if CVV is required for manual entry, False if not

        • RequireSecurityCodeForManualEntry bool — True if security code is required for manual entry, False if not

        • TenderManualGiftCardMaximum decimal — Maximum tender amount for manually entered gift cards

        • TenderSwipedGiftCardMaximum decimal — Maximum tender amount for swiped gift cards

        • AllowGiftCardMaximumCashout bool — True if cashout up to the maximum is allowed, False if not

        • GiftCardMaximumCashoutAmount decimal — Maximum cashout amount for gift cards

      • Rounding RoundingOptions — Rounding options applied to payments

        RoundingOptions Properties
        • IsEnabled bool — True if rounding is enabled, False if not
        • RoundingMethod RoundingMethod? — Rounding method to use
        • RoundToValue decimal? — Value to which amounts are rounded

      • TipAndSignature TipAndSignatureOptions — Tip and signature options

        TipAndSignatureOptions Properties
        • LimitByDestination bool — True if tip and signature options are limited by destination, False if not
        • RequireTipSelection bool — True if tip selection is required, False if not
        • TipAmount1 decimal — Suggested tip amount or percent (slot 1)
        • TipAmount2 decimal — Suggested tip amount or percent (slot 2)
        • TipAmount3 decimal — Suggested tip amount or percent (slot 3)
        • TipType TipType — Type of tip (e.g. percent or fixed amount)

      • PayAtTable PayAtTableOptions — Pay-at-table options

        PayAtTableOptions Properties
        • PayAtTableType PayAtTableType — Type of pay-at-table integration
        • PortNumber int? — Port number used for the pay-at-table service
        • PromptForTip bool — True if the user is prompted for a tip, False if not

    • Promotions Array of Promotion — Promotions for the location if specified

      Promotion Properties

      • Active bool — True if this Promotion is active, False if not

      • AlternateId string — Alternate external Id for this Promotion

      • CustomFields Array of CustomField — Custom fields associated with this Promotion

        CustomField Properties
        • Id int — Unique Id of this CustomField
        • FieldName string — Name of this CustomField
        • Value string — Value of this CustomField

      • Id int — Unique Id of this Promotion

      • Name string — Name of this Promotion

      • Type PromotionType — Type of this Promotion

    • SecurityLevels Array of SecurityLevel — Security levels for the location if specified

      SecurityLevel Properties

      • AddSurcharges bool — True if this SecurityLevel can add surcharges, False if not

      • AllowExcessEmployeeCardUsage bool — True if excess employee card usage is allowed, False if not

      • ApproveCheckout bool — True if this SecurityLevel can approve checkouts, False if not

      • ApproveClockIn bool — True if this SecurityLevel can approve clock-ins, False if not

      • ApproveClockOut bool — True if this SecurityLevel can approve clock-outs, False if not

      • ApproveDiscounts bool — True if this SecurityLevel can approve discounts, False if not

      • ApproveLoyaltyCards bool — True if this SecurityLevel can approve loyalty cards, False if not

      • ApproveOrderRequestTime bool — True if this SecurityLevel can approve order request times, False if not

      • ApprovePromotions bool — True if this SecurityLevel can approve promotions, False if not

      • AssignCharity bool — True if this SecurityLevel can assign a charity, False if not

      • CanAdjustTipsFromAnyTill bool — True if this SecurityLevel can adjust tips from any till, False if not

      • CanCloseOrdersAssignedToDeliveryDrivers bool — True if this SecurityLevel can close orders assigned to delivery drivers, False if not

      • CanOpenAnyDrawer bool — True if this SecurityLevel can open any cash drawer, False if not

      • DeleteDeposits bool — True if this SecurityLevel can delete deposits, False if not

      • DeleteDiscounts bool — True if this SecurityLevel can delete discounts, False if not

      • DeleteDonations bool — True if this SecurityLevel can delete donations, False if not

      • DeletePayments bool — True if this SecurityLevel can delete payments, False if not

      • DeletePromotions bool — True if this SecurityLevel can delete promotions, False if not

      • DeleteSurcharges bool — True if this SecurityLevel can delete surcharges, False if not

      • ForceAuthorization bool — True if this SecurityLevel can force authorization, False if not

      • ForceReconciliation bool — True if this SecurityLevel can force reconciliation, False if not

      • Id int — Unique Id of this SecurityLevel

      • ManageCashDrawers bool — True if this SecurityLevel can manage cash drawers, False if not

      • Name string — Name of this SecurityLevel

      • OverrideDailyLoyaltyCardLimit bool — True if this SecurityLevel can override the daily loyalty card limit, False if not

      • OverrideMaximumTipPercent bool — True if this SecurityLevel can override the maximum tip percent, False if not

      • Permissions Array of SecurityLevelPermission — Permissions granted to this SecurityLevel

        SecurityLevelPermission Properties
        • PermissionId int — Maps to the Id of the Permission granted to this SecurityLevel
        • PermissionUniqueId Guid — Unique identifier of the Permission granted to this SecurityLevel

      • ReopenOrders bool — True if this SecurityLevel can reopen orders, False if not

      • SecurityLevelUniqueId Guid — Unique identifier of this SecurityLevel

      • SplitCheck bool — True if this SecurityLevel can split checks, False if not

      • VoidItems bool — True if this SecurityLevel can void items, False if not

    • MarketingCampaigns Array of MarketingCampaign — Marketing campaigns for the location if specified

      MarketingCampaign Properties
      • Cost decimal — Cost associated with this MarketingCampaign
      • Id int — Unique Id of this MarketingCampaign
      • IsActive bool — True if this MarketingCampaign is active, False if not
      • Name string — Name of this MarketingCampaign
Headers
  • SOAPAction
    Type: string
    required
Body
required
application/json

SOAP envelope for GetSettings request. Specify DataTypes to filter results.

Responses
  • text/xml; charset=utf-8
Request Example for post/GetSettings
cURL
curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?GetSettings' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'AccessToken: your-access-token' \
  --header 'LocationToken: your-location-token' \
  --header 'SOAPAction: "http://www.brinksoftware.com/webservices/settings/v2/ISettingsWebService2/GetSettings"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/settings/v2"
    xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:GetSettings>
        <v2:request>
          <v2:DataTypes>
            <v2:DataType>Employee</v2:DataType>
            <v2:DataType>Job</v2:DataType>
            <v2:DataType>Permission</v2:DataType>
            <v2:DataType>SecurityLevel</v2:DataType>
            <v2:DataType>KitchenQueue</v2:DataType>
            <v2:DataType>FutureOrderingOptions</v2:DataType>
            <v2:DataType>Menu</v2:DataType>
            <v2:DataType>OnlineOrderingMenuOptions</v2:DataType>
            <v2:DataType>PriceChange</v2:DataType>
            <v2:DataType>Promotion</v2:DataType>
            <v2:DataType>Table</v2:DataType>
          </v2:DataTypes>
        </v2:request>
      </v2:GetSettings>
    </soapenv:Body>
  </soapenv:Envelope>'

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetSettingsResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <GetSettingsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Settings>
          <Employees>
            <Employee>
              <Address1>123 Main St</Address1>
              <Address2/>
              <AlternateId>EMP001</AlternateId>
              <BirthDate i:nil="true"/>
              <CanLoginWithCard>true</CanLoginWithCard>
              <CanLoginWithFinger>false</CanLoginWithFinger>
              <CanLoginWithPin>true</CanLoginWithPin>
              <CardNumber>12345</CardNumber>
              <CellPhone>555-555-5555</CellPhone>
              <City>Austin</City>
              <ClockedInDiscountId i:nil="true"/>
              <ClockedOutDiscountId i:nil="true"/>
              <DisplayName>Jane Smith</DisplayName>
              <EmailAddress>jane.smith@example.com</EmailAddress>
              <EmployeeUniqueId>a1b2c3d4-e5f6-7890-abcd-ef1234567890</EmployeeUniqueId>
              <ExportToPayroll>true</ExportToPayroll>
              <FirstName>Jane</FirstName>
              <HealthCardExpirationDate i:nil="true"/>
              <HireDate>2020-01-15T00:00:00</HireDate>
              <HomeLocationId i:nil="true"/>
              <HomePhone>555-444-3333</HomePhone>
              <Id>1</Id>
              <IdentificationVerified>false</IdentificationVerified>
              <IsExempt>false</IsExempt>
              <IsSalaried>false</IsSalaried>
              <Jobs>
                <EmployeeJob>
                  <JobId>1</JobId>
                  <JobUniqueId>a1b2c3d4-e5f6-7890-abcd-ef1234567890</JobUniqueId>
                  <PayRate>12.50</PayRate>
                  <SecurityLevelId>2</SecurityLevelId>
                  <SecurityLevelUniqueId>sec-00000-0000-0000-000000000002</SecurityLevelUniqueId>
                </EmployeeJob>
              </Jobs>
              <LastName>Smith</LastName>
              <LimitLocations>false</LimitLocations>
              <MaritalStatus>0</MaritalStatus>
              <MaximumDailyDiscountAmount>0</MaximumDailyDiscountAmount>
              <MaximumDailyDiscountCount>0</MaximumDailyDiscountCount>
              <Name>Jane Smith</Name>
              <Notes/>
              <PayrollId>P001</PayrollId>
              <Permissions/>
              <Pin i:nil="true"/>
              <SecondaryAuthPin i:nil="true"/>
              <Ssn>***-**-****</Ssn>
              <State>TX</State>
              <TaxWithholdingAllowance>1</TaxWithholdingAllowance>
              <Terminated>false</Terminated>
              <TerminationDate i:nil="true"/>
              <ValidLocations/>
              <Zip>78701</Zip>
            </Employee>
          </Employees>
          <Jobs>
            <Job>
              <AllowAddItem>true</AllowAddItem>
              <AlternateId>SRV</AlternateId>
              <CannotClose>false</CannotClose>
              <CanOpenAnyOrder>true</CanOpenAnyOrder>
              <CashDrawer>true</CashDrawer>
              <CheckoutRequiresApproval>false</CheckoutRequiresApproval>
              <ClockInRequiresApproval>false</ClockInRequiresApproval>
              <ClockOutRequiresApproval>false</ClockOutRequiresApproval>
              <DeclareTips>true</DeclareTips>
              <DefaultScreenId>1</DefaultScreenId>
              <DefaultSecurityLevelId>1</DefaultSecurityLevelId>
              <DefaultSecurityLevelUniqueId>e5f6a7b8-c9d0-1234-ef01-234567890123</DefaultSecurityLevelUniqueId>
              <DisplayColor>16711680</DisplayColor>
              <ExcludeOnSalesAndLaborReports>false</ExcludeOnSalesAndLaborReports>
              <ExemptFromLaborSchedule>false</ExemptFromLaborSchedule>
              <ExportCode>SRV</ExportCode>
              <GroupItemsBySeat>false</GroupItemsBySeat>
              <Id>1</Id>
              <IndicateTrainingModeOnKitchenChits>false</IndicateTrainingModeOnKitchenChits>
              <IsBartender>false</IsBartender>
              <IsDeliveryDispatcher>false</IsDeliveryDispatcher>
              <IsDeliveryDriver>false</IsDeliveryDriver>
              <IsHostess>false</IsHostess>
              <ItemLookup>true</ItemLookup>
              <JobUniqueId>a1b2c3d4-e5f6-7890-abcd-ef1234567890</JobUniqueId>
              <LaneId i:nil="true"/>
              <LimitedDestinationId i:nil="true"/>
              <LimitShiftBreakTypes>false</LimitShiftBreakTypes>
              <LocationType>0</LocationType>
              <Menus>
                <JobMenu>
                  <Days>127</Days>
                  <MenuId>1</MenuId>
                  <StartTime>PT0S</StartTime>
                </JobMenu>
              </Menus>
              <Name>Server</Name>
              <NoCashTransactions>false</NoCashTransactions>
              <OrderEntry>true</OrderEntry>
              <OrderScreenId>1</OrderScreenId>
              <RequireTipReporting>false</RequireTipReporting>
              <SectionId i:nil="true"/>
              <SelfBanking>false</SelfBanking>
              <SelfVoid>false</SelfVoid>
              <ShiftBreakTypes/>
              <Tabs>true</Tabs>
              <Training>false</Training>
            </Job>
          </Jobs>
          <Permissions>
            <Permission>
              <Id>1</Id>
              <IsActive>true</IsActive>
              <Name>Void Items</Name>
              <PermissionUniqueId>d4e5f6a7-b8c9-0123-def0-123456789012</PermissionUniqueId>
            </Permission>
          </Permissions>
          <SecurityLevels>
            <SecurityLevel>
              <AddSurcharges>false</AddSurcharges>
              <AllowExcessEmployeeCardUsage>false</AllowExcessEmployeeCardUsage>
              <ApproveCheckout>false</ApproveCheckout>
              <ApproveClockIn>false</ApproveClockIn>
              <ApproveClockOut>false</ApproveClockOut>
              <ApproveDiscounts>false</ApproveDiscounts>
              <ApproveLoyaltyCards>false</ApproveLoyaltyCards>
              <ApproveOrderRequestTime>false</ApproveOrderRequestTime>
              <ApprovePromotions>false</ApprovePromotions>
              <AssignCharity>false</AssignCharity>
              <CanAdjustTipsFromAnyTill>false</CanAdjustTipsFromAnyTill>
              <CanCloseOrdersAssignedToDeliveryDrivers>false</CanCloseOrdersAssignedToDeliveryDrivers>
              <CanOpenAnyDrawer>false</CanOpenAnyDrawer>
              <DeleteDeposits>false</DeleteDeposits>
              <DeleteDiscounts>false</DeleteDiscounts>
              <DeleteDonations>false</DeleteDonations>
              <DeletePayments>false</DeletePayments>
              <DeletePromotions>false</DeletePromotions>
              <DeleteSurcharges>false</DeleteSurcharges>
              <ForceAuthorization>false</ForceAuthorization>
              <ForceReconciliation>false</ForceReconciliation>
              <Id>1</Id>
              <ManageCashDrawers>false</ManageCashDrawers>
              <Name>Server</Name>
              <OverrideDailyLoyaltyCardLimit>false</OverrideDailyLoyaltyCardLimit>
              <OverrideMaximumTipPercent>false</OverrideMaximumTipPercent>
              <Permissions/>
              <ReopenOrders>false</ReopenOrders>
              <SecurityLevelUniqueId>e5f6a7b8-c9d0-1234-ef01-234567890123</SecurityLevelUniqueId>
              <SplitCheck>false</SplitCheck>
              <VoidItems>false</VoidItems>
            </SecurityLevel>
          </SecurityLevels>
          <KitchenQueues>
            <KitchenQueue>
              <Id>1</Id>
              <Name>Main Kitchen</Name>
            </KitchenQueue>
          </KitchenQueues>
          <FutureOrderingOptions>
            <AllowFutureDateOrdering>true</AllowFutureDateOrdering>
            <Destinations>
              <OnlineOrderingDestination>
                <DestinationId>1</DestinationId>
                <Instructions>For pickup orders</Instructions>
                <IsDefault>true</IsDefault>
              </OnlineOrderingDestination>
            </Destinations>
            <IsEnabled>true</IsEnabled>
            <LeadTimeThresholds/>
            <MaximumDaysInAdvance>7</MaximumDaysInAdvance>
            <MinimumLeadMinutes>60</MinimumLeadMinutes>
            <MinimumPrepMinutes>30</MinimumPrepMinutes>
            <PrepTimeThresholds/>
            <RequiredDepositPercent>0</RequiredDepositPercent>
          </FutureOrderingOptions>
          <Menus>
            <Menu>
              <Categories>
                <MenuCategory>
                  <Description>Delicious burgers</Description>
                  <Id>1</Id>
                  <Items>
                    <MenuItem>
                      <Description>Classic beef burger</Description>
                      <Id>1</Id>
                      <ImageId>101</ImageId>
                      <ItemId>1001</ItemId>
                      <ItemOptions/>
                      <ModifierGroups/>
                      <ModifierMethod>0</ModifierMethod>
                      <Name>Classic Burger</Name>
                      <Price>9.99</Price>
                      <PriceMethod>0</PriceMethod>
                      <SortOrderId>1</SortOrderId>
                    </MenuItem>
                  </Items>
                  <Name>Burgers</Name>
                  <SortOrderId>1</SortOrderId>
                </MenuCategory>
              </Categories>
              <Description>Main Menu</Description>
              <Id>1</Id>
              <ImageId>0</ImageId>
              <Name>Main Menu</Name>
            </Menu>
          </Menus>
          <OnlineOrderingMenuOptions>
            <AlternateMenus>
              <AlternateMenu>
                <Days>62</Days>
                <EndTime>PT17H0M0S</EndTime>
                <Id>1</Id>
                <MenuId>2</MenuId>
                <StartTime>PT11H0M0S</StartTime>
                <TimeType>0</TimeType>
              </AlternateMenu>
            </AlternateMenus>
            <OnlineOrderingMenuId>1</OnlineOrderingMenuId>
          </OnlineOrderingMenuOptions>
          <PriceChanges>
            <PriceChange>
              <Days>62</Days>
              <EndDate>2025-12-31T00:00:00</EndDate>
              <EndTime>PT17H0M0S</EndTime>
              <EnforceDateRanges>true</EnforceDateRanges>
              <EnforceDays>true</EnforceDays>
              <EnforceTimeRanges>true</EnforceTimeRanges>
              <Id>10</Id>
              <IsActive>true</IsActive>
              <ItemPriceChanges>
                <ItemPriceChange>
                  <ComponentPriceChanges/>
                  <ItemId>101</ItemId>
                  <Name>Classic Burger</Name>
                  <OriginalPrice>9.99</OriginalPrice>
                  <Price>8.99</Price>
                </ItemPriceChange>
              </ItemPriceChanges>
              <Name>Happy Hour Pricing</Name>
              <PriceChangeDestinations>
                <PriceChangeDestination>
                  <DestinationId>1</DestinationId>
                  <DestinationName>Dine In</DestinationName>
                </PriceChangeDestination>
              </PriceChangeDestinations>
              <StartDate>2024-01-01T00:00:00</StartDate>
              <StartTime>PT15H0M0S</StartTime>
            </PriceChange>
          </PriceChanges>
          <Promotions>
            <Promotion>
              <Active>true</Active>
              <AlternateId>PROMO-001</AlternateId>
              <CustomFields/>
              <Id>5</Id>
              <Name>Happy Hour</Name>
              <Type>Bogo</Type>
            </Promotion>
          </Promotions>
          <Tables>
            <Table>
              <Capacity>4</Capacity>
              <Id>1</Id>
              <IsActive>true</IsActive>
              <Name>Table 1</Name>
            </Table>
          </Tables>
        </Settings>
      </GetSettingsResult>
    </GetSettingsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing a SettingsResponse object with all requested data types populated.

Copyright © 2026 PAR Technology Corporation. All rights reserved.
PAR Technology Corporation 8383 Seneca Turnpike, Suite 3 New Hartford, New York 13413 (315) 738-0600 legal@partech.com. PAR Tech is a leading global provider of software, systems, and service solutions to the restaurant and retail industries. You may learn about its product offerings here.
Before using this application, please read the Limited License Agreement and the PAR Tech Terms of Use. In addition, the sample applications of PAR Technology are licensed under the terms of the O'Saasy License.