GetOptions

This call is to retrieve an Options object for the location.

Request Parameters

accessToken string — Your access token (passed in SOAP body, not headers).
locationToken string — Your location token (passed in SOAP body, not headers).

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 — Success
- 1 — Unknown Error
- 3 — Server Unavailable
- 4 — Access Denied
Options Options — Options configuration data for the location.
Accounting Properties
- GLExport GLExport — Defines how sales data is to be mapped to general ledger account numbers in the various export formats.
  GLExport Properties
  - Name string — Name of the GLExport
  - Discounts Array of GLExportDiscountAccount — Contains details about GLExportDiscountAccount
    
    GLExportDiscountAccount Properties
    
    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 for the GLExport record
    
    Name string — Name of the GLExport record
    
    DiscountId int — ID of the GLExportDiscountAccount
  - Others Array of GLExportOtherAccount — Contains details about GLExportOtherAccount
    
    GLExportOtherAccount Properties
    
    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 for the GLExport record
    
    Name string — Name of the GLExport record
    
    Type int — Type of the GLExportOtherAccount
  - PettyAccounts Array of GLExportPettyAccount — Contains details about GLExportPettyAccount
    
    GLExportPettyAccount Properties
    
    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 for the GLExport record
    
    Name string — Name of the GLExport record
    
    PettyAccountId int — ID of the GLExportPettyAccount
  - Promotions Array of GLExportPromotionAccount — Contains details about GLExportPromotionAccount
    
    GLExportPromotionAccount Properties
    
    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 for the GLExport record
    
    Name string — Name of the GLExport record
    
    PromotionId int — ID of the GLExportPromotionAccount
  - RevenueCenters Array of GLExportRevenueCenterAccount — Contains details about GLExportRevenueCenterAccount
    
    GLExportRevenueCenterAccount Properties
    
    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 for the GLExport record
    
    Name string — Name of the GLExport record
    
    RevenueCenterId int — ID of the GLExportRevenueCenterAccount
  - Surcharges Array of GLExportSurchargeAccount — Contains details about GLExportSurchargeAccount
    
    GLExportSurchargeAccount Properties
    
    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 for the GLExport record
    
    Name string — Name of the GLExport record
    
    SurchargeId int — ID of the GLExportSurchargeAccount
  - Taxes Array of GLExportTaxAccount — Contains details about GLExportTaxAccount
    
    GLExportTaxAccount Properties
    
    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 for the GLExport record
    
    Name string — Name of the GLExport record
    
    TaxId int — ID of the GLExportTaxAccount
  - Tenders Array of GLExportTenderAccount — Contains details about GLExportTenderAccount
    
    GLExportTenderAccount Properties
    
    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 for the GLExport record
    
    Name string — Name of the GLExport record
    
    TenderId int — ID of the GLExportTenderAccount
  - TendersForEcommerce Array of GLExportTenderAccount — Contains details about GLExportTenderAccount
    
    GLExportTenderAccount Properties
    
    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 for the GLExport record
    
    Name string — Name of the GLExport record
    
    TenderId int — ID of the GLExportTenderAccount
LocationOptions Properties
- Address1 string — Location street address line 1
- Address2 string — Location street address line 2
- City string — City of this Location
- Country string — Country of this Location
- Fax string — Location fax
- Latitude decimal — Latitude coordinate of this Location
- Longitude decimal — Longitude coordinate of this Location
- Name string — Name of this Location
- Phone string — Phone number of this Location
- State string — State of this Location
- TimeZone TimeZone — Time zone of this Location
- Zip string — Zip code of this Location
PrintingOptions Properties
- Credit CreditOptions — Contains printing controls for credit card drafts
CreditOptions Properties
- IsSuggestedTipActive bool — True if prints suggested tip calculations on the credit drafts, False if not
- SuggestedTipOne short? — Suggested tip amount 1
- SuggestedTipTwo short? — Suggested tip amount 2
- SuggestedTipThree short? — Suggested tip amount 3
OnlineOrdering Properties
- Taxes Array of OrderTax — Order taxes applied to the order.
OrderTax Properties
- Id int — Unique identifier of this tax, setup in Settings Editor against this location.
- Name string — Name of the tax which will be applied on order.
- RemittanceType OrderTaxRemittanceType — Specify one remittance type. You can choose one of the following:Third Party , Store
System Properties
- EndOfDayTime TimeSpan — Time of day when the "end of day" process is expected to run on the registers. Used to determine valid times for future orders and start time of the first day part.

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetOptions request with accessToken and locationToken in body.

Responses

text/xml; charset=utf-8

post/GetOptions

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings.svc?Settings_GetOptions' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'SOAPAction: "http://tempuri.org/ISettingsWebService/GetOptions"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:tem="http://tempuri.org/">
    <soapenv:Header/>
    <soapenv:Body>
      <tem:GetOptions>
        <tem:accessToken>AccessToken</tem:accessToken>
        <tem:locationToken>LocationToken</tem:locationToken>
      </tem:GetOptions>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetOptionsResponse xmlns="http://tempuri.org/">
      <Settings_GetOptionsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Options>
          <Accounting>
            <GLExport>
              <Discounts/>
              <Others/>
              <PettyAccounts/>
              <Promotions/>
              <RevenueCenters/>
              <Surcharges/>
              <Taxes/>
              <Tenders/>
              <TendersForEcommerce/>
            </GLExport>
          </Accounting>
          <Location>
            <Name>Downtown Location</Name>
            <Address1>123 Main Street</Address1>
            <Address2>Suite 100</Address2>
            <City>Austin</City>
            <Country>US</Country>
            <State>TX</State>
            <Zip>78701</Zip>
            <Phone>512-555-0100</Phone>
            <Fax>512-555-0101</Fax>
            <TimeZone>
              <BaseUtcOffset>-06:00:00</BaseUtcOffset>
              <DaylightName>Central Daylight Time</DaylightName>
              <DisplayName>(UTC-06:00) Central Time (US &amp; Canada)</DisplayName>
              <Id>Central Standard Time</Id>
              <StandardName>Central Standard Time</StandardName>
              <SupportsDaylightSavingTime>true</SupportsDaylightSavingTime>
            </TimeZone>
            <Latitude>30.2672</Latitude>
            <Longitude>-97.7431</Longitude>
          </Location>
          <Printing>
            <Credit>
              <IsSuggestedTipActive>true</IsSuggestedTipActive>
              <SuggestedTipOne>1.00</SuggestedTipOne>
              <SuggestedTipTwo>2.00</SuggestedTipTwo>
              <SuggestedTipThree>3.00</SuggestedTipThree>
            </Credit>
          </Printing>
          <OnlineOrdering>
            <Taxes>
              <OrderTax>
                <Id>1</Id>
                <Name>Sales Tax</Name>
                <RemittanceType>Store</RemittanceType>
              </OrderTax>
            </Taxes>
          </OnlineOrdering>
          <System>
            <EndOfDayTime>23:00:00</EndOfDayTime>
          </System>
        </Options>
      </Settings_GetOptionsResult>
    </Settings_GetOptionsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing Options data with Accounting, Location, Printing, OnlineOrdering, and System configuration.