Get tax definitions
get
/api/v1/taxes
{basePath}/taxes?orgShortName=tfoinc&locRef=fdmnh144&rvcRef=42
Get tax configuration for a revenue center. This request provides the tax class that is referenced by menu items and the tax rates and tax types referenced by the tax classes. The tax classes will indicate which tax rates are active when that tax class is used by an item.Request
Supported Media Types
- application/json
Query Parameters
-
LocRef(required): string
The location identifier. Will be forced to lower-case.
-
OrgShortName(required): string
The organization identifier. Will be forced to lower-case.
-
RvcRef(required): string
The revenue center identifier.
Header Parameters
-
If-Modified-Since: string
If-Modified-Since HTTP header
-
If-None-Match: string
If-None-Match HTTP header
Response
Supported Media Types
- application/json
200 Response
Tax definitions
Headers
-
ETag: string
The current entity-tag for the selected representation. See RFC 7232 Section 2.3
-
Last-Modified: string
A timestamp indicating the date and time at which the origin server believes the selected representation was last modified. See RFC 7232 Section 2.2
Root Schema : TaxDefinitions
Type:
object
Tax definitions for a revenue center.
Show Source
-
OrgLocRvcProperties:
object OrgLocRvcProperties
A collection of properties for orgShortName, locRef and rvcRef
-
taxClasses:
array taxClasses
Array of tax clases.
-
taxRates:
array taxRates
Array of tax rates.
Nested Schema : OrgLocRvcProperties
Type:
object
A collection of properties for orgShortName, locRef and rvcRef
Show Source
-
locRef(required):
string
Location identifierExample:
store66
-
orgShortName(required):
string
Organization identifierExample:
mymeal
-
rvcRef(required):
integer
Revenue Center identifierExample:
2
Nested Schema : taxClasses
Type:
array
Array of tax clases.
Show Source
-
Array of:
object TaxClassItem
Tax class defines a collection of active tax rates.
Nested Schema : taxRates
Type:
array
Array of tax rates.
Show Source
-
Array of:
object TaxRateItem
Definition of a tax rate.
Nested Schema : TaxClassItem
Type:
object
Tax class defines a collection of active tax rates.
Show Source
-
activeTaxRateRefs:
array activeTaxRateRefs
Set of references to active tax rate items for this tax class.
-
taxClassId(required):
integer
Tax class identifier.
Nested Schema : activeTaxRateRefs
Type:
array
Set of references to active tax rate items for this tax class.
Show Source
Nested Schema : TaxRateItem
Type:
object
Definition of a tax rate.
Show Source
-
breakpoints:
array breakpoints
breakpoint table
-
name:
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
-
percentage:
number
Tax rate percentage.
-
repeatEndIndex:
integer
breakpoint end index
-
repeatStartIndex:
integer
breakpoint start index
-
startAmount:
number
the breakpoint start amount
-
taxRateId(required):
integer
Tax rate identifier. This is the Simphony tax rate index.
-
taxType:
string
Allowed Values:
[ "disabled", "addonBreakpoint", "addonPercent", "includedPercent", "surcharge" ]
The tax rate type. Valid values are - disabled - addonBreakpoint - addonPercent - includedPercent - surchargeExample:addonBreakpoint
Nested Schema : TranslatedString
Type:
object
Additional Properties Allowed
Show Source
A string that contains translations into multiple languages
**Example**
`{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"ar-AR":"????????"
}
304 Response
304 Not Modified
Headers
-
ETag: string
The current entity-tag for the selected representation. See RFC 7232 Section 2.3
-
Last-Modified: string
A timestamp indicating the date and time at which the origin server believes the selected representation was last modified. See RFC 7232 Section 2.2
400 Response
400 Bad Request
Root Schema : ConfigurationApiProblemDetails
Type:
object
Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807).
The content type for this response is `application/problem+json`
Show Source
-
details:
string
A human-readable explanation specific to this occurrence of the problem.Example:
The OrgShortName value is required.
-
instance:
string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.Example:
required_value_missing
-
title:
string
A short, human-readable summary of the problem type.Example:
Required value not specified.
-
type:
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
error:validation
Examples
Example Request Body
Not applicable for this endpoint.
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"orgShortName": "mymeal",
"locRef": "store66",
"rvcRef": 2,
"taxClasses": [
{
"taxClassId": 0,
"activeTaxRateRefs": [
0
]
}
],
"taxRates": [
{
"taxRateId": 0,
"percentage": 0,
"taxType": "addonBreakpoint",
"name": {
"en-US": "Coffee",
"de-DE": "Kaffee",
"ar-AR": "قهوة"
},
"repeatStartIndex": 0,
"repeatEndIndex": 0,
"startAmount": 0,
"breakpoints": [
0
]
}
]
}