Get job code daily totals
post
/bi/v1/{orgIdentifier}/getJobCodeDailyTotals
Get the Job Code Daily Totals for a specified location and business date.
Request
Path Parameters
-
orgIdentifier: 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(optional):
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
busDt:
string(date)
Title:
Business DateThe business date associated with the cash management detail -
include(optional):
string
Title:
IncludeMaximum Length:2000List of objects to include in response -
locRef:
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
searchCriteria(optional):
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 : jcDailyTotals
Type:
objectThe response body contains information about the daily totals by job code for the specified location.
Show Source
-
busDt:
string(date)
Title:
Business DateBusiness Date -
locRef:
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
revenueCenters:
array revenueCenters
An array of Employee Daily Totals by Revenue Centers
Nested Schema : revenueCenters
Type:
arrayAn array of Employee Daily Totals by Revenue Centers
Show Source
-
Array of:
object jcDailyTotalsByRVC
The response body contains daily totals by job code of a revenue center for the specified location.
Nested Schema : jcDailyTotalsByRVC
Type:
objectThe response body contains daily totals by job code of a revenue center for the specified location.
Show Source
-
jobCodes:
array jobCodes
An array of daily totals by job code for a revenue center. This attribute will not be returned in the response if value is null
-
rvcNum:
integer
Title:
Revenue Center NumberMaximum Length:16Revenue Center number. This attribute will not be returned in the response if jobCodes is null
Nested Schema : jobCodes
Type:
arrayAn array of daily totals by job code for a revenue center. This attribute will not be returned in the response if value is null
Show Source
-
Array of:
object jcDailyTotal
The response body contains daily totals by job code for a revenue center for the specified location.
Nested Schema : jcDailyTotal
Type:
objectThe response body contains daily totals by job code for a revenue center for the specified location.
Show Source
-
jcNum:
integer
Title:
Job Code NumberMaximum Length:16Job Code Number -
ovt2Hrs:
number
Title:
Overtime 2 HoursNumber of overtime 2 hours. This attribute will not be returned in the response if value is 0 or null -
ovt2Pay:
number
Title:
Overtime 2 PayAmount of overtime 2 pay. This attribute will not be returned in the response if value is 0 or null -
ovt3Hrs:
number
Title:
Overtime 3 HoursNumber of overtime 3 hours. This attribute will not be returned in the response if value is 0 or null -
ovt3Pay:
number
Title:
Overtime 3 PayAmount of overtime 3 pay. This attribute will not be returned in the response if value is 0 or null -
ovt4Hrs:
number
Title:
Overtime 4 HoursNumber of overtime 4 hours. This attribute will not be returned in the response if value is 0 or null -
ovt4Pay:
number
Title:
Overtime 4 PayAmount of overtime 4 pay. This attribute will not be returned in the response if value is 0 or null -
ovtHrs:
number
Title:
Overtime HoursNumber of overtime hours. This attribute will not be returned in the response if value is 0 or null -
ovtPay:
number
Title:
Overtime PayAmount of overtime pay. This attribute will not be returned in the response if value is 0 or null -
regHrs:
number
Title:
Regular HoursMaximum Length:16Number of regular hours -
regPay:
number
Title:
Regular PayMaximum Length:16Amount of regualar Pay
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to view all the operational daily totals by Job Codes 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/getJobCodeDailyTotals
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,
"jobCodes":[{
"jcNum": 12345,
"regHrs": 123.45,
"regPay": 1234.56,
"ovtHrs": 123.45,
"ovtPay": 1234.56.
"ovt2Hrs": 123.45,
"ovt2Pay": 1234.56,
"ovt3Hrs": 123.45,
"ovt3Pay": 1234.56,
"ovt4Hrs": 123.45,
"ovt4Pay": 1234.56
}]
}]
}