1. Configuration and Content API Guide
  2. Tasks
  3. Sales
  4. Service Charges

Get Service Charges

post

/config/sim/v1/sales/getServicecharges

Gets all the Service Charge configured

Request

Supported Media Types
Body ()
A request body
Root Schema : ServiceChargeGetRequestBody
Type: object
The input Body model that needs to be given.
Show Source
  • Objects included in response
    Example: locations
  • This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.
    Example: detailed
  • If specified, limits translated strings returned
    Example: en-US, de-DE, es-MX
  • If using paging, number of results returned in this page.
    Example: 10
  • Starting resource record index
    Example: 0
  • Sorts the response by the specified field name and sort order
    Example: objectNum:asc
  • Search criteria to filter results based on field value
    Example: where equals(active,1)
Back to Top

Response

Supported Media Types

200 Response

A collection of ServiceCharge entities in an organization.
Body ()
Root Schema : ServiceChargeGetResponse
Type: object
Model for Service Charge Object
Show Source
Nested Schema : consumerDisplayname
Type: object
A group of string objects representing the name of the Service Charge in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : effGrpName
Type: object
A group of string objects representing the name of the effectivity group for the ServiceCharge in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : hierUnitName
Type: object
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : menuLevels
Type: object
An object containing the menu levels on which the ServiceCharge is active
Show Source
  • A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge on main levels
    Example: 1
  • mainLevelExt
    An object containing the descriptive list associated with the enablement or disablement of the ServiceCharge on main level
  • A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge on sub levels
    Example: 1
  • subLevelExt
    An object containing the descriptive list associated with the enablement or disablement of the ServiceCharge on sub level
Nested Schema : name
Type: object
A group of string objects representing the name of the Service Charge in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : optionsExt
Type: object
An object containing the descriptive option list
Show Source
  • A Boolean flag indicating to add the Direct Cash Tips total on the Tip Reports. The Post to Charge Tips on Tip Reports and Post to Service Charges on Tip Reports options override this option.
    Example: false
  • A Boolean flag indicating to include the amount of the service charge transaction in the Tip line item of a banquet check.
    Example: false
  • A Boolean flag indicating to post the menu item net value to the Automatic Service Charge Itemizer, reducing the Automatic Service Charge when the ServiceCharge is applied.
    Example: false
  • A Boolean flag indicating to prevent sales on checks with this service charge from posting to Gross F&B Receipts on Tip Reports. When enabled, the Post to Charge Tips Total on Tip Reports option must be disabled. This is for service charges that meet the U.S. Internal Revenue Service's definition of non-allocable receipts (as defined in the IRS Instructions for Form 8027). Deselect to allow this service charge to post to Gross F&B Receipts on the Tip Reports.
    Example: false
  • A Boolean flag indicating to create a service charge that can be paid without posting to Simphony's sales totals. This option is similar to option 7 - Non-Revenue Service Charge, except menu items can be present on the check in addition to this service charge. When enabled (1) option
    Example: false
  • A Boolean flag indicating to make the service charge an amount service charge. Deselect to make the service charge a percentage service charge.
    Example: false
  • A Boolean flag indicating to include the service charge in Cash Management tracking and reporting.
    Example: false
  • A Boolean flag indicating to share items between two or more seats or two or more checks when using Touch Edit or Touch Split.
    Example: false
  • A Boolean flag indicating to create a service charge that can be paid by credit card without posting to Simphony's sales totals (for example, a service charge that is used for Gift Certificate Sales). You can track the amount, if necessary, by a tracking group total. When enabled , (1) you must program the service charge as an amount service charge, (2) a non-revenue service charge cannot be posted to a check that contains menu items unless the service charge is a Gift Card or rental deposit or the check is a Fast Transaction, and (3) if a cashier link is required for tendering, then a cashier link is also required to post a non-revenue service charge.
    Example: false
  • A Boolean flag indicating to make the service charge an open service charge, prompting workstation operators for the amount or percentage. Deselect to use a preset amount or preset percentage for the service charge.
    Example: false
  • A Boolean flag indicating to use the service charge as a rental deposit. You can enable this option for non-revenue service charges. Unlike traditional non-revenue service charges, a check can contain more than one rental deposit service charge.
    Example: false
  • A Boolean flag indicating to post the service charge to the Direct Charged Tips total and to add it to the Total Tips. When enabled (1) deselect Do Not Post to Gross Receipts, (2) select either the Post to Charged Tips Total on Tip Reports option or the Post to Service Charges Total on Tip Reports option, but not both, and (3) Workstation operators must enter a charged tip payment using a tendering key that has the Tender/Media option Post to Charged Receipts on Tip Reports enabled.
    Example: false
  • A Boolean flag indicating to post the service charge to the Service Charges total, but not the Total Tips or the Gross F&B Receipts total. You must select either option Post to Charge Tips Total on Tip Reports or Post to Service Charges Total on Tip Reports, but not both. Deselect to post the service charge to the Gross F&B Receipts, but not the Service Charges.
    Example: false
  • A Boolean flag indicating if the Service Charge will be prorated based on the value of the active menu items. This will override the requirement for the minimum number of guest count for a memo check, if the minimum guest count requirement is met for the whole check
    Example: false
  • A Boolean flag indicating to require workstation operators to enter a Reference Entry when using the Service Charge.
    Example: false
  • A Boolean flag indicating to prevent this service charge or another service charge from being applied twice to menu items that post to the same Service Charge Itemizers. Deselect to allow multiple service charges on the same Service Charge Itemizers.
    Example: false
  • A Boolean flag indicating to increment the guest count for a transaction by one whenever the service charge is applied. This option is used for non-revenue service charges that are used as cover charges. RVC Parameters option Use Number of Seats for Guest Count overrides this option.
    Example: false
  • A Boolean flag indicating to prevent other ServiceCharges from being added to the check
    Example: false
  • A Boolean flag indicating to use the service charge for stored value transactions.
    Example: false
  • A Boolean flag indicating to print a validation chit when using the service charge
    Example: false
Nested Schema : pickupTenderOrMediaObjName
Type: object
A group of string objects representing the name of the print class for the ServiceCharge in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : printClassName
Type: object
A group of string objects representing the name of the print class for the ServiceCharge in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : reportGroupName
Type: object
A group of string objects representing the name of the report group associated with the ServiceCharge in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : svcItmzrExt
Type: object
An object containing the descriptive list associated with the condiment set associated with the menu item
Show Source
  • A Boolean flag indicating if the service charge is computable on service charge itemizer 1
    Example: false
  • A Boolean flag indicating if the service charge is computable on service charge itemizer 2
    Example: false
  • A Boolean flag indicating if the service charge is computable on service charge itemizer 3
    Example: false
  • A Boolean flag indicating if the service charge is computable on service charge itemizer 4
    Example: false
  • A Boolean flag indicating if the service charge is computable on service charge itemizer 5
    Example: false
  • A Boolean flag indicating if the service charge is computable on service charge itemizer 6
    Example: false
  • A Boolean flag indicating if the service charge is computable on service charge itemizer 7
    Example: false
  • A Boolean flag indicating if the service charge is computable on service charge itemizer 8
    Example: false
Nested Schema : svcSLUName
Type: object
A group of string objects representing the name of the SLU in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : taxClassName
Type: object
A group of string objects representing the name of the tax class to be ServiceChargeed in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : mainLevelExt
Type: object
An object containing the descriptive list associated with the enablement or disablement of the ServiceCharge on main level
Show Source
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
Nested Schema : subLevelExt
Type: object
An object containing the descriptive list associated with the enablement or disablement of the ServiceCharge on sub level
Show Source
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the ServiceCharge is available at Revenue Center Type 1
    Example: false

400 Response

400 Bad Request
Body ()
Root Schema : ErrorDetails
Type: object
Response body when the request returns an error.
Show Source

404 Response

404 Requested resource not found
Back to Top