Create results for all tax credits screening
post
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CandidateNumber: string
Candidate number of the candidate.
-
CandidateToken: string
Candidate token in the recruiting tax credits candidate results.
-
ClientReferenceKey: string
Client reference key for the recruiting tax credits account.
-
packages: array
Recruiting Tax Credits Package Results
Title:
Recruiting Tax Credits Package Results
The packages resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PartnerId: string
Maximum Length:
255
Partner ID for the recruiting tax credits account. -
RequisitionNumber: string
Unique number assigned to each job requisition.
Nested Schema : Recruiting Tax Credits Package Results
Type:
array
Title:
Recruiting Tax Credits Package Results
The packages resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AdditionalResultsAttributes: array
Additional Candidate Tax Credits Results
Title:
Additional Candidate Tax Credits Results
The additionalResultsAttributes resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes additional results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
Comments: string
Comments for the overall result.
-
CreditsEligibleFlag: boolean
Indicates whether the candidate is eligible for any credits.
-
CreditsEstimateCurrencyCode: string
Currency code for the tax credits estimate.
-
FederalCreditsEligibleFlag: boolean
Indicates whether the candidate is eligible for federal credits.
-
FederalCreditsEstimate: string
Specifies the federal tax credits estimate for the candidate.
-
FederalCreditsIdentifier: string
Specifies the federal tax credits identifier.
-
OtherEligibleCredits: array
Other Eligible Credits for Recruiting Tax Credits Package Results
Title:
Other Eligible Credits for Recruiting Tax Credits Package Results
The otherEligibleCredits resource is a child of the packages resource. It includes all other eligible credits the candidate has been reviewed for. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PackageCode: string
Unique code identifying the tax credits package.
-
PackageName: string
Name of the tax credits account package.
-
PackageResultId: string
Unique ID for each recruiting tax credits package result.
-
StateCreditsEligibleFlag: boolean
Indicates whether the candidate is eligible for state credits.
-
StateCreditsEstimate: string
Specifies the state tax credits estimate for the candidate.
-
StateCreditsIdentifier: string
Specifies the state tax credits identifier.
-
StatusCode: string
Result status code.
-
TotalCreditsEstimate: string
Specifies the total tax credits estimate for the candidate.
Nested Schema : Additional Candidate Tax Credits Results
Type:
array
Title:
Additional Candidate Tax Credits Results
The additionalResultsAttributes resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes additional results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Other Eligible Credits for Recruiting Tax Credits Package Results
Type:
array
Title:
Other Eligible Credits for Recruiting Tax Credits Package Results
The otherEligibleCredits resource is a child of the packages resource. It includes all other eligible credits the candidate has been reviewed for. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AttributeName: string
Attribute name of the tax credits service additional results.
-
AttributeValue: string
Maximum Length:
255
Attribute value of the tax credits service additional results.
Nested Schema : schema
Type:
Show Source
object
-
AdditionalResultId: string
Result ID for the other tax credit.
-
Comments: string
Comments for the other tax credit.
-
CreditsEligibleFlag: boolean
Maximum Length:
255
Indicates whether the candidate is eligible for the tax credit. -
CreditsEstimate: string
Maximum Length:
255
Other tax credit estimated amount. -
CreditsEstimateCurrencyCode: string
Other tax credit currency code.
-
CreditsIdentifier: string
Other tax credit identifier.
-
CreditsName: string
Other tax credit name.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : recruitingTaxCreditsCandidateResults-item-response
Type:
Show Source
object
-
CandidateNumber: string
Candidate number of the candidate.
-
CandidateToken: string
Candidate token in the recruiting tax credits candidate results.
-
ClientReferenceKey: string
Client reference key for the recruiting tax credits account.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
packages: array
Recruiting Tax Credits Package Results
Title:
Recruiting Tax Credits Package Results
The packages resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PartnerId: string
Maximum Length:
255
Partner ID for the recruiting tax credits account. -
RequisitionNumber: string
Unique number assigned to each job requisition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Recruiting Tax Credits Package Results
Type:
array
Title:
Recruiting Tax Credits Package Results
The packages resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : recruitingTaxCreditsCandidateResults-packages-item-response
Type:
Show Source
object
-
AdditionalResultsAttributes: array
Additional Candidate Tax Credits Results
Title:
Additional Candidate Tax Credits Results
The additionalResultsAttributes resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes additional results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
Comments: string
Comments for the overall result.
-
CreditsEligibleFlag: boolean
Indicates whether the candidate is eligible for any credits.
-
CreditsEstimateCurrencyCode: string
Currency code for the tax credits estimate.
-
FederalCreditsEligibleFlag: boolean
Indicates whether the candidate is eligible for federal credits.
-
FederalCreditsEstimate: string
Specifies the federal tax credits estimate for the candidate.
-
FederalCreditsIdentifier: string
Specifies the federal tax credits identifier.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OtherEligibleCredits: array
Other Eligible Credits for Recruiting Tax Credits Package Results
Title:
Other Eligible Credits for Recruiting Tax Credits Package Results
The otherEligibleCredits resource is a child of the packages resource. It includes all other eligible credits the candidate has been reviewed for. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PackageCode: string
Unique code identifying the tax credits package.
-
PackageName: string
Name of the tax credits account package.
-
PackageResultId: string
Unique ID for each recruiting tax credits package result.
-
StateCreditsEligibleFlag: boolean
Indicates whether the candidate is eligible for state credits.
-
StateCreditsEstimate: string
Specifies the state tax credits estimate for the candidate.
-
StateCreditsIdentifier: string
Specifies the state tax credits identifier.
-
StatusCode: string
Result status code.
-
TotalCreditsEstimate: string
Specifies the total tax credits estimate for the candidate.
Nested Schema : Additional Candidate Tax Credits Results
Type:
array
Title:
Additional Candidate Tax Credits Results
The additionalResultsAttributes resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes additional results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Other Eligible Credits for Recruiting Tax Credits Package Results
Type:
array
Title:
Other Eligible Credits for Recruiting Tax Credits Package Results
The otherEligibleCredits resource is a child of the packages resource. It includes all other eligible credits the candidate has been reviewed for. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingTaxCreditsCandidateResults-packages-AdditionalResultsAttributes-item-response
Type:
Show Source
object
-
AttributeName: string
Attribute name of the tax credits service additional results.
-
AttributeValue: string
Maximum Length:
255
Attribute value of the tax credits service additional results. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingTaxCreditsCandidateResults-packages-OtherEligibleCredits-item-response
Type:
Show Source
object
-
AdditionalResultId: string
Result ID for the other tax credit.
-
Comments: string
Comments for the other tax credit.
-
CreditsEligibleFlag: boolean
Maximum Length:
255
Indicates whether the candidate is eligible for the tax credit. -
CreditsEstimate: string
Maximum Length:
255
Other tax credit estimated amount. -
CreditsEstimateCurrencyCode: string
Other tax credit currency code.
-
CreditsIdentifier: string
Other tax credit identifier.
-
CreditsName: string
Other tax credit name.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- packages
-
Parameters:
- recruitingTaxCreditsCandidateResultsUniqID:
$request.path.recruitingTaxCreditsCandidateResultsUniqID
The packages resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - recruitingTaxCreditsCandidateResultsUniqID: