Get taxes
post
/bi/v1/{orgIdentifier}/getTaxDimensions
Gets the taxes for a specified location.
Request
Path Parameters
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : locRequestPayload
Type:
objectRequest payload with location reference
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
include:
string
Title:
IncludeList of objects to include in response -
locRef(required):
string
Title:
Location ReferenceThe location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search CriteriaSearch criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : taxDimensions
Type:
objectThe response body contains information about the tax dimensions for the specified location
Show Source
-
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
taxes(required):
array Taxes
Title:
TaxesAn array of tax dimensions
Nested Schema : Taxes
Type:
arrayTitle:
TaxesAn array of tax dimensions
Show Source
-
Array of:
object tax
The response body contains information about the tax for the specified location.
Nested Schema : tax
Type:
objectThe response body contains information about the tax for the specified location.
Show Source
-
effFrDt(required):
string(date-time)
Title:
Effective From DateThe tax's effective from date. This object will not be present if there is no effective from date. This attribute will not be returned in the response if value is null -
effToDt(required):
string(date-time)
Title:
Effective To DateThe tax's effective to date. This object will not be present if there is no effective to date. This attribute will not be returned in the response if value is null -
mstrName:
string
Title:
Master NameMaximum Length:99The master tax name -
mstrNum:
integer
Title:
Master NumberMaximum Length:16The master tax number -
name(required):
string
Title:
NameMaximum Length:99Tax Name -
num(required):
integer
Title:
NumberMaximum Length:16Tax number -
taxRate(required):
number
Title:
Tax RateRate of the tax. This attribute will not be returned in the response if value is 0 or null -
type(required):
integer
Title:
TypeType of Tax.The following are the different tax types that could be returned:
1. Breakpoint add-on
2. Add-on percentage
3. Inclusive
4. Surcharge
5. Open
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to get the tax dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H "Authorization: Bearer" -H "Content-Type:application/json" -d {"locRef":"1234"} https://baseurl/bi/v1/orgidentifier/getTaxDimensions
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Tue, 20 Oct 2020 21:24:33 GMT Transfer-Encoding: chunked Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"locRef": "1234",
"taxes":[{
"num": 1,
"name": "City Tax",
"mstrNum":1,
"mstrName": "City Tax",
"type": 1,
"taxRate": 10.25,
"effFrDt": "2018-10-18",
"effToDt": "2019-07-29"
}]
}