Get tax daily totals
post
/bi/v1/{orgIdentifier}/getTaxDailyTotals
Get the tax daily totals for a specified location and business date.
Request
Path Parameters
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : requestPayload
Type:
objectRequest payload
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
busDt(required):
string(date)
Title:
Business DateThe business date associated with the cash management detail -
include:
string
Title:
IncludeMaximum Length:2000List of objects to include in response -
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search CriteriaMaximum Length:2000Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : taxDailyTotals
Type:
objectThe response body contains information about the daily totals of taxes for the specified location and business date.
Show Source
-
busDt(required):
string(date)
Title:
Business DateBusiness date -
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
revenueCenters(required):
array revenueCenters
An array of tax daily totals by revenue centers
Nested Schema : revenueCenters
Type:
arrayAn array of tax daily totals by revenue centers
Show Source
-
Array of:
object taxDailyTotalsByRVC
The response body contains daily totals of taxes at a revenue center for the specified location and business date.
Nested Schema : taxDailyTotalsByRVC
Type:
objectThe response body contains daily totals of taxes at a revenue center for the specified location and business date.
Show Source
-
nonTxblSlsTtl(required):
number
Title:
Total amount of non-taxable salesTotal amount of non-taxable sales. It is not associated to a specific tax rate, therefore it is outside of the taxes array.. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10.1
-
rvcNum(required):
integer
Title:
Revenue Center NumberMaximum Length:10Revenue Center number. This attribute will not be returned in the response if taxes is null -
taxes(required):
array taxes
An array of daily totals of taxes for a revenue center. This attribute will not be returned in the response if value is null
Nested Schema : taxes
Type:
arrayAn array of daily totals of taxes for a revenue center. This attribute will not be returned in the response if value is null
Show Source
-
Array of:
object taxDailyTotal
The response body contains tax daily totals for a revenue center for the specified location and business date.
Nested Schema : taxDailyTotal
Type:
objectThe response body contains tax daily totals for a revenue center for the specified location and business date.
Show Source
-
taxCollTtl(required):
number
Title:
Tax Collected TotalTotal value taxes that were collected for the given tax -
taxExmptSlsTtl(required):
number
Title:
Tax Exempt Sales TotalTotal value sales that were exempted from the given tax -
taxNum(required):
integer
Title:
Tax NumberMaximum Length:16Unique identifier of the tax -
txblSlsTtl(required):
number
Title:
Taxable Sales TotalTotal value sales that were taxed under the given tax
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectException 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:
objectException 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:
objectException 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:
objectException 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:
objectException 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 view all the tax daily totals for a specified location & business date 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","busDt":"2020-10-20"} https://baseurl/bi/v1/orgidentifier/getTaxDailyTotals
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",
"busDt": "2020-07-20",
"revenueCenters":[{
"rvcNum": 1372,
"nonTxblSlsTtl": 1024.42,
"taxes":[{
"taxNum": 12345,
"txblSlsTtl": 1234.56,
"taxCollTtl": 123.45
"taxExmptSlsTtl": 123.45
}]
}]
}